Skip to content

Commit 61d5aed

Browse files
committed
edits
1 parent 64cba64 commit 61d5aed

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/reference/embedded-cluster-install.mdx

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
8181
<tr>
8282
<td>`--network-interface`</td>
8383
<td>
84-
<p>The network interface to bind to for the Kubernetes API. If a network interface is not provided, the first valid, non-local network interface is used. Use `--network-interface` for multi-node clusters where node communication should happen on a particular network.</p>
84+
<p>The name of the network interface to bind to for the Kubernetes API. A common use case of `--network-interface` is for multi-node clusters where node communication should happen on a particular network. **Default**: If a network interface is not provided, the first valid, non-local network interface is used.</p>
8585
</td>
8686
</tr>
8787
<tr>
@@ -102,8 +102,8 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
102102
<tr>
103103
<td>`--private-ca`</td>
104104
<td>
105-
<p>The name of a ConfigMap that contains the trusted certificate authority (CA) certificates used by a Man-In-The-Middle (MITM) proxy that intercepts traffic and issues its own certificates. Providing the CA certificates with `--private-ca` ensures that the private CA is trusted by the installation.</p>
106-
<p><strong>Note:</strong> 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 specified ConfigMap so your containers can access the internet through proxies that issue their own TLS certificates in order to inspect traffic.</p>
105+
<p>The path to the trusted certificate authority (CA) certificates used by a Man-In-The-Middle (MITM) proxy that intercepts traffic and issues its own certificates. Using the `--private-ca` flag ensures that the CA is trusted by the installation. KOTS writes the CA bundle provided with the `--private-ca` flag to a ConfigMap in the cluster.</p>
106+
<p><strong>Note:</strong> 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 can access the internet through proxies that issue their own TLS certificates in order to inspect traffic.</p>
107107
</td>
108108
</tr>
109109
</table>
@@ -145,12 +145,23 @@ Where:
145145

146146
```bash
147147
sudo ./APP_SLUG install --license license.yaml \
148-
--private-ca PRIVATE_CA_CONFIGMAP
148+
--private-ca /path/to/private-ca-bundle
149149
```
150-
Where `PRIVATE_CA_CONFIGMAP` is
151150

152151
### Set IP Address Range for Pods and Services
153152

154153
```bash
155154
sudo ./my-app install --license license.yaml --cidr 172.16.136.0/16
156155
```
156+
157+
### Set Admin Console Password
158+
159+
```bash
160+
sudo ./my-app install --license license.yaml --admin-console-password password
161+
```
162+
163+
### Use a Specific Network Interface
164+
165+
```bash
166+
sudo ./my-app install --license license.yaml --network-interface eno167777
167+
```

0 commit comments

Comments
 (0)