-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
444 additions
and
151 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
title: botkube install | ||
--- | ||
|
||
## botkube install | ||
|
||
install Botkube into cluster | ||
|
||
### Synopsis | ||
|
||
Use this command to install the Botkube agent. | ||
|
||
``` | ||
botkube install [OPTIONS] [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Install latest stable Botkube version | ||
botkube install | ||
# Install Botkube 0.1.0 version | ||
botkube install --version 0.1.0 | ||
# Install Botkube from local git repository. Needs to be run from the main directory. | ||
botkube install --repo @local | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--atomic If set, process rolls back changes made in case of failed install/upgrade. The --wait flag will be set automatically if --atomic is used | ||
--chart-name string Botkube Helm chart name. (default "botkube") | ||
--dependency-update Update dependencies if they are missing before installing the chart | ||
--description string add a custom description | ||
--disable-openapi-validation If set, it will not validate rendered templates against the Kubernetes OpenAPI Schema | ||
--dry-run Simulate an install | ||
--force Force resource updates through a replacement strategy | ||
-h, --help help for install | ||
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. | ||
--namespace string Botkube installation namespace. (default "botkube") | ||
--no-hooks Disable pre/post install/upgrade hooks | ||
--release-name string Botkube Helm chart release name. (default "botkube") | ||
--render-subchart-notes If set, render subchart notes along with the parent | ||
--repo string Botkube Helm chart repository location. It can be relative path to current working directory or URL. Use @stable tag to select repository which holds the stable Helm chart versions. (default "https://charts.botkube.io/") | ||
--reset-values When upgrading, reset the values to the ones built into the chart | ||
--reuse-values When upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored | ||
--set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) | ||
--set-file stringArray Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2) | ||
--set-json stringArray Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2) | ||
--set-literal stringArray Set a literal STRING value on the command line | ||
--set-string stringArray Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) | ||
--skip-crds If set, no CRDs will be installed. | ||
--timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s) | ||
-f, --values strings Specify values in a YAML file or a URL (can specify multiple) | ||
--version string Botkube version. Possible values @latest, 1.2.0, ... (default "@latest") | ||
--wait If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout (default true) | ||
--wait-for-jobs If set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout (default true) | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [botkube](botkube.md) - Botkube CLI | ||
|
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
Oops, something went wrong.