StormForge CLI

18 minute read

stormforge

Release with Confidence

Options

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
  -h, --help                    help for stormforge
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge authorize-cluster

Authorize a cluster

Synopsis

Authorize StormForge Optimize in a cluster

stormforge authorize-cluster [flags]

Options

      --client-name name   client name to use for registration
  -h, --help               help for authorize-cluster

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge check

Run a consistency check

Synopsis

Run a consistency check on StormForge Optimize components

Options

  -h, --help   help for check

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge check config

Check the configuration

Synopsis

Check the StormForge Optimize Configuration

stormforge check config [flags]

Options

  -h, --help   help for config

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge check controller

Check the controller

Synopsis

Check the Optimize controller

stormforge check controller [flags]

Options

  -h, --help   help for controller
      --wait   wait for the controller to be ready before returning

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge check experiment

Check an experiment

Synopsis

Check an experiment manifest

stormforge check experiment [flags]

Options

  -f, --filename file   file that contains the experiment to check
  -h, --help            help for experiment

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge check version

Check for the latest version number

Synopsis

Check the current version number against the latest

stormforge check version [flags]

Options

  -h, --help   help for version

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge completion

Output shell completion code

Synopsis

Output shell completion code which can be evaluated to provide interactive completion of commands.

stormforge completion SHELL [flags]

Examples

# Load the completion code for zsh into the current shell
source <(stormforge completion zsh)
# Set the completion code for zsh to autoload (assuming '$ZSH/completions' is part of 'fpath')
stormforge completion zsh > $ZSH/completions/_stormforge

Options

  -h, --help   help for completion

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge config

Work with the configuration file

Synopsis

Modify or view the StormForge Optimize Configuration file

Options

  -h, --help   help for config

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge config current-context

Displays the current context

Synopsis

Displays the current context

stormforge config current-context [flags]

Options

  -h, --help   help for current-context

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge config env

Generate environment variables from configuration

Synopsis

View the Optimize Configuration file as environment variables

stormforge config env [flags]

Options

  -h, --help      help for env
      --manager   generate the manager environment

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge config set

Modify the configuration file

Synopsis

Modify the Optimize Configuration file

stormforge config set NAME [VALUE] [flags]

Options

  -h, --help   help for set

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge config view

View the configuration file

Synopsis

View the StormForge Optimize configuration file

stormforge config view [flags]

Options

  -h, --help            help for view
      --minify          reduce information to effective values
  -o, --output format   output format. One of: yaml|json (default "yaml")
      --raw             display the raw configuration file without merging

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge delete

Delete an Optimize resource

Synopsis

Delete StormForge Optimize resources from the remote server

stormforge delete (TYPE NAME | TYPE/NAME ...) [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge export

Export trial parameters to an application or experiment

Synopsis

Export trial parameters to an application or experiment from the specified trial

stormforge export TRIAL_NAME [flags]

Options

  -f, --filename files   experiment and related manifest files to export, - for stdin
  -h, --help             help for export
  -p, --patch            export only the patch
  -t, --patched-target   export only the patched resource

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge fix

Fix manifests

stormforge fix [flags]

Options

  -f, --filename file   manifest file to fix
  -h, --help            help for fix
  -i, --in-place        overwrite input files WITHOUT BACKUPS

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate

Generate Optimize resources

Synopsis

Generate StormForge Optimize resource manifests

Options

  -h, --help   help for generate

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate application

Generate an application

Synopsis

Generate an application descriptor

stormforge generate application [flags]

Options

      --goals strings           specify the application optimization objective
  -h, --help                    help for application
      --name name               set the application name
      --no-comments             suppress documentation comments on output
      --ns-selector sel         select resources from labeled namespaces
  -r, --resources stringArray   additional resources to consider
  -l, --selector sel            select only labeled resources
      --test-case-file file     specify either a StormForger (.js) or Locust (.py) test case file

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate controller-rbac

Generate Optimize permissions

Synopsis

Generate RBAC for StormForge Optimize

stormforge generate controller-rbac [flags]

Options

      --create-trial-namespace   include trial namespace creation permissions
  -h, --help                     help for controller-rbac
      --include-manager          bind manager to matching namespaces
      --ns-selector string       bind to matching namespaces
  -o, --output format            output format; one of: json|yaml (default "yaml")
      --skip-default             skip default permissions

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate experiment

Generate an experiment

Synopsis

Generate an experiment from an application descriptor

stormforge generate experiment [flags]

Options

  -f, --filename string         file that contains the application definition
  -h, --help                    help for experiment
      --include-resources       include the application resources in the output
      --name name               override the experiment name
      --objective string        the application objective to generate an experiment for
  -r, --resources stringArray   additional resources to consider
  -s, --scenario string         the application scenario to generate an experiment for

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate install

Generate Optimize manifests

Synopsis

Generate installation manifests for StormForge Optimize

stormforge generate install [flags]

Options

      --bootstrap-role         create the bootstrap role
      --extra-permissions      generate permissions required for features like namespace creation
  -h, --help                   help for install
      --ns-selector string     create namespaced role bindings to matching namespaces
      --output-dir directory   write files to a directory instead of stdout

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate rbac

Generate experiment roles

Synopsis

Generate RBAC manifests from an experiment manifest

stormforge generate rbac [flags]

Options

      --cluster-role           generate a cluster role (default true)
      --cluster-role-binding   when generating a cluster role, also generate a cluster role binding (default true)
  -f, --filename file          file that contains the experiment to extract roles from
  -h, --help                   help for rbac
      --include-names          include resource names in the generated role
  -o, --output format          output format; one of: json|yaml (default "yaml")
      --role-name string       name of the cluster role to generate (default is to use a generated name)

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate secret

Generate Optimize authorization

Synopsis

Generate authorization secret for StormForge Optimize

stormforge generate secret [flags]

Options

      --client-name name   client name to use for registration
  -h, --help               help for secret
  -o, --output format      output format; one of: json|yaml|helm (default "yaml")

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge generate trial

Generate experiment trials

Synopsis

Generate a trial from an experiment manifest

stormforge generate trial [flags]

Options

  -A, --assign key=value       assign an explicit key=value to a parameter (default [])
      --default behavior       select the behavior for default values; one of: none|min|max|rand|base
  -f, --filename string        file that contains the experiment to generate trials for
  -h, --help                   help for trial
      --interactive            allow interactive prompts for unspecified parameter assignments
      --job string             generate the specified trial job; one of: trial|create|delete
      --job-trial-number int   explicitly set the trial number when generating jobs
  -l, --labels key=value       comma separated key=value labels to apply to the trial
  -o, --output format          output format; one of: json|yaml (default "yaml")

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge get

Display an Optimize resource

Synopsis

Get StormForge Optimize resources from the remote server

stormforge get (TYPE NAME | TYPE/NAME ...) [flags]

Options

  -A, --all                  include all resources
      --chunk-size int       fetch large lists in chunks rather then all at once (default 500)
  -h, --help                 help for get
      --no-headers           don't print headers
  -o, --output format        output format; one of: json|yaml|name|wide|csv
  -l, --selector query       selector (label query) to filter on
      --show-labels          when printing, show all labels as the last column
      --sort-by expression   sort list types using this JSONPath expression

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge grant-permissions

Grant permissions

Synopsis

Grant the StormForge Optimize Controller permissions

stormforge grant-permissions [flags]

Options

      --create-trial-namespace   include trial namespace creation permissions
  -h, --help                     help for grant-permissions
      --include-manager          bind manager to matching namespaces
      --ns-selector string       bind to matching namespaces
      --skip-default             skip default permissions

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge init

Install to a cluster

Synopsis

Install StormForge Optimize to a cluster

stormforge init [flags]

Options

      --bootstrap-role       create the bootstrap role (default true)
      --extra-permissions    generate permissions required for features like namespace creation
  -h, --help                 help for init
      --ns-selector string   create namespaced role bindings to matching namespaces
      --wait                 wait for resources to be established before returning

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge label

Label an Optimize resource

Synopsis

Label StormForge Optimize resources on the remote server

stormforge label (TYPE NAME | TYPE/NAME ...) KEY_1=VAL_1 ... KEY_N=VAL_N [flags]

Options

  -h, --help   help for label

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge login

Authenticate

Synopsis

Log into your StormForge Account.

stormforge login [flags]

Options

      --force   overwrite existing configuration
  -h, --help    help for login
      --qr      display a QR code instead of opening a browser
      --url     display the URL instead of opening a browser

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge ping

Ping the StormForge Optimize API

stormforge ping [flags]

Options

  -h, --help   help for ping

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge reset

Uninstall from a cluster

Synopsis

Uninstall StormForge Optimize from a cluster

stormforge reset [flags]

Options

  -h, --help   help for reset

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge revoke

Revoke an authorization

Synopsis

Log out of your StormForge Account.

stormforge revoke [flags]

Options

  -h, --help   help for revoke

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge run

Run an experiment

stormforge run [flags]

Options

  -h, --help   help for run

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge suggest

Suggest assignments

Synopsis

Suggest assignments for a new trial run

stormforge suggest NAME [flags]

Options

  -A, --assign key=value   assign an explicit key=value to a parameter (default [])
      --default behavior   select the behavior for default values; one of: none|min|max|rand
  -h, --help               help for suggest
      --interactive        allow interactive prompts for unspecified parameter assignments
  -l, --labels key=value   comma separated key=value labels to apply to the trial

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

stormforge version

Print the version information

Synopsis

Print the version information for StormForge Optimize components

stormforge version [flags]

Options

      --controller-image   print only the name of the controller image
      --debug              display debugging information
  -h, --help               help for version
      --setuptools-image   print only the name of the setuptools image

Options inherited from parent commands

      --context name            the name of the stormforgeconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file         path to the kubeconfig file to use for CLI requests
  -n, --namespace string        the Kubernetes namespace scope for this CLI request
      --stormforgeconfig file   path to the stormforgeconfig file to use

SEE ALSO

Last modified August 18, 2021