Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 5.09 KB

File metadata and controls

128 lines (93 loc) · 5.09 KB
Interact with deployed stacklets, which are bundles of resources and containers
required to run the product.

Each stacklet consists of init containers, app containers, sidecar containers
and additional Kubernetes resources like StatefulSets, ConfigMaps, Services and
CRDs.

Usage: stackablectl stacklet [OPTIONS] <COMMAND>

Commands:
  credentials  Display credentials for a stacklet
  list         List deployed stacklets
  help         Print this message or the help of the given subcommand(s)

Options:
  -l, --log-level <LOG_LEVEL>
          Log level this application uses

      --no-cache
          Do not cache the remote (default) demo, stack and release files

          Cached files are saved at '$XDG_CACHE_HOME/stackablectl', which is usually
          '$HOME/.cache/stackablectl' when not explicitly set.

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

File options:
  -d, --demo-file <DEMO_FILE>
          Provide one or more additional (custom) demo file(s)

          Demos are loaded in the following order: Remote (default) demo file, custom
          demo files provided via the 'STACKABLE_DEMO_FILES' environment variable, and
          lastly demo files provided via the '-d/--demo-file' argument(s). If there are
          demos with the same name, the last demo definition will be used.

          Use "stackablectl [OPTIONS] <COMMAND> -d path/to/demos1.yaml -d path/to/demos2.yaml"
          to provide multiple additional demo files.

  -s, --stack-file <STACK_FILE>
          Provide one or more additional (custom) stack file(s)

          Stacks are loaded in the following order: Remote (default) stack file, custom
          stack files provided via the 'STACKABLE_STACK_FILES' environment variable, and
          lastly demo files provided via the '-s/--stack-file' argument(s). If there are
          stacks with the same name, the last stack definition will be used.

          Use "stackablectl [OPTIONS] <COMMAND> -s path/to/stacks1.yaml -s path/to/stacks2.yaml"
          to provide multiple additional stack files.

  -r, --release-file <RELEASE_FILE>
          Provide one or more additional (custom) release file(s)

          Releases are loaded in the following order: Remote (default) release file,
          custom release files provided via the 'STACKABLE_RELEASE_FILES' environment
          variable, and lastly release files provided via the '-r/--release-file'
          argument(s). If there are releases with the same name, the last release
          definition will be used.

          Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
          to provide multiple additional release files.

  -f, --operator-values <VALUES_FILE>
          Path to a Helm values file that will be used for the installation of operators

          The file is a YAML file containing Helm values used to deploy operators.
          Operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') map
          to the Helm values for that operator. Use YAML anchors and aliases to share
          values across operators.

          Example values file:

            airflow-operator:
              tolerations: &default-tolerations
                - key: "example"
                  operator: "Exists"
                  effect: "NoSchedule"
              podAnnotations:
                example.com/team: "data-engineering"
            zookeeper-operator:
              tolerations: *default-tolerations
              podAnnotations:
                example.com/team: "platform"

          Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
          values file.

Helm repository options:
      --helm-repo-stable <URL>
          Provide a custom Helm stable repository URL

          [default: https://repo.stackable.tech/repository/helm-stable/]

      --helm-repo-test <URL>
          Provide a custom Helm test repository URL

          [default: https://repo.stackable.tech/repository/helm-test/]

      --helm-repo-dev <URL>
          Provide a custom Helm dev repository URL

          [default: https://repo.stackable.tech/repository/helm-dev/]

      --chart-source <CHART_SOURCE>
          Source the charts from either a OCI registry or from index.yaml-based repositories.

          Possible values:
          - oci:  OCI registry
          - repo: index.yaml-based repositories: resolution (dev, test, stable) is based on the version and thus will be operator-specific

          [default: oci]

Operator specific configurations:
      --listener-class-preset <LISTENER_CLASS_PRESET>
          Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

          This takes precedence over values provided via the '-f/--operator-values' flag.

          This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

          [possible values: none, stable-nodes, ephemeral-nodes]