Skip to content

Commit 46f6e93

Browse files
authored
Docs for using Secret to store custom CA (#2742)
1 parent 56c5292 commit 46f6e93

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/vendor/replicated-sdk-customizing.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,15 @@ replicated:
116116
117117
## Custom Certificate Authority
118118
119-
When installing the Replicated SDK behind a proxy server that terminates TLS and injects a custom certificate, you must provide the CA to the SDK. This can be done by storing the CA in a ConfigMap prior to installation and setting `privateCAConfigmap` key to the name of the ConfigMap.
119+
When installing the Replicated SDK behind a proxy server that terminates TLS and injects a custom certificate, you must provide the CA to the SDK. This can be done by storing the CA in a ConfigMap or a Secret prior to installation and providing appropriate values during installation.
120120
121-
To store the CA in a ConfigMap:
121+
### Using a ConfigMap
122122
123-
1. Create a ConfigMap with the name of `private-ca` and the CA as the data value:
123+
To use a CA stored in a ConfigMap:
124+
125+
1. Create a ConfigMap and the CA as the data value. Note that name of the ConfigMap and data key can be anything.
124126
```bash
125-
kubectl create configmap -n <NAMESPACE> private-ca --from-file=ca.crt=./ca.crt
127+
kubectl -n <NAMESPACE> create configmap private-ca --from-file=ca.crt=./ca.crt
126128
```
127129
1. Add the name of the config map to the values file:
128130
```yaml
@@ -134,6 +136,22 @@ To store the CA in a ConfigMap:
134136
If the `--private-ca-configmap` flag is used with the [kots install](/enterprise/installing-existing-cluster-automation) command, this value will be populated in the Replicated SDK automatically.
135137
:::
136138

139+
### Using a Secret
140+
141+
To use a CA stored in a Secret:
142+
143+
1. Create a Secret and the CA as a data value. Note that the name of the Secret and the key can be anything.
144+
```bash
145+
kubectl -n <NAMESPACE> create secret generic private-ca --from-file=ca.crt=./ca.crt
146+
```
147+
1. Add the name of the secret and the key to the values file:
148+
```yaml
149+
replicated:
150+
privateCASecret:
151+
name: private-ca
152+
key: ca.crt
153+
```
154+
137155
## Add Tolerations
138156

139157
The Replicated SDK provides a `replicated.tolerations` value that allows users to add custom tolerations to the deployment. For more information about tolerations, see [Taints and Tolerations](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/).

0 commit comments

Comments
 (0)