Reference
stormforge
Release with Confidence
Synopsis
Command line interface for the StormForge products.
Options
--sfconfig file configuration file to use
-h, --help help for stormforge
SEE ALSO
- stormforge auth - Manage authorizations
- stormforge check - Validate StormForge components
- stormforge completion - Generate the autocompletion script for the specified shell
- stormforge config - Show the CLI configuration
- stormforge create - Create a resource
- stormforge delete - Delete one or more resources
- stormforge disable - Disable a product feature
- stormforge edit - Edit a resource
- stormforge enable - Enable a product feature
- stormforge fix - Fix Kubernetes manifests
- stormforge get - Display one or more resources
- stormforge install - Install to a Kubernetes cluster
- stormforge login - Create an authorization
- stormforge logout - Revoke an authorization
- stormforge patch - Apply patches to a Kubernetes cluster
- stormforge ping - Connect to the StormForge server (also see ‘check connect’)
- stormforge rbac - Generate Kubernetes RBAC manifests
- stormforge run - Interactive Terminal UI
- stormforge uninstall - Uninstall from a Kubernetes cluster
- stormforge version - Show the version information
stormforge auth
Manage authorizations
Synopsis
Manage your StormForge authorizations.
stormforge auth
Options
-h, --help help for auth
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge auth new-token - Create a new token
- stormforge auth revoke - Revoke an authorization
stormforge auth new-token
Create a new token
Synopsis
Create a new StormForge token for use in automated workflows.
Tokens do not expire and must be revoked manually.
stormforge auth new-token [flags]
Examples
# Create an organization wide secret with a StormForge token for GitHub Actions
gh secret set --org myOrg --env-file <(stormforge auth new-token --name github-actions)
Options
--name name name to use for registration (required)
-h, --help help for auth new-token
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge auth - Manage authorizations
stormforge auth revoke
Revoke an authorization
Synopsis
Revokes a StormForge authorization.
Tokens are read, one token per line, from the specified files ("-" reads from stdin).
stormforge auth revoke FILE... [flags]
Options
-h, --help help for auth revoke
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge auth - Manage authorizations
stormforge check
Validate StormForge components
Synopsis
Validates components of the StormForge system.
stormforge check
Options
-h, --help help for check
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge check connect - Check server connections
- stormforge check experiment - Check the validity of an experiment
- stormforge check nfr - Checks a test run result for non-functional requirements
- stormforge check optimize-live - Check the StormForge Optimize Live controller
- stormforge check optimize-pro - Check the StormForge Optimize Pro controller
- stormforge check version - Check the CLI version
stormforge check connect
Check server connections
Synopsis
Test the connection to StormForge servers.
stormforge check connect api|auth|registry|app|docs|downloads|localhost ... [flags]
Options
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for check connect
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge check experiment
Check the validity of an experiment
Synopsis
Test that an experiment definition is valid.
stormforge check experiment FILE... [flags]
Options
-h, --help help for check experiment
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge check nfr
Checks a test run result for non-functional requirements
Synopsis
Checks a test run result for non-functional requirements.
Specify the test run to check with –test-run TESTRUN. TESTRUN can be either the path (e.g. “blackfriday-2022/47”) or its UID reference (e.g. “uid:654321”). The path consists of the test case name and a sequential number and may change, if the test case is renamed.
See https://docs.stormforger.com/reference/nfr/ for our reference documentation for NFR files.
stormforge check nfr --test-run TESTRUN --from-file FILE [flags]
Examples
# Check the 2nd test run of test case "blackfriday2022"
stormforge check nfr --test-run "blackfriday2022/2" --from-file ./loadtest/nfr.yaml
Options
--test-run reference reference to the test run to check (name or UID)
--from-file file file with the NFR definition
-o, --output format output format; one of: json|yaml
-h, --help help for check nfr
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge check optimize-live
Check the StormForge Optimize Live controller
Synopsis
Check the Optimize Live controller.
stormforge check optimize-live [flags]
Options
--wait wait for the controller to be ready before returning
-o, --output format output format; "go-template"
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
-h, --help help for check optimize-live
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge check optimize-pro
Check the StormForge Optimize Pro controller
Synopsis
Check the Optimize Pro v2 controller.
stormforge check optimize-pro [flags]
Options
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
--wait wait for the controller to be ready before returning
-o, --output format output format; "name"
-h, --help help for check optimize-pro
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge check version
Check the CLI version
Synopsis
Check the current CLI version.
stormforge check version [flags]
Options
-h, --help help for check version
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge check - Validate StormForge components
stormforge completion
Generate the autocompletion script for the specified shell
Synopsis
Generate the autocompletion script for stormforge for the specified shell. See each sub-command’s help for details on how to use the generated script.
Options
-h, --help help for completion
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge completion bash - Generate the autocompletion script for bash
- stormforge completion fish - Generate the autocompletion script for fish
- stormforge completion powershell - Generate the autocompletion script for powershell
- stormforge completion zsh - Generate the autocompletion script for zsh
stormforge completion bash
Generate the autocompletion script for bash
Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.
To load completions in your current shell session:
source <(stormforge completion bash)
To load completions for every new session, execute once:
Linux:
stormforge completion bash > /etc/bash_completion.d/stormforge
macOS:
stormforge completion bash > $(brew --prefix)/etc/bash_completion.d/stormforge
You will need to start a new shell for this setup to take effect.
stormforge completion bash
Options
-h, --help help for bash
--no-descriptions disable completion descriptions
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge completion - Generate the autocompletion script for the specified shell
stormforge completion fish
Generate the autocompletion script for fish
Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
stormforge completion fish | source
To load completions for every new session, execute once:
stormforge completion fish > ~/.config/fish/completions/stormforge.fish
You will need to start a new shell for this setup to take effect.
stormforge completion fish [flags]
Options
-h, --help help for fish
--no-descriptions disable completion descriptions
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge completion - Generate the autocompletion script for the specified shell
stormforge completion powershell
Generate the autocompletion script for powershell
Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
stormforge completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your powershell profile.
stormforge completion powershell [flags]
Options
-h, --help help for powershell
--no-descriptions disable completion descriptions
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge completion - Generate the autocompletion script for the specified shell
stormforge completion zsh
Generate the autocompletion script for zsh
Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(stormforge completion zsh); compdef _stormforge stormforge
To load completions for every new session, execute once:
Linux:
stormforge completion zsh > "${fpath[1]}/_stormforge"
macOS:
stormforge completion zsh > $(brew --prefix)/share/zsh/site-functions/_stormforge
You will need to start a new shell for this setup to take effect.
stormforge completion zsh [flags]
Options
-h, --help help for zsh
--no-descriptions disable completion descriptions
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge completion - Generate the autocompletion script for the specified shell
stormforge config
Show the CLI configuration
Synopsis
View StormForge CLI configuration.
The StormForge CLI loads configuration from command line flags, environment
variables, and a configuration file (in that order). The location of the file
is determined by the --sfconfig
flag or the STORMFORGE_CONFIG
environment
variable (collectively, “the sfconfig”). If the sfconfig DOES NOT contain a
file path separator (e.g. ‘config’, the default), the file is resolved relative
to the OS specific “user config” directory (’~/.config/stormforge’ on Linux).
If the sfconfig DOES contain a path separator (e.g. ‘./sfconfig’), the file is
resolved relative to current working directory.
The configuration file may contain sensitive information: for example, after logging in using ‘stormforge login’ the token used to access the StormForge API will be present in the configuration file.
stormforge config [flags]
Options
--raw display the raw configuration file
--redact redact credentials
-o, --output format output format; one of: yaml|json|go-template (default "yaml")
--template go-template template string to use for '-o go-template'
-h, --help help for config
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge create
Create a resource
Synopsis
Creates new StormForge resources.
stormforge create
Options
-h, --help help for create
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge create application - Create an application
- stormforge create cluster - Create a cluster
- stormforge create data-source - Creates or updates one or more datasources from files
- stormforge create experiment - Reference for how to create StormForge experiments
- stormforge create scenario - Create a scenario
- stormforge create test-case - Creates or updates a new test case for performance testing
- stormforge create test-run - Launches a new test run
- stormforge create trial - Create a trial
stormforge create application
Create an application
Synopsis
Creates a new StormForge application.
stormforge create application [NAME] [flags]
Options
--title name human readable name for the application
--namespace namespace select application resources from a specific namespace
--ns-selector sel select application resources from labeled namespaces
-l, --selector sel select only labeled application resources
-o, --output format output format; "name"
-h, --help help for create application
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create cluster
Create a cluster
Synopsis
Creates a new StormForge cluster.
stormforge create cluster NAME [flags]
Options
--allow-duplicate allow the use of non-unique cluster titles (not recommended)
--with-registry-credentials also create 'registry.stormforge.io' credentials
-o, --output format output format; one of: yaml|json (default "yaml")
-h, --help help for create cluster
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create data-source
Creates or updates one or more datasources from files
Synopsis
Creates or updates (upsert operation) a datasource resource that can be referenced in a performance test by uploading one or more files.
stormforge create data-source --from-file=FILE... [flags]
Options
-f, --from-file filename filename of raw or structured data file(s) to upload (specify multiple times to upload multiple files)
-r, --raw enable to upload file as raw fixture
-n, --name name name for the file fixture
-p, --name-prefix-path prefix prefix for name for the file fixture
-d, --delimiter delimiter column delimiter (defaults to ',' for structured file fixtures)
--fields fields comma seperated list of fields
--auto-field-names enable to interpret first row as headers
-o, --output format output format; one of: json|yaml
-h, --help help for create data-source
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create experiment
Reference for how to create StormForge experiments
Synopsis
StormForge experiments must be created using an installed Optimize Pro controller.
Once the Optimize Pro controller is installed in your cluster, an experiment can
be created using kubectl
and subsequently viewed using stormforge get experiment
.
stormforge create experiment [flags]
Options
-h, --help help for create experiment
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create scenario
Create a scenario
Synopsis
Creates a new StormForge scenario.
stormforge create scenario APP_NAME[/NAME] [flags]
Options
--title name human readable name for the scenario
--cluster name cluster name used for experimentation
--container-resource-selector selector selector for application resources which should have container resource optimization applied
--replica-selector selector selector for application resources which should have replica optimization applied
--goals objectives specify the application optimization objectives
--test-case name name of the StormForge Performance test case to use
--custom-use-push-gateway enables the Prometheus Push Gateway
--custom-pod-template file file containing the custom trial job pod template
--custom-initial-delay delay additional delay before starting the trial job pod
--custom-approximate-runtime time the estimated amount of time the trial should last
--custom-image name override the image name of the first container in the trial job pod
-o, --output format output format; "name"
-h, --help help for create scenario
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create test-case
Creates or updates a new test case for performance testing
Synopsis
Creates or updates (upserts) a new test case based on the provided name and javascript definition for performance testing.
Bundling
This command performs bundling on the javascript definition. See the bundling help page for more details.
Dry Run
This command supports a –dry-run= flag to perform a dry run of the create operation to validate aspects of the provided test case configuration. No changes will be committed during the dry run. The only currently supported type of dry run is ‘javascript’ (–dry-run=javascript), which will validate the syntax of the provided test case javascript file ONLY.
stormforge create test-case NAME --from-file FILE [flags]
Options
-f, --from-file file javascript file containing the test case definition
--define variable=value defines a list of variable=value while bundling the javascript definition e.g. debug=false
--dry-run type type must equal 'javascript' (--dry-run=javascript). Performs a dry run to validate javascript syntax only
--no-update causes the create option to be strict, failing if there is an existing test case with the same name or UID (insert only, not upsert)
-o, --output format output format; one of: json|yaml
-h, --help help for create test-case
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create test-run
Launches a new test run
Synopsis
Launches a new test run based on a test case.
Metadata
You can provided additional metadata about the test run like which version of the test target is deployed with the –title, –notes and –label flags.
Validate
You can create a test run in validation mode with –validate. This will ignore defined arrival phases and only launch a single user for each defined session to help debug the test case definition.
It also enables a basic check of the test run report for some common problems like did all requests succeed or did any checks fail. You can overwrite this by providing your own NFR checks with –nfr-check-file.
Bundling
This command performs bundling on the javascript definition. See the bundling help page for more details.
Metrics Export
You can automatically export some basic statistics about your test run by setting the –metrics-output flag or the PUSHGATEAWY_URL environment variable. The destination can be either a filename or a URL. This implies –watch. The basic_statistics will be written or POSTed in the Prometheus text format to the destination.
stormforge create test-run --test-case TESTCASE [flags]
Examples
# Perform a validation run
stormforge create test-run --test-case blackfriday2022 --from-file ./loadtest.mjs --validate
# Perform a load test with some metadata from your environment
# and check NFR requirements afterwards
stormforge create test-run --test-case blackfriday2022 \
--title "${CI_JOB}" --label "git.commit=$(git describe --always)" \
--nfr-check-file "./nfr.yaml"
Options
--validate runs test case in validation mode and checks report for via NFR check (implies --watch)
--from-file file file with javascript definition to update the test case to before launching
--nfr-check-file file check test result against NFR definition from file (implies --watch)
--test-case reference test case reference that should be used to launch the test run (name or UID)
--pool pool overwrites the pool / region to launch the test run in
--sizing sizing overwrites the cluster sizing to launch the test run in
--watch enables watching the test run until it finishes or the timeout is reached
--watch-timeout seconds maximum duration in seconds to wait for the test case to finish
--skip-wait skips wait() calls during test run execution, if enabled
--title title title for the test run
--notes notes notes for the test run - markdown formatting supported
--label label=value adds a label to the test run (format: label=value)
--label-file file reads labels from a file
--metrics-output destination destination for metrics export after the test run finishes (implies --watch)
--define variable=value defines a list of variable=value while bundling the javascript definition e.g. debug=false
-o, --output format output format; one of: json|yaml
-h, --help help for create test-run
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge create trial
Create a trial
Synopsis
Creates a new StormForge trial.
stormforge create trial EXP_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
-o, --output format output format; "name"
-h, --help help for create trial
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge create - Create a resource
stormforge delete
Delete one or more resources
Synopsis
Deletes StormForge resources.
stormforge delete
Options
-h, --help help for delete
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge delete applications - Delete one or more applications
- stormforge delete clusters - Delete one or more clusters
- stormforge delete data-source - Delete one or more datasources
- stormforge delete experiments - Delete one or more experiments
- stormforge delete scenarios - Delete one or more scenarios
- stormforge delete trials - Delete one or more trials
stormforge delete applications
Delete one or more applications
Synopsis
Deletes StormForge applications.
stormforge delete applications [NAME ...] [flags]
Options
--ignore-not-found treat not found errors as successful deletes
-o, --output format output format; "name"
-h, --help help for delete applications
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge delete clusters
Delete one or more clusters
Synopsis
Deletes StormForge clusters.
stormforge delete clusters [NAME ...] [flags]
Options
--ignore-not-found treat not found errors as successful deletes
-o, --output format output format; "name"
-h, --help help for delete clusters
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge delete data-source
Delete one or more datasources
Synopsis
Deletes the specified datasource resources including all versions.
REFERENCE can be either the data source name or its UID reference (e.g. “uid:123456”).
stormforge delete data-source REFERENCE [REFERENCE...] [flags]
Options
-o, --output format output format; one of: json|yaml
-h, --help help for delete data-source
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge delete experiments
Delete one or more experiments
Synopsis
Deletes StormForge experiments.
stormforge delete experiments [NAME ...] [flags]
Options
--ignore-not-found treat not found errors as successful deletes
-o, --output format output format; "name"
-h, --help help for delete experiments
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge delete scenarios
Delete one or more scenarios
Synopsis
Deletes StormForge scenarios.
stormforge delete scenarios APP_NAME | APP_NAME/NAME ... [flags]
Options
--ignore-not-found treat not found errors as successful deletes
-o, --output format output format; "name"
-h, --help help for delete scenarios
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge delete trials
Delete one or more trials
Synopsis
Deletes StormForge trials.
stormforge delete trials EXP_NAME | EXP_NAME/TRIAL_NUM ...] [flags]
Options
-o, --output format output format; "name"
-h, --help help for delete trials
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge delete - Delete one or more resources
stormforge disable
Disable a product feature
Synopsis
Disable a product feature on a StormForge resource.
stormforge disable
Options
-h, --help help for disable
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge disable application-recommendations - Disable recommendations
stormforge disable application-recommendations
Disable recommendations
Synopsis
Disable Optimize Live recommendations for an application.
stormforge disable application-recommendations APP_NAME [flags]
Options
-o, --output format output format; "name"
-h, --help help for disable application-recommendations
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge disable - Disable a product feature
stormforge edit
Edit a resource
Synopsis
Updates information on a StormForge resource.
stormforge edit
Options
-h, --help help for edit
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge edit application - Edit an application
- stormforge edit cluster - Edit a cluster
- stormforge edit experiment - Edit an experiment
- stormforge edit scenario - Edit a scenario
- stormforge edit test-case - Update test case with new javascript definition
- stormforge edit trial - Edit a trial
stormforge edit application
Edit an application
Synopsis
Updates information on a StormForge application.
stormforge edit application NAME [flags]
Options
--title name human readable name for the application
--namespace namespace select application resources from a specific namespace
--ns-selector sel select application resources from labeled namespaces
-l, --selector sel select only labeled application resources
-o, --output format output format; "name"
-h, --help help for edit application
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge edit cluster
Edit a cluster
Synopsis
Updates information on a StormForge cluster.
stormforge edit cluster NAME [flags]
Options
--title title update the title value
-o, --output format output format; "name"
-h, --help help for edit cluster
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge edit experiment
Edit an experiment
Synopsis
Updates information on a StormForge experiment.
stormforge edit experiment NAME [flags]
Options
--set-label key=value label key=value pairs to assign (default [])
-o, --output format output format; "name"
-h, --help help for edit experiment
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge edit scenario
Edit a scenario
Synopsis
Updates information on a StormForge scenario.
stormforge edit scenario APP_NAME/NAME [flags]
Options
--title name human readable name for the scenario
--cluster name cluster name used for experimentation
-o, --output format output format; "name"
-h, --help help for edit scenario
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge edit test-case
Update test case with new javascript definition
Synopsis
Updates a test case given by REFERENCE with a new javascript definition after bundling it.
REFERENCE may either be the name of a test case or the uid of a test case prefixed by ‘uid:’, i.e. uid:XXXXXXXX
Bundling
This command performs bundling on the javascript definition. See the bundling help page for more details.
stormforge edit test-case REFERENCE --from-file FILE [flags]
Options
-f, --from-file file javascript file containing the test case definition
--define variable=value defines a list of variable=value while bundling the javascript definition e.g. debug=false
-o, --output format output format; one of: json|yaml
-h, --help help for edit test-case
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge edit trial
Edit a trial
Synopsis
Updates information on a StormForge trial.
stormforge edit trial EXP_NAME/TRIAL_NUM [flags]
Options
--set-label key=value label key=value pairs to assign (default [])
-o, --output format output format; "name"
-h, --help help for edit trial
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge edit - Edit a resource
stormforge enable
Enable a product feature
Synopsis
Enable a product feature on a StormForge resource.
stormforge enable
Options
-h, --help help for enable
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge enable application-recommendations - Enable recommendations
stormforge enable application-recommendations
Enable recommendations
Synopsis
Enable Optimize Live recommendations for an application.
stormforge enable application-recommendations APP_NAME [flags]
Options
--mode mode deployment mode; one of: manual|auto|disabled
--interval time desired amount of time between deployments
--cluster name cluster name used for recommendations
--selector selector selector for application resources which should have container resource optimization applied
--tolerance resource=tolerance container resource tolerance as resource=tolerance; resource is one of: cpu|memory; tolerance is one of: low|medium|high (default [])
--max-limit resource=quantity per-container resource max limits as resource=quantity; resource is one of: cpu|memory (default [])
--min-limit resource=quantity per-container resource min limits as resource=quantity; resource is one of: cpu|memory (default [])
--max-request resource=quantity per-container resource max requests as resource=quantity; resource is one of: cpu|memory (default [])
--min-request resource=quantity per-container resource min requests as resource=quantity; resource is one of: cpu|memory (default [])
--max-target-utilization resource=quantity per-container resource max target utilization as resource=quantity; resource is one of: cpu (default [])
--min-target-utilization resource=quantity per-container resource min target utilization as resource=quantity; resource is one of: cpu (default [])
-o, --output format output format; "name"
-h, --help help for enable application-recommendations
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge enable - Enable a product feature
stormforge fix
Fix Kubernetes manifests
Synopsis
Migrate StormForge manifests to the latest version.
stormforge fix FILE... [flags]
Options
-i, --in-place overwrite input files WITHOUT BACKUPS
-h, --help help for fix
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge get
Display one or more resources
Synopsis
Formats information for StormForge resources.
stormforge get
Options
-h, --help help for get
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
- stormforge get applications - Display one or more applications
- stormforge get clusters - Display one or more clusters
- stormforge get data-sources - Lists all available data sources
- stormforge get experiments - Display one or more experiments
- stormforge get recommendations - Display one or more recommendations
- stormforge get scenarios - Display one or more scenarios
- stormforge get test-cases - Returns a test case or its javascript definition
- stormforge get test-runs - Returns a test run
- stormforge get trials - Display one or more trials
stormforge get applications
Display one or more applications
Synopsis
Formats information for StormForge applications.
stormforge get applications [NAME ...] [flags]
Options
--for product show only clusters for a specific product; one of: optimize-pro|optimize-live
--chunk-size n fetch large lists in chunks rather then all at once (default 500)
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get applications
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get clusters
Display one or more clusters
Synopsis
Formats information for StormForge clusters.
stormforge get clusters [NAME ...] [flags]
Options
--for product show only clusters for a specific product; one of: optimize-pro|optimize-live
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get clusters
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get data-sources
Lists all available data sources
Synopsis
Lists all available data sources for performance testing.
stormforge get data-sources [flags]
Options
--only filter filter for datasources (structured, raw)
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get data-sources
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get experiments
Display one or more experiments
Synopsis
Formats information for StormForge experiments.
stormforge get experiments [NAME ...] [flags]
Options
--chunk-size n fetch large lists in chunks rather then all at once (default 500)
-l, --selector query selector (label query) to filter on
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--show-labels when printing, show all labels as the last column
--template go-template template string to use for '-o go-template'
-h, --help help for get experiments
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get recommendations
Display one or more recommendations
Synopsis
Formats information for StormForge recommendations.
stormforge get recommendations APP_NAME | APP_NAME/NAME ... [flags]
Options
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get recommendations
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get scenarios
Display one or more scenarios
Synopsis
Formats information for StormForge scenarios.
stormforge get scenarios APP_NAME | APP_NAME/NAME ... [flags]
Options
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get scenarios
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get test-cases
Returns a test case or its javascript definition
Synopsis
Prints one or more test cases or their javascript definition.
stormforge get test-cases [test case identifier ...] [flags]
Options
--only filter filter for test cases (all, archived)
--javascript download JavaScript definition for specified test case
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get test-cases
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get test-runs
Returns a test run
Synopsis
Prints a list of test runs for a single test case (with –test-case) or all. Alternatively you can specify a single test run.
To print the test runs for a specific test case, you have to specify that test case with –test-case TESTCASE. TESTCASE can be either the test case name (e.g. “blackfriday-2022”) or its UID reference (e.g. “uid:123456”).
To print a single test run, pass it as an argument. This can be either the path (e.g. “blackfriday-2022/47”) or its UID reference (e.g. “uid:654321”). The path consists of the test case name and a sequential number and may change, if the test case is renamed.
Use the –only filter to only show test runs with specific conditions, e.g. archived or in-progress test-runs.
Metrics Export
You can automatically export some basic statistics about your test run by setting the –metrics-output flag or the PUSHGATEAWY_URL environment variable. The destination can be either a filename or a URL. This implies –watch. The basic_statistics will be written or POSTed in the Prometheus text format to the destination.
stormforge get test-runs [--test-case=TESTCASE | TESTRUN] [flags]
Options
--test-case reference test case reference that should be used to launch the test run (name or UID)
--only filter filter test runs to only show 'archived', 'in-progress' or 'all' test runs
--watch watches test run until it reaches a terminal state - prints progress updates
--watch-timeout seconds maximum duration in seconds to wait for the test case to finish
--metrics-output destination destination for metrics export after the test run finishes (implies --watch)
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--template go-template template string to use for '-o go-template'
-h, --help help for get test-runs
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge get trials
Display one or more trials
Synopsis
Formats information for StormForge trials.
stormforge get trials EXP_NAME | EXP_NAME/TRIAL_NUM ... [flags]
Options
-l, --selector query selector (label query) to filter on
-A, --all include all resources
--sort-by column sort using column name
-o, --output format output format; one of: json|yaml|name|wide|csv|custom-columns|go-template
--no-headers don't print headers
--show-labels when printing, show all labels as the last column
--template go-template template string to use for '-o go-template'
-h, --help help for get trials
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge get - Display one or more resources
stormforge install
Install to a Kubernetes cluster
Synopsis
Install StormForge Kubernetes components to the current cluster.
stormforge install optimize-pro|optimize-live [flags]
Options
--cluster-title name name to use for registration (default "default")
--create-namespace create the release namespace (default true)
-f, --values file specify values in a YAML file (can specify multiple)
--set key1=val1 set values on the command line (for example, key1=val1,key2=val2,...)
--set-string key1=val1 set STRING values on the command line (for example, key1=val1,key2=val2,...)
--set-file key1=path1 set values from respective files specified via the command line (for example, key1=path1,key2=path2,...)
-d, --directory dir directory where manifests are written
--wait wait for resources to be established before returning
-o, --output format output format; one of: name|yaml|json
--dry-run mode dry run mode used to apply manifests; one of: none|server|client
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
-h, --help help for install
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge login
Create an authorization
Synopsis
Log into your StormForge account.
stormforge login [server] [flags]
Examples
# Login using your workstation's default web browser.
stormforge login
# If a web browser is not locally available, or if the workstation is
# restricted from listening on port 8085, it may be necessary to perform the
# authorization from another device. Use the "--url" flag to get a URL that
# can entered into a web browser manually.
stormforge login --url
# If you are having problems logging in, try using `stormforge check connect`
# to troubleshoot any connection issues.
Options
--url display the URL instead of opening a browser
--qr display a QR code instead of opening a browser
-h, --help help for login
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge logout
Revoke an authorization
Synopsis
Log out of your StormForge Account.
stormforge logout [flags]
Options
-h, --help help for logout
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge patch
Apply patches to a Kubernetes cluster
Synopsis
Apply StormForge Optimize patches directly to a Kubernetes cluster.
stormforge patch [APP_NAME [EXP_NAME]] [flags]
Examples
# Patch resources using the latest Optimize Live recommendation
stormforge patch my-app
# Patch resources using the result of an Optimize Pro experiment stored locally in a file
stormforge patch -f experiment.yaml --trial 5
# Patch resources using the result on an Optimize Pro experiment from the cluster
# This uses `kubectl get -o yaml experiment/my-experiment` instead of reading
# the experiment definition from a local file
stormforge patch my-app my-experiment --trial 5
# Preview the full YAML output of what resources will look like after being patched
stormforge patch -f experiment.yaml --trial 5 --dry-run=client
# Save individual patches to JSON files to use with `kubectl patch --patch-file`
stormforge patch -f experiment.yaml --trial 5 --directory ./patches
Options
-d, --directory dir directory to write patches to (instead of applying them)
-f, --filename name resource names to include while constructing patches
--trial num the experiment trial number to generate patches from
--trial-selector name=value trial name=value labels to match (default [])
--recommendation name name of a specific recommendation
--dry-run mode dry run mode used to apply manifests; one of: none|server|client
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
-h, --help help for patch
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge ping
Connect to the StormForge server (also see ‘check connect’)
Synopsis
Check basic connectivity to the configured StormForge API server.
stormforge ping [flags]
Options
-h, --help help for ping
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge rbac
Generate Kubernetes RBAC manifests
Synopsis
Generate Kubernetes RBAC manifests for an Optimize Pro experiment.
stormforge rbac FILE... [flags]
Options
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
-h, --help help for rbac
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge run
Interactive Terminal UI
Synopsis
Launch an interactive interface for using StormForge products.
stormforge run [flags]
Options
-h, --help help for run
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge uninstall
Uninstall from a Kubernetes cluster
Synopsis
Uninstall StormForge Kubernetes components from the current cluster.
stormforge uninstall optimize-pro|optimize-live [flags]
Options
--dry-run mode dry run mode used to apply manifests; one of: none|server|client
--kubeconfig file path to the kubeconfig file to use for CLI requests
--context name the name of the kubeconfig context to use
-n, --namespace name if present, the namespace scope for this CLI request
-h, --help help for uninstall
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence
stormforge version
Show the version information
Synopsis
Display the full version information for the application.
stormforge version [flags]
Options
-h, --help help for version
-o, --output format output format
--template go-template template string to use for '-o go-template'
Options inherited from parent commands
--sfconfig file configuration file to use
SEE ALSO
- stormforge - Release with Confidence