-
Notifications
You must be signed in to change notification settings - Fork 880
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: commit generated docs for readthedocs.org (#2535)
* fix: commit generated docs for readthedocs.org If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same. Signed-off-by: zachaller <[email protected]> * remove already included in make codegen cmds Signed-off-by: zachaller <[email protected]> * static default value for doc generation Signed-off-by: zachaller <[email protected]> * cleanup Signed-off-by: zachaller <[email protected]> * typo Signed-off-by: zachaller <[email protected]> Signed-off-by: zachaller <[email protected]>
- Loading branch information
Showing
55 changed files
with
3,436 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # Rollouts | ||
|
|
||
| Manage argo rollouts | ||
|
|
||
| ## Synopsis | ||
|
|
||
| This command consists of multiple subcommands which can be used to manage Argo Rollouts. | ||
|
|
||
| ```shell | ||
| kubectl argo rollouts COMMAND [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| # Get guestbook rollout and watch progress | ||
| kubectl argo rollouts get rollout guestbook -w | ||
|
|
||
| # Pause the guestbook rollout | ||
| kubectl argo rollouts pause guestbook | ||
|
|
||
| # Promote the guestbook rollout | ||
| kubectl argo rollouts promote guestbook | ||
|
|
||
| # Abort the guestbook rollout | ||
| kubectl argo rollouts abort guestbook | ||
|
|
||
| # Retry the guestbook rollout | ||
| kubectl argo rollouts retry guestbook | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | ||
| --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | ||
| --as-uid string UID to impersonate for the operation. | ||
| --cache-dir string Default cache directory (default "$HOME/.kube/cache") | ||
| --certificate-authority string Path to a cert file for the certificate authority | ||
| --client-certificate string Path to a client certificate file for TLS | ||
| --client-key string Path to a client key file for TLS | ||
| --cluster string The name of the kubeconfig cluster to use | ||
| --context string The name of the kubeconfig context to use | ||
| -h, --help help for kubectl-argo-rollouts | ||
| --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | ||
| -v, --kloglevel int Log level for kubernetes client library | ||
| --kubeconfig string Path to the kubeconfig file to use for CLI requests. | ||
| --loglevel string Log level for kubectl argo rollouts (default "info") | ||
| -n, --namespace string If present, the namespace scope for this CLI request | ||
| --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | ||
| -s, --server string The address and port of the Kubernetes API server | ||
| --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | ||
| --token string Bearer token for authentication to the API server | ||
| --user string The name of the kubeconfig user to use | ||
| ``` | ||
|
|
||
| ## Available Commands | ||
|
|
||
| * [rollouts abort](kubectl-argo-rollouts_abort.md) - Abort a rollout | ||
| * [rollouts completion](kubectl-argo-rollouts_completion.md) - Generate completion script | ||
| * [rollouts create](kubectl-argo-rollouts_create.md) - Create a Rollout, Experiment, AnalysisTemplate, ClusterAnalysisTemplate, or AnalysisRun resource | ||
| * [rollouts dashboard](kubectl-argo-rollouts_dashboard.md) - Start UI dashboard | ||
| * [rollouts get](kubectl-argo-rollouts_get.md) - Get details about rollouts and experiments | ||
| * [rollouts lint](kubectl-argo-rollouts_lint.md) - Lint and validate a Rollout | ||
| * [rollouts list](kubectl-argo-rollouts_list.md) - List rollouts or experiments | ||
| * [rollouts notifications](kubectl-argo-rollouts_notifications.md) - Set of CLI commands that helps manage notifications settings | ||
| * [rollouts pause](kubectl-argo-rollouts_pause.md) - Pause a rollout | ||
| * [rollouts promote](kubectl-argo-rollouts_promote.md) - Promote a rollout | ||
| * [rollouts restart](kubectl-argo-rollouts_restart.md) - Restart the pods of a rollout | ||
| * [rollouts retry](kubectl-argo-rollouts_retry.md) - Retry a rollout or experiment | ||
| * [rollouts set](kubectl-argo-rollouts_set.md) - Update various values on resources | ||
| * [rollouts status](kubectl-argo-rollouts_status.md) - Show the status of a rollout | ||
| * [rollouts terminate](kubectl-argo-rollouts_terminate.md) - Terminate an AnalysisRun or Experiment | ||
| * [rollouts undo](kubectl-argo-rollouts_undo.md) - Undo a rollout | ||
| * [rollouts version](kubectl-argo-rollouts_version.md) - Print version | ||
|
|
55 changes: 55 additions & 0 deletions
55
docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_abort.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Rollouts Abort | ||
|
|
||
| Abort a rollout | ||
|
|
||
| ## Synopsis | ||
|
|
||
| This command stops progressing the current rollout and reverts all steps. The previous ReplicaSet will be active. | ||
|
|
||
| Note the 'spec.template' still represents the new rollout version. If the Rollout leaves the aborted state, it will try to go to the new version. | ||
| Updating the 'spec.template' back to the previous version will fully revert the rollout. | ||
|
|
||
| ```shell | ||
| kubectl argo rollouts abort ROLLOUT_NAME [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| # Abort a rollout | ||
| kubectl argo rollouts abort guestbook | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| -h, --help help for abort | ||
| ``` | ||
|
|
||
| ## Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | ||
| --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | ||
| --as-uid string UID to impersonate for the operation. | ||
| --cache-dir string Default cache directory (default "$HOME/.kube/cache") | ||
| --certificate-authority string Path to a cert file for the certificate authority | ||
| --client-certificate string Path to a client certificate file for TLS | ||
| --client-key string Path to a client key file for TLS | ||
| --cluster string The name of the kubeconfig cluster to use | ||
| --context string The name of the kubeconfig context to use | ||
| --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | ||
| -v, --kloglevel int Log level for kubernetes client library | ||
| --kubeconfig string Path to the kubeconfig file to use for CLI requests. | ||
| --loglevel string Log level for kubectl argo rollouts (default "info") | ||
| -n, --namespace string If present, the namespace scope for this CLI request | ||
| --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | ||
| -s, --server string The address and port of the Kubernetes API server | ||
| --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | ||
| --token string Bearer token for authentication to the API server | ||
| --user string The name of the kubeconfig user to use | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| * [rollouts](kubectl-argo-rollouts.md) - Manage argo rollouts |
83 changes: 83 additions & 0 deletions
83
docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_completion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Rollouts Completion | ||
|
|
||
| Generate completion script | ||
|
|
||
| ## Synopsis | ||
|
|
||
| To load completions: | ||
|
|
||
| Bash: | ||
|
|
||
| $ source <(yourprogram completion bash) | ||
|
|
||
| # To load completions for each session, execute once: | ||
| # Linux: | ||
| $ yourprogram completion bash > /etc/bash_completion.d/yourprogram | ||
| # macOS: | ||
| $ yourprogram completion bash > /usr/local/etc/bash_completion.d/yourprogram | ||
|
|
||
| Zsh: | ||
|
|
||
| # 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 for each session, execute once: | ||
| $ yourprogram completion zsh > "${fpath[1]}/_yourprogram" | ||
|
|
||
| # You will need to start a new shell for this setup to take effect. | ||
|
|
||
| fish: | ||
|
|
||
| $ yourprogram completion fish | source | ||
|
|
||
| # To load completions for each session, execute once: | ||
| $ yourprogram completion fish > ~/.config/fish/completions/yourprogram.fish | ||
|
|
||
| PowerShell: | ||
|
|
||
| PS> yourprogram completion powershell | Out-String | Invoke-Expression | ||
|
|
||
| # To load completions for every new session, run: | ||
| PS> yourprogram completion powershell > yourprogram.ps1 | ||
| # and source this file from your PowerShell profile. | ||
|
|
||
|
|
||
| ```shell | ||
| kubectl argo rollouts completion [bash|zsh|fish|powershell] | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| -h, --help help for completion | ||
| ``` | ||
|
|
||
| ## Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | ||
| --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | ||
| --as-uid string UID to impersonate for the operation. | ||
| --cache-dir string Default cache directory (default "$HOME/.kube/cache") | ||
| --certificate-authority string Path to a cert file for the certificate authority | ||
| --client-certificate string Path to a client certificate file for TLS | ||
| --client-key string Path to a client key file for TLS | ||
| --cluster string The name of the kubeconfig cluster to use | ||
| --context string The name of the kubeconfig context to use | ||
| --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | ||
| -v, --kloglevel int Log level for kubernetes client library | ||
| --kubeconfig string Path to the kubeconfig file to use for CLI requests. | ||
| --loglevel string Log level for kubectl argo rollouts (default "info") | ||
| -n, --namespace string If present, the namespace scope for this CLI request | ||
| --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | ||
| -s, --server string The address and port of the Kubernetes API server | ||
| --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | ||
| --token string Bearer token for authentication to the API server | ||
| --user string The name of the kubeconfig user to use | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| * [rollouts](kubectl-argo-rollouts.md) - Manage argo rollouts |
59 changes: 59 additions & 0 deletions
59
docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Rollouts Create | ||
|
|
||
| Create a Rollout, Experiment, AnalysisTemplate, ClusterAnalysisTemplate, or AnalysisRun resource | ||
|
|
||
| ## Synopsis | ||
|
|
||
| This command creates a new Rollout, Experiment, AnalysisTemplate, ClusterAnalysisTemplate, or AnalysisRun resource from a file. | ||
|
|
||
| ```shell | ||
| kubectl argo rollouts create [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| # Create an experiment and watch it | ||
| kubectl argo rollouts create -f my-experiment.yaml -w | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| -f, --filename stringArray Files to use to create the resource | ||
| -h, --help help for create | ||
| --no-color Do not colorize output | ||
| -w, --watch Watch live updates to the resource after creating | ||
| ``` | ||
|
|
||
| ## Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | ||
| --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | ||
| --as-uid string UID to impersonate for the operation. | ||
| --cache-dir string Default cache directory (default "$HOME/.kube/cache") | ||
| --certificate-authority string Path to a cert file for the certificate authority | ||
| --client-certificate string Path to a client certificate file for TLS | ||
| --client-key string Path to a client key file for TLS | ||
| --cluster string The name of the kubeconfig cluster to use | ||
| --context string The name of the kubeconfig context to use | ||
| --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | ||
| -v, --kloglevel int Log level for kubernetes client library | ||
| --kubeconfig string Path to the kubeconfig file to use for CLI requests. | ||
| --loglevel string Log level for kubectl argo rollouts (default "info") | ||
| -n, --namespace string If present, the namespace scope for this CLI request | ||
| --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | ||
| -s, --server string The address and port of the Kubernetes API server | ||
| --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | ||
| --token string Bearer token for authentication to the API server | ||
| --user string The name of the kubeconfig user to use | ||
| ``` | ||
|
|
||
| ## Available Commands | ||
|
|
||
| * [rollouts create analysisrun](kubectl-argo-rollouts_create_analysisrun.md) - Create an AnalysisRun from an AnalysisTemplate or a ClusterAnalysisTemplate | ||
|
|
||
| ## See Also | ||
|
|
||
| * [rollouts](kubectl-argo-rollouts.md) - Manage argo rollouts |
68 changes: 68 additions & 0 deletions
68
docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_create_analysisrun.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Rollouts Create Analysisrun | ||
|
|
||
| Create an AnalysisRun from an AnalysisTemplate or a ClusterAnalysisTemplate | ||
|
|
||
| ## Synopsis | ||
|
|
||
| This command creates a new AnalysisRun from an existing AnalysisTemplate resources or from an AnalysisTemplate file. | ||
|
|
||
| ```shell | ||
| kubectl argo rollouts create analysisrun [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ```shell | ||
| # Create an AnalysisRun from a local AnalysisTemplate file | ||
| kubectl argo rollouts create analysisrun --from-file my-analysis-template.yaml | ||
|
|
||
| # Create an AnalysisRun from a AnalysisTemplate in the cluster | ||
| kubectl argo rollouts create analysisrun --from my-analysis-template | ||
|
|
||
| # Create an AnalysisRun from a local ClusterAnalysisTemplate file | ||
| kubectl argo rollouts create analysisrun --global --from my-analysis-cluster-template.yaml | ||
|
|
||
| # Create an AnalysisRun from a ClusterAnalysisTemplate in the cluster | ||
| kubectl argo rollouts create analysisrun --global --from my-analysis-cluster-template | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| -a, --argument stringArray Arguments to the parameter template | ||
| --from string Create an AnalysisRun from an AnalysisTemplate or ClusterAnalysisTemplate in the cluster | ||
| --from-file string Create an AnalysisRun from an AnalysisTemplate or ClusterAnalysisTemplate in a local file | ||
| --generate-name string Use the specified generateName for the run | ||
| --global Use a ClusterAnalysisTemplate instead of a AnalysisTemplate | ||
| -h, --help help for analysisrun | ||
| --instance-id string Instance-ID for the AnalysisRun | ||
| --name string Use the specified name for the run | ||
| ``` | ||
|
|
||
| ## Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | ||
| --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | ||
| --as-uid string UID to impersonate for the operation. | ||
| --cache-dir string Default cache directory (default "$HOME/.kube/cache") | ||
| --certificate-authority string Path to a cert file for the certificate authority | ||
| --client-certificate string Path to a client certificate file for TLS | ||
| --client-key string Path to a client key file for TLS | ||
| --cluster string The name of the kubeconfig cluster to use | ||
| --context string The name of the kubeconfig context to use | ||
| --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | ||
| -v, --kloglevel int Log level for kubernetes client library | ||
| --kubeconfig string Path to the kubeconfig file to use for CLI requests. | ||
| --loglevel string Log level for kubectl argo rollouts (default "info") | ||
| -n, --namespace string If present, the namespace scope for this CLI request | ||
| --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | ||
| -s, --server string The address and port of the Kubernetes API server | ||
| --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | ||
| --token string Bearer token for authentication to the API server | ||
| --user string The name of the kubeconfig user to use | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| * [rollouts create](kubectl-argo-rollouts_create.md) - Create a Rollout, Experiment, AnalysisTemplate, ClusterAnalysisTemplate, or AnalysisRun resource |
Oops, something went wrong.