Skip to content

Commit bb18365

Browse files
committed
Add docs changes
1 parent 6baddb5 commit bb18365

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

deployments/helm-chart/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ Parameter | Description | Default
184184
`controller.enableCustomResources` | Enable the custom resources. | true
185185
`controller.enablePreviewPolicies` | Enable preview policies. | false
186186
`controller.enableTLSPassthrough` | Enable TLS Passthrough on port 443. Requires `controller.enableCustomResources`. | false
187+
`controller.enableCertManager` | Enable cert manager for Virtual Server resources. Requires controller.enableCustomResources. | false
187188
`controller.globalConfiguration.create` | Creates the GlobalConfiguration custom resource. Requires `controller.enableCustomResources`. | false
188189
`controller.globalConfiguration.spec` | The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller. | {}
189190
`controller.enableSnippets` | Enable custom NGINX configuration snippets in Ingress, VirtualServer, VirtualServerRoute and TransportServer resources. | false

docs/content/configuration/virtualserver-and-virtualserverroute-resources.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ redirect:
7676
| ---| ---| ---| --- |
7777
|``secret`` | The name of a secret with a TLS certificate and key. The secret must belong to the same namespace as the VirtualServer. The secret must be of the type ``kubernetes.io/tls`` and contain keys named ``tls.crt`` and ``tls.key`` that contain the certificate and private key as described [here](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls). If the secret doesn't exist or is invalid, NGINX will break any attempt to establish a TLS connection to the host of the VirtualServer. If the secret is not specified but [wildcard TLS secret](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments#cmdoption-wildcard-tls-secret) is configured, NGINX will use the wildcard secret for TLS termination. | ``string`` | No |
7878
|``redirect`` | The redirect configuration of the TLS for a VirtualServer. | [tls.redirect](#virtualservertlsredirect) | No | ### VirtualServer.TLS.Redirect |
79+
|``certmanager`` | The certmanager configuration of the TLS for a VirtualServer. | [tls.certmanager](#virtualservertlscertmanager) | No | ### VirtualServer.TLS.CertManager |
7980
{{% /table %}}
8081
8182
### VirtualServer.TLS.Redirect
@@ -95,6 +96,28 @@ basedOn: scheme
9596
|``basedOn`` | The attribute of a request that NGINX will evaluate to send a redirect. The allowed values are ``scheme`` (the scheme of the request) or ``x-forwarded-proto`` (the ``X-Forwarded-Proto`` header of the request). The default is ``scheme``. | ``string`` | No | ### VirtualServer.Policy |
9697
{{% /table %}}
9798
99+
### VirtualServer.TLS.CertManager
100+
101+
The certmanager field configures the provisioning of automated certificate resources using certmanager for a VirtualServer (Please note that ACME Issuers are not yet supported):
102+
```yaml
103+
enable: true
104+
code: 301
105+
basedOn: scheme
106+
```
107+
108+
{{% table %}}
109+
|Field | Description | Type | Required |
110+
| ---| ---| ---| --- |
111+
|``issuer`` | the name of an Issuer to acquire the certificate required for this VirtualServer. The Issuer must be in the same namespace as the VirtualServer resource. | ``string`` | No |
112+
|``cluster-issuer`` | The name of a ClusterIssuer to acquire the Certificate required for this VirtualServer. It does not matter which namespace your VirtualServer resides, as ClusterIssuers are non-namespaced resources. | ``string`` | No |
113+
|``issuer-kind`` | The kind of the external issuer resource, for example AWSPCACIssuer. This is only necessary for out-of-tree issuers. | ``string`` | No |
114+
|``issuer-group`` | The API group of the external issuer controller, for example awspca.cert-manager.io. This is only necessary for out-of-tree issuers. | ``string`` | No |
115+
|``common-name`` | This field allows you to configure spec.commonName for the Certificate to be generated. | ``string`` | No |
116+
|``duration`` | This field allows you to configure spec.duration field for the Certificate to be generated. | ``string`` | No |
117+
|``renew-before`` | this annotation allows you to configure spec.renewBefore field for the Certificate to be generated. | ``string`` | No |
118+
|``usages`` | This field allows you to configure spec.usages field for the Certificate to be generated. Pass a string with comma-separated values i.e ``key agreement,digital signature, server auth``. | ``string`` | No |
119+
{{% /table %}}
120+
98121
### VirtualServer.Policy
99122
100123
The policy field references a [Policy resource](/nginx-ingress-controller/configuration/policy-resource/) by its name and optional namespace. For example:

0 commit comments

Comments
 (0)