|
| 1 | +# Install Command Options |
| 2 | + |
| 3 | +This topic describes the options available with the Embedded Cluster install command. For more information about how to install with Embedded Cluster, see [Installing with Embedded Cluster](/enterprise/installing-embedded). |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +```bash |
| 8 | +sudo ./APP_SLUG install --license LICENSE_FILE [flags] |
| 9 | +``` |
| 10 | +* `APP_SLUG` is the unique application slug |
| 11 | +* `LICENSE_FILE` is the customer's license |
| 12 | + |
| 13 | +## Flags |
| 14 | + |
| 15 | +<table> |
| 16 | + <tr> |
| 17 | + <th width="35%">Flag</th> |
| 18 | + <th width="65%">Description</th> |
| 19 | + </tr> |
| 20 | + <tr> |
| 21 | + <td>`--data-dir`</td> |
| 22 | + <td> |
| 23 | + <p>The data directory to use to store Embedded Cluster assets. **Default**: `/var/lib/embedded-cluster`.</p> |
| 24 | + <p>Limitations:</p> |
| 25 | + <ul> |
| 26 | + <li>The data directory for Embedded Cluster cannot be changed after the cluster is installed.</li> |
| 27 | + <li>If you use the `--data-dir` flag to change the data directory during installation, then you must use the same location when restoring in a disaster recovery scenario. For more information about disaster recovery with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).</li> |
| 28 | + <li>Replicated does not support using symlinks for the Embedded Cluster data directory. Use the `--data-dir` flag instead of symlinking `/var/lib/embedded-cluster`.</li> |
| 29 | + </ul> |
| 30 | + </td> |
| 31 | + </tr> |
| 32 | + <tr> |
| 33 | + <td>`--http-proxy`</td> |
| 34 | + <td>Proxy server to use for HTTP</td> |
| 35 | + </tr> |
| 36 | + <tr> |
| 37 | + <td>`--https-proxy`</td> |
| 38 | + <td>Proxy server to use for HTTPS</td> |
| 39 | + </tr> |
| 40 | + <tr> |
| 41 | + <td>`--no-proxy`</td> |
| 42 | + <td> |
| 43 | + <p>Comma-separated list of hosts for which not to use a proxy.</p> |
| 44 | + <p>For single-node installations, pass the IP address of the node where you are installing. For multi-node installations, when deploying the first node, pass the list of IP addresses for all nodes in the cluster (typically in CIDR notation).</p> |
| 45 | + <p>The following are never proxied:</p> |
| 46 | + <ul> |
| 47 | + <li>Internal cluster communication (`localhost`, `127.0.0.1`, `.cluster.local`, `.svc`)</li> |
| 48 | + <li>The CIDRs used for assigning IPs to Kubernetes Pods and Services. By default, the Pod CIDR is `10.244.0.0/16` and the Service CIDR `10.96.0.0/12`. For information about how to change these defaults, see [Set IP Address Ranges for Pods and Services](#set-ip-address-ranges-for-pods-and-services).</li> |
| 49 | + </ul> |
| 50 | + <p>To ensure your app's internal cluster communication is not proxied, use fully qualified domain names like `my-service.my-namespace.svc` or `my-service.my-namespace.svc.cluster.local`.</p> |
| 51 | + </td> |
| 52 | + </tr> |
| 53 | + <tr> |
| 54 | + <td>`--pod-cidr`</td> |
| 55 | + <td>The range of IP addresses that can be assigned to Pods, in CIDR notation. By default, the Pod CIDR is `10.244.0.0/16`.</td> |
| 56 | + </tr> |
| 57 | + <tr> |
| 58 | + <td>`--service-cidr`</td> |
| 59 | + <td>The range of IP addresses that can be assigned to Services, in CIDR notation. By default, the Service CIDR is `10.96.0.0/12`.</td> |
| 60 | + </tr> |
| 61 | +</table> |
| 62 | + |
| 63 | +## Examples |
| 64 | + |
| 65 | +### Install Behind a Proxy |
| 66 | + |
| 67 | +```bash |
| 68 | +sudo ./APP_SLUG install --license LICENSE_FILE \ |
| 69 | + --http-proxy=HOST:PORT \ |
| 70 | + --https-proxy=HOST:PORT \ |
| 71 | + --no-proxy=LIST_OF_HOSTS |
| 72 | +``` |
| 73 | +Where: |
| 74 | + |
| 75 | +* `HOST:PORT` is the host and port of the proxy server |
| 76 | +* `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. |
| 77 | + |
| 78 | +### Change the Admin Console and LAM Ports |
| 79 | + |
| 80 | +```bash |
| 81 | +install --admin-console-port=20000 --local-artifact-mirror-port=40000 |
| 82 | +``` |
| 83 | + |
| 84 | +### Set IP Address Range for Pods |
| 85 | + |
| 86 | +```bash |
| 87 | +sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16 |
| 88 | +``` |
| 89 | + |
| 90 | +### Change the Default Data Directory |
| 91 | + |
0 commit comments