Skip to content

Commit d12fdfc

Browse files
paigecalvertajp-io
andauthored
Private CA flag deprecated (#3304)
* Private CA flag deprecated * Update docs/partials/embedded-cluster/_deprecated-private-ca.mdx Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com> * reword xref --------- Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>
1 parent c654922 commit d12fdfc

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:::note
2+
The `--private-ca` flag is deprecated. In Embedded Cluster 2.6.0 and later, it is no longer necessary to provide the path to a certificate authority (CA) with the `--private-ca` flag because Embedded Cluster automatically uses all CAs that are trusted by the host operating system. For more information about how to use these CAs in your application containers, see [PrivateCACert](/reference/template-functions-static-context#privatecacert) in _Static Context_. If you pass the `--private-ca` flag with the install command, the flag is not used and a deprecation message is displayed.
3+
:::

docs/reference/embedded-cluster-install.mdx

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import ProxyLimitations from "../partials/embedded-cluster/_proxy-install-limitations.mdx"
22
import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.mdx"
33
import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx"
4+
import DeprecatedPrivateCa from "../partials/embedded-cluster/_deprecated-private-ca.mdx"
45

56
# Embedded Cluster Install Command Options
67

@@ -126,10 +127,10 @@ sudo ./APP_SLUG install --license PATH_TO_LICENSE [flags]
126127
</td>
127128
</tr>
128129
<tr>
129-
<td>`--private-ca`</td>
130+
<td>(Deprecated) `--private-ca`</td>
130131
<td>
131-
<p>The path to trusted certificate authority (CA) certificates. Using the `--private-ca` flag ensures that the CA is trusted by the installation. KOTS writes the CA certificates provided with the `--private-ca` flag to a ConfigMap in the cluster.</p>
132-
<p>The KOTS [PrivateCACert](/reference/template-functions-static-context#privatecacert) template function returns the ConfigMap containing the private CA certificates supplied with the `--private-ca` flag. You can use this template function to mount the ConfigMap so your containers trust the CA too.</p>
132+
<DeprecatedPrivateCa/>
133+
<p>The path to trusted certificate authority (CA) certificates. In Embedded Cluster 2.4.0 and earlier, CAs provided with the `--private-ca` flag are written to a ConfigMap in the cluster that can then be accessed with the [PrivateCACert](/reference/template-functions-static-context#privatecacert) template function.</p>
133134
</td>
134135
</tr>
135136
<tr>
@@ -182,15 +183,6 @@ Where:
182183
* `HOST:PORT` is the host and port of the proxy server
183184
* `LIST_OF_HOSTS` is the list of hosts to not proxy. For example, the IP address of the node where you are installing. Or, for multi-node clusters, the list of IP addresses for all nodes in the cluster, typically in CIDR notation.
184185

185-
### Install Behind an MITM Proxy
186-
187-
```bash
188-
sudo ./my-app install --license license.yaml --private-ca /path/to/private-ca-bundle \
189-
--http-proxy=http://10.128.0.0:3300 \
190-
--https-proxy=http://10.128.0.0:3300 \
191-
--no-proxy=123.89.46.4,10.96.0.0/16,*.example.com
192-
```
193-
194186
### Set Admin Console Password
195187

196188
```bash

0 commit comments

Comments
 (0)