Project: KubeBlocks by ApeCloud (App Definition and Development / Database)
File: kbcli_addon_enable.md

title: kbcli addon enable Enable an addon. ``` kbcli addon enable ADDON_NAME [flags] ``` ``` kbcli addon enable prometheus kbcli addon enable prometheus --memory 512Mi/4Gi --storage 8Gi --replicas 2 kbcli addon enable prometheus --memory 512Mi/4Gi --storage 8Gi --replicas 2 \ --memory alertmanager:16Mi/256Mi --storage alertmanager:1Gi --replicas alertmanager:2 kbcli addon enable prometheus \ --tolerations '[{"key":"taintkey","operator":"Equal","effect":"NoSchedule","value":"true"}]' \ --tolerations 'alertmanager:[{"key":"taintkey","operator":"Equal","effect":"NoSchedule","value":"true"}]' kbcli addon enable prometheus --set prometheus.alertmanager.image.tag=v0.24.0 kbcli addon enable csi-s3 --force ``` ``` --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) --cpu stringArray Sets addon CPU resource values (--cpu [extraName:]<request>/<limit>) (can specify multiple if has extra items)) --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") --edit Edit the API resource --force ignoring the installable restrictions and forcefully enabling. -h, --help help for enable --memory stringArray Sets addon memory resource values (--memory [extraName:]<request>/<limit>) (can specify multiple if has extra items)) -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --replicas stringArray Sets addon component replica count (--replicas [extraName:]<number>) (can specify multiple if has extra items)) --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. --show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format. --storage stringArray Sets addon storage size (--storage [extraName:]<request>) (can specify multiple if has extra items)). Additional notes: Specify '0' value will remove storage values settings and explicitly disable 'persistentVolumeEnabled'

For Helm type Addon, that resizing storage will fail if modified value is a storage request size that belongs to StatefulSet's volume claim template, to resolve 'Failed' Addon status possible action is disable and re-enable the addon (More info on how-to resize a PVC: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources). --storage-class stringArray Sets addon storage class name (--storage-class [extraName:]<storage class name>) (can specify multiple if has extra items)) --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]. --tolerations stringArray Sets addon pod tolerations (--tolerations [extraName:]<toleration JSON list items>) (can specify multiple if has extra items)) ``` ``` --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 --disable-compression If true, opt-out of response compression for all requests to the server --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kubeconfig string Path to the kubeconfig file to use for CLI requests. --match-server-version Require server version to match client version -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 ``` - Addon command.