install (Beta)
This topic describes the options available with the Embedded Cluster install command. For procedural steps, see Online installation with Embedded Cluster, Air gap installation with Embedded Cluster, and Automate installation with Embedded Cluster.
Usage
sudo ./<app-slug> install --license <path-to-license> [flags]
Flags
| Flag | Type | Description |
|---|---|---|
--airgap | Perform an air-gapped installation. For more information, see Air gap installation with Embedded Cluster. | |
--api-port | int | Port for the external daemon API used by joining nodes. Default: 30081 |
--cidr | string | CIDR range for Pod and Service IP addresses. Default: 10.244.0.0/16 |
--config-values | string | Path to the ConfigValues file for headless installs. |
--data-dir | string | Data directory for Embedded Cluster. Default: /data-dir (confirm with install --help for your binary). |
--headless | Run installation without the interactive installer UI. | |
--hostname | string | Hostname to use for this node. |
--http-proxy | string | HTTP proxy URL. |
--https-proxy | string | HTTPS proxy URL. |
--ignore-app-preflights | Bypass application preflight check failures. The checks still run. Applies to headless installations only, and does not override a check that the application vendor marked as required with strict: true. See Whether users can bypass a failed check. | |
--ignore-host-preflights | Bypass Embedded Cluster host preflight check failures. The checks still run. Applies to headless installations only. See Whether users can bypass a failed check. | |
--installer-password | string | Password for the installer UI. |
--installer-port | int | Port for the installer UI. Default: 30080 |
-l, --license | string | Path to the license file. |
--network-interface | string | Network interface to use. |
--no-proxy | string | Comma-separated list of hosts that should not use the proxy. |
--registry | string | Address of a customer-managed (BYO) OCI registry to pull all application and infrastructure images from, in the form host[:port][/namespace]. For more information, see Install with a customer-managed registry. |
--registry-username | string | Username for the BYO registry specified by --registry. Optional for anonymous registries. |
--registry-password | string | Password for the BYO registry specified by --registry. Optional for anonymous registries. |
--registry-ca-cert | string | Path to a PEM-encoded CA certificate used to verify the BYO registry's TLS certificate. Only required when the registry uses a private CA that is not in the host's system trust store. |
--registry-tls-cert | string | Path to a PEM-encoded client certificate presented to the BYO registry for mTLS authentication. Use with --registry-tls-key. |
--registry-tls-key | string | Path to the PEM-encoded private key that pairs with --registry-tls-cert. |
--roles | strings | Comma-separated role names to assign to this node. Must include the controller role. Defaults to the configured controller role. For more information about defining roles, see roles in Embedded Cluster Config. |
--tls-cert | string | Path to a TLS certificate file for the installer. |
--tls-key | string | Path to a TLS private key file for the installer. |
-y, --yes | Assume yes to prompts (for example, when skipping preflights). | |
-h, --help | Help for install. |