Skip to content

Commit

Permalink
Remove custom TLS_CERTIFICATE from documentation (#596)
Browse files Browse the repository at this point in the history
Remove custom TLS_CERTIFICATE from documentation 

The UI does not support custom TLS_CERTIFICATE property.

If a partner requires a custom TLS_CERTIFICATE, they can add a
"certificate" STRING property and "privateKey" `MASKED_FIELD property
  • Loading branch information
gibbleyg authored Sep 22, 2022
1 parent f7f30c7 commit 13c4d4a
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions docs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -700,8 +700,7 @@ deployer and template can use this signal to adapt the deployment accordingly.

#### type: TLS_CERTIFICATE

This property provides an SSL/TLS certificate for the Kubernetes manifest. By
default, a self-signed certificate is generated.
This property provides a generated self-signed SSL/TLS certificate for the Kubernetes manifest.

The example below shows the syntax used to declare a certificate:

Expand All @@ -722,16 +721,6 @@ where:
* `base64EncodedPrivateKey` indicates the property that gets the private key.
* `base64EncodedCertificate` indicates the property that gets the certificate.

You can provide a custom certificate by overwriting the `certificate` property
in the following JSON format:

```json
{
"private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----",
"certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}
```

If you're using a Helm chart, you can handle the certificate like this:

```yaml
Expand Down

0 comments on commit 13c4d4a

Please sign in to comment.