github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli_addon_enable.md (about) 1 --- 2 title: kbcli addon enable 3 --- 4 5 Enable an addon. 6 7 ``` 8 kbcli addon enable ADDON_NAME [flags] 9 ``` 10 11 ### Examples 12 13 ``` 14 # Enabled "prometheus" addon 15 kbcli addon enable prometheus 16 17 # Enabled "prometheus" addon with custom resources settings 18 kbcli addon enable prometheus --memory 512Mi/4Gi --storage 8Gi --replicas 2 19 20 # Enabled "prometheus" addon and its extra alertmanager component with custom resources settings 21 kbcli addon enable prometheus --memory 512Mi/4Gi --storage 8Gi --replicas 2 \ 22 --memory alertmanager:16Mi/256Mi --storage alertmanager:1Gi --replicas alertmanager:2 23 24 # Enabled "prometheus" addon with tolerations 25 kbcli addon enable prometheus \ 26 --tolerations '[{"key":"taintkey","operator":"Equal","effect":"NoSchedule","value":"true"}]' \ 27 --tolerations 'alertmanager:[{"key":"taintkey","operator":"Equal","effect":"NoSchedule","value":"true"}]' 28 29 # Enabled "prometheus" addon with helm like custom settings 30 kbcli addon enable prometheus --set prometheus.alertmanager.image.tag=v0.24.0 31 32 # Force enabled "csi-s3" addon 33 kbcli addon enable csi-s3 --force 34 ``` 35 36 ### Options 37 38 ``` 39 --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) 40 --cpu stringArray Sets addon CPU resource values (--cpu [extraName:]<request>/<limit>) (can specify multiple if has extra items)) 41 --dry-run string[="unchanged"] Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. (default "none") 42 --edit Edit the API resource 43 --force ignoring the installable restrictions and forcefully enabling. 44 -h, --help help for enable 45 --memory stringArray Sets addon memory resource values (--memory [extraName:]<request>/<limit>) (can specify multiple if has extra items)) 46 -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). 47 --replicas stringArray Sets addon component replica count (--replicas [extraName:]<number>) (can specify multiple if has extra items)) 48 --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2), it's only being processed if addon's type is helm. 49 --show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format. 50 --storage stringArray Sets addon storage size (--storage [extraName:]<request>) (can specify multiple if has extra items)). 51 Additional notes: 52 1. Specify '0' value will remove storage values settings and explicitly disable 'persistentVolumeEnabled' attribute. 53 2. For Helm type Addon, that resizing storage will fail if modified value is a storage request size 54 that belongs to StatefulSet's volume claim template, to resolve 'Failed' Addon status possible action is disable and 55 re-enable the addon (More info on how-to resize a PVC: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources). 56 57 --storage-class stringArray Sets addon storage class name (--storage-class [extraName:]<storage class name>) (can specify multiple if has extra items)) 58 --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 59 --tolerations stringArray Sets addon pod tolerations (--tolerations [extraName:]<toleration JSON list items>) (can specify multiple if has extra items)) 60 ``` 61 62 ### Options inherited from parent commands 63 64 ``` 65 --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. 66 --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. 67 --as-uid string UID to impersonate for the operation. 68 --cache-dir string Default cache directory (default "$HOME/.kube/cache") 69 --certificate-authority string Path to a cert file for the certificate authority 70 --client-certificate string Path to a client certificate file for TLS 71 --client-key string Path to a client key file for TLS 72 --cluster string The name of the kubeconfig cluster to use 73 --context string The name of the kubeconfig context to use 74 --disable-compression If true, opt-out of response compression for all requests to the server 75 --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure 76 --kubeconfig string Path to the kubeconfig file to use for CLI requests. 77 --match-server-version Require server version to match client version 78 -n, --namespace string If present, the namespace scope for this CLI request 79 --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") 80 -s, --server string The address and port of the Kubernetes API server 81 --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 82 --token string Bearer token for authentication to the API server 83 --user string The name of the kubeconfig user to use 84 ``` 85 86 ### SEE ALSO 87 88 * [kbcli addon](kbcli_addon.md) - Addon command. 89 90 #### Go Back to [CLI Overview](cli.md) Homepage. 91