Skip to content

Commit e3ec824

Browse files
author
Ivan De Marino
committed
Regenerate documentation
1 parent 5d7a4c3 commit e3ec824

File tree

5 files changed

+87
-2
lines changed

5 files changed

+87
-2
lines changed

docs/data-sources/certificate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ page_title: "tls_certificate Data Source - terraform-provider-tls"
33
subcategory: ""
44
description: |-
55
Get information about the TLS certificates securing a host.
6-
Use this data source to get information, such as SHA1 fingerprint or serial number, about the TLS certificates that protects an HTTPS website.
6+
Use this data source to get information, such as SHA1 fingerprint or serial number, about the TLS certificates that protects a URL.
77
---
88

99
# tls_certificate (Data Source)
1010

1111
Get information about the TLS certificates securing a host.
1212

13-
Use this data source to get information, such as SHA1 fingerprint or serial number, about the TLS certificates that protects an HTTPS website.
13+
Use this data source to get information, such as SHA1 fingerprint or serial number, about the TLS certificates that protects a URL.
1414

1515
## Example Usage
1616

docs/index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,57 @@ resource "aws_iam_server_certificate" "example" {
7070
}
7171
```
7272

73+
### Configuring Proxy
74+
75+
```terraform
76+
# This example fetches the TLS certificate chain
77+
# from `example.com` using an HTTP Proxy.
78+
79+
provider "tls" {
80+
proxy {
81+
url = "https://corporate.proxy.service"
82+
}
83+
}
84+
85+
data "tls_certificate" "test" {
86+
url = "https://example.com"
87+
}
88+
```
89+
90+
```terraform
91+
# This example fetches the TLS certificate chain
92+
# from `example.com` using an HTTP Proxy.
93+
# The Proxy is discovered via environment variables:
94+
# see https://pkg.go.dev/net/http#ProxyFromEnvironment for details.
95+
96+
provider "tls" {
97+
proxy {
98+
from_env = true
99+
}
100+
}
101+
102+
data "tls_certificate" "test" {
103+
url = "https://example.com"
104+
}
105+
```
106+
107+
<!-- schema generated by tfplugindocs -->
108+
## Schema
109+
110+
### Optional
111+
112+
- `proxy` (Block List, Max: 1) Proxy used by resources and data sources that connect to external endpoints. (see [below for nested schema](#nestedblock--proxy))
113+
114+
<a id="nestedblock--proxy"></a>
115+
### Nested Schema for `proxy`
116+
117+
Optional:
118+
119+
- `from_env` (Boolean) When `true` the provider will discover the proxy configuration from environment variables. This is based upon [`http.ProxyFromEnvironment`](https://pkg.go.dev/net/http#ProxyFromEnvironment) and it supports the same environment variables (default: `true`).
120+
- `password` (String, Sensitive) Password used for Basic authentication against the Proxy.
121+
- `url` (String) URL used to connect to the Proxy. Accepted schemes are: `http`, `https`, `socks5`.
122+
- `username` (String) Username (or Token) used for Basic authentication against the Proxy.
123+
73124
## Limitations
74125

75126
### `ECDSA` with `P224` elliptic curve
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# This example fetches the TLS certificate chain
2+
# from `example.com` using an HTTP Proxy.
3+
4+
provider "tls" {
5+
proxy {
6+
url = "https://corporate.proxy.service"
7+
}
8+
}
9+
10+
data "tls_certificate" "test" {
11+
url = "https://example.com"
12+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# This example fetches the TLS certificate chain
2+
# from `example.com` using an HTTP Proxy.
3+
# The Proxy is discovered via environment variables:
4+
# see https://pkg.go.dev/net/http#ProxyFromEnvironment for details.
5+
6+
provider "tls" {
7+
proxy {
8+
from_env = true
9+
}
10+
}
11+
12+
data "tls_certificate" "test" {
13+
url = "https://example.com"
14+
}

templates/index.md.tmpl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ Use the navigation to the left to read about the available resources.
2626

2727
{{ tffile "examples/provider/provider.tf" }}
2828

29+
### Configuring Proxy
30+
31+
{{ tffile "examples/provider/provider_with_proxy.tf" }}
32+
33+
{{ tffile "examples/provider/provider_with_proxy_from_env.tf" }}
34+
35+
{{ .SchemaMarkdown | trimspace }}
36+
2937
## Limitations
3038

3139
### `ECDSA` with `P224` elliptic curve

0 commit comments

Comments
 (0)