StormForge CLI

redskyctl

Kubernetes Exploration

Options

      --context name        the name of the redskyconfig context to use, NOT THE KUBE CONTEXT
  -h, --help                help for redskyctl
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl authorize-cluster

Authorize a cluster

Synopsis

Authorize Red Sky Ops in a cluster

redskyctl authorize-cluster [flags]

Options

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

Options inherited from parent commands

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

SEE ALSO

redskyctl check

Run a consistency check

Synopsis

Run a consistency check on Red Sky Ops components

Options

  -h, --help   help for check

Options inherited from parent commands

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

SEE ALSO

redskyctl check config

Check the configuration

Synopsis

Check the Red Sky Configuration

redskyctl check config [flags]

Options

  -h, --help   help for config

Options inherited from parent commands

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

SEE ALSO

redskyctl check controller

Check the controller

Synopsis

Check the Red Sky controller

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl check experiment

Check an experiment

Synopsis

Check an experiment manifest

redskyctl check experiment [flags]

Options

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

Options inherited from parent commands

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

SEE ALSO

redskyctl check version

Check for the latest version number

Synopsis

Check the current version number against the latest

redskyctl check version [flags]

Options

  -h, --help   help for version

Options inherited from parent commands

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

SEE ALSO

redskyctl completion

Output shell completion code

Synopsis

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

redskyctl completion SHELL [flags]

Examples

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

Options

  -h, --help   help for completion

Options inherited from parent commands

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

SEE ALSO

redskyctl config

Work with the configuration file

Synopsis

Modify or view the Red Sky Configuration file

Options

  -h, --help   help for config

Options inherited from parent commands

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

SEE ALSO

redskyctl config current-context

Displays the current context

Synopsis

Displays the current context

redskyctl config current-context [flags]

Options

  -h, --help   help for current-context

Options inherited from parent commands

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

SEE ALSO

redskyctl config env

Generate environment variables from configuration

Synopsis

View the Red Sky Configuration file as environment variables

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl config set

Modify the configuration file

Synopsis

Modify the Red Sky Configuration file

redskyctl config set NAME [VALUE] [flags]

Options

  -h, --help   help for set

Options inherited from parent commands

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

SEE ALSO

redskyctl config view

View the configuration file

Synopsis

View the Red Sky Ops configuration file

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl delete

Delete a Red Sky resource

Synopsis

Delete Red Sky resources from the remote server

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

Options

  -h, --help   help for delete

Options inherited from parent commands

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

SEE ALSO

redskyctl generate

Generate Red Sky Ops objects

Synopsis

Generate Red Sky Ops object manifests

Options

  -h, --help   help for generate

Options inherited from parent commands

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

SEE ALSO

redskyctl generate controller-rbac

Generate Red Sky Ops permissions

Synopsis

Generate RBAC for Red Sky Ops

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl generate install

Generate Red Sky Ops manifests

Synopsis

Generate installation manifests for Red Sky Ops

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl generate rbac

Generate experiment roles

Synopsis

Generate RBAC manifests from an experiment manifest

redskyctl 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 string        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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl generate secret

Generate Red Sky Ops authorization

Synopsis

Generate authorization secret for Red Sky Ops

redskyctl generate secret [flags]

Options

      --client-name string   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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl generate trial

Generate experiment trials

Synopsis

Generate a trial from an experiment manifest

redskyctl generate trial [flags]

Options

  -A, --assign stringToString   assign an explicit value to a parameter (default [])
      --default string          select the behavior for default values; one of: none|min|max|rand
  -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
  -l, --labels string           comma separated 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl get

Display a Red Sky resource

Synopsis

Get Red Sky resources from the remote server

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl grant-permissions

Grant permissions

Synopsis

Grant the Red Sky Controller permissions

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl init

Install to a cluster

Synopsis

Install Red Sky Ops to a cluster

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl kustomize

Kustomize integrations

Synopsis

Kustomize integrations for Red Sky Ops

Options

  -h, --help   help for kustomize

Options inherited from parent commands

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

SEE ALSO

redskyctl kustomize config

Configure Kustomize transformers

Synopsis

Configure Kustomize transformers for Red Sky types

redskyctl kustomize config [flags]

Options

  -f, --filename file    file to write the configuration to (relative to the Kustomize root, if specified)
  -h, --help             help for config
  -k, --kustomize root   Kustomize root to update

Options inherited from parent commands

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

SEE ALSO

redskyctl label

Label a Red Sky resource

Synopsis

Label Red Sky resources on the remote server

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl login

Authenticate

Synopsis

Log into your Red Sky Account.

redskyctl login [flags]

Options

      --force         overwrite existing configuration
  -h, --help          help for login
      --name string   name of the server configuration to authorize
      --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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO

redskyctl ping

Ping the Red Sky API

redskyctl ping [flags]

Options

  -h, --help   help for ping

Options inherited from parent commands

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

SEE ALSO

redskyctl reset

Uninstall from a cluster

Synopsis

Uninstall Red Sky Ops from a cluster

redskyctl reset [flags]

Options

  -h, --help   help for reset

Options inherited from parent commands

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

SEE ALSO

redskyctl results

Serve a visualization of the results

redskyctl results [flags]

Options

      --address string   address to listen on
  -h, --help             help for results
      --url              display the URL instead of opening a browser

Options inherited from parent commands

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

SEE ALSO

redskyctl revoke

Revoke an authorization

Synopsis

Log out of your Red Sky Account.

redskyctl revoke [flags]

Options

  -h, --help          help for revoke
      --name string   name of the server configuration to de-authorize

Options inherited from parent commands

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

SEE ALSO

redskyctl suggest

Suggest assignments

Synopsis

Suggest assignments for a new trial run

redskyctl suggest NAME [flags]

Options

  -A, --assign stringToString   assign an explicit value to a parameter (default [])
      --default string          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 string           comma separated labels to apply to the trial

Options inherited from parent commands

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

SEE ALSO

redskyctl version

Print the version information

Synopsis

Print the version information for Red Sky Ops components

redskyctl 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 redskyconfig context to use, NOT THE KUBE CONTEXT
      --kubeconfig file     path to the kubeconfig file to use for CLI requests
  -n, --namespace string    if present, the namespace scope for this CLI request
      --redskyconfig file   path to the redskyconfig file to use

SEE ALSO


Last modified November 16, 2020: fix: Fix output paths for generation script (6e3352d)