compartment install

This page is generated from the current shipped compartment help output.

Related guides:

• Install Compartment
• Install Modes
• Install Domain
• System Operations
• Operate a Managed VM

Help Output

Usage: compartment install [options]

Options:
  --dev                          Install against the local repo dev API
  --api-url <url>                Public Console URL for the Kubernetes
                                 installation
  --base-domain <domain>         Base domain configured for the Kubernetes
                                 installation
  --managed-domain               Allocate a managed installation domain (default
                                 when --base-domain is omitted)
  --tls-issuer <kind/name>       cert-manager Issuer or ClusterIssuer for public
                                 wildcard TLS
  --registry-issuer <kind/name>  cert-manager CA Issuer or ClusterIssuer for
                                 private registry TLS
  --broker-url <url>             Managed-domain broker URL
  --values <path>                Operator values file for the Compartment Helm
                                 chart
  --chart <path>                 Compartment Helm chart path for a source CLI
                                 build
  --kube-context <name>          Kubernetes context for Helm
  --namespace <name>             Kubernetes namespace; defaults to compartment
  --release-name <name>          Helm release name; defaults to compartment
  --email <email>                First admin email
  --admin-password <password>    First admin password (automation only)
  --admin-password-file <path>   Read the first admin password from a protected
                                 file
  --organization <name>          First organization name
  --organization-slug <slug>
  --remote <name>                Remote name for the saved CLI session
  --output <format>              text or json (default: "text")
  --target <target>              Installation target: vm or kubernetes
  --check                        Run read-only target preflight without making
                                 changes
  --yes                          Accept the rendered mutation review
  --ingress-class <name>         IngressClass used for public Compartment hosts
  --storage-class <name>         StorageClass used for persistent platform data
  --ingress-endpoint <address>   Explicit ingress address when status is not
                                 published
  -h, --help                     display help for command