Back to Yugabyte Db

Yba Provider Kubernetes Update

managed/yba-cli/docs/yba_provider_kubernetes_update.md

2026.1.0.0-b296.8 KB
Original Source

yba provider kubernetes update

Update a Kubernetes YugabyteDB Anywhere provider

Synopsis

Update a Kubernetes provider in YugabyteDB Anywhere

yba provider kubernetes update [flags]

Examples

yba provider kuberenetes update --name <provider-name> \
	--image-registry <image-registry>

Options

      --new-name string             [Optional] Updating provider name.
      --type string                 [Optional] Updating kubernetes cloud type. Allowed values: aks, eks, gke, custom.
      --image-registry string       [Optional] Updating kubernetes Image Registry.
      --pull-secret-file string     [Optional] Updating kuberenetes Pull Secret File Path.
      --kubeconfig-file string      [Optional] Updating kuberenetes Config File Path.
      --storage-class string        [Optional] Updating kubernetes Storage Class.
      --add-region stringArray      [Optional] Add region associated with the Kubernetes provider. Provide the following double colon (::) separated fields as key-value pairs: "region-name=<region-name>::config-file-path=<path-for-the-kubernetes-region-config-file>::storage-class=<storage-class>::cert-manager-cluster-issuer=<cert-manager-cluster-issuer>::cert-manager-issuer=<cert-manager-issuer>::domain=<domain>::namespace=<namespace>::pod-address-template=<pod-address-template>::overrides-file-path=<path-for-file-contanining-overrides>". Region name is a required key-value. Config File Path, Storage Class, Cert Manager Cluster Issuer, Cert Manager Issuer, Domain, Namespace, Pod Address Template and Overrides File Path are optional. Each region needs to be added using a separate --add-region flag.
      --add-zone stringArray        [Optional] Add zone associated to the Kubernetes Region defined. Provide the following double colon (::) separated fields as key-value pairs: "zone-name=<zone-name>::region-name=<region-name>::config-file-path=<path-for-the-kubernetes-region-config-file>::storage-class=<storage-class>::cert-manager-cluster-issuer=<cert-manager-cluster-issuer>::cert-manager-issuer=<cert-manager-issuer>::domain=<domain>::namespace=<namespace>::pod-address-template=<pod-address-template>::overrides-file-path=<path-for-file-contanining-overrides>". Zone name and Region name are required values.  Config File Path, Storage Class, Cert Manager Cluster Issuer, Cert Manager Issuer, Domain, Namespace, Pod Address Template and Overrides File Path are optional. Each --add-region definition must have atleast one corresponding --add-zone definition. Multiple --add-zone definitions can be provided per region.Each zone needs to be added using a separate --add-zone flag.
      --edit-region stringArray     [Optional] Edit region associated with the Kubernetes provider. Provide the following double colon (::) separated fields as key-value pairs: "region-name=<region-name>::config-file-path=<path-for-the-kubernetes-region-config-file>::storage-class=<storage-class>::cert-manager-cluster-issuer=<cert-manager-cluster-issuer>::cert-manager-issuer=<cert-manager-issuer>::domain=<domain>::namespace=<namespace>::pod-address-template=<pod-address-template>::overrides-file-path=<path-for-file-contanining-overrides>". Region name is a required key-value. Config File Path, Storage Class, Cert Manager Cluster Issuer, Cert Manager Issuer, Domain, Namespace, Pod Address Template and Overrides File Path are optional. Each region needs to be edited using a separate --edit-region flag.
      --edit-zone stringArray       [Optional] Edit zone associated to the Kubernetes Region defined. Provide the following double colon (::) separated fields as key-value pairs: "zone-name=<zone-name>::region-name=<region-name>::config-file-path=<path-for-the-kubernetes-region-config-file>::storage-class=<storage-class>::cert-manager-cluster-issuer=<cert-manager-cluster-issuer>::cert-manager-issuer=<cert-manager-issuer>::domain=<domain>::namespace=<namespace>::pod-address-template=<pod-address-template>::overrides-file-path=<path-for-file-contanining-overrides>". Zone name and Region name are required values. Config File Path, Storage Class, Cert Manager Cluster Issuer, Cert Manager Issuer, Domain, Namespace, Pod Address Template and Overrides File Path are optional. Each zone needs to be modified using a separate --edit-zone flag.
      --remove-region stringArray   [Optional] Region name to be removed from the provider. Each region to be removed needs to be provided using a separate --remove-region definition. Removing a region removes the corresponding zones.
      --remove-zone stringArray     [Optional] Remove zone associated to the Kubernetes Region defined. Provide the following double colon (::) separated fields as key-value pairs: "zone-name=<zone-name>::region-name=<region-name>". Zone name, Region name are required values. Each zone needs to be removed using a separate --remove-zone flag.
      --airgap-install              [Optional] Do YugabyteDB nodes have access to public internet to download packages.
  -h, --help                        help for update

Options inherited from parent commands

  -a, --apiToken string    YugabyteDB Anywhere api token.
      --ca-cert string     CA certificate file path for secure connection to YugabyteDB Anywhere. Required when the endpoint is https and --insecure is not set.
      --config string      Full path to a specific configuration file for YBA CLI. If provided, this takes precedence over the directory specified via --directory, and the generated files are added to the same path. If not provided, the CLI will look for '.yba-cli.yaml' in the directory specified by --directory. Defaults to '$HOME/.yba-cli/.yba-cli.yaml'.
      --debug              Use debug mode, same as --logLevel debug.
      --directory string   Directory containing YBA CLI configuration and generated files. If specified, the CLI will look for a configuration file named '.yba-cli.yaml' in this directory. Defaults to '$HOME/.yba-cli/'.
      --disable-color      Disable colors in output. (default false)
  -H, --host string        YugabyteDB Anywhere Host (default "http://localhost:9000")
      --insecure           Allow insecure connections to YugabyteDB Anywhere. Value ignored for http endpoints. Defaults to false for https.
  -l, --logLevel string    Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
  -n, --name string        [Optional] The name of the provider for the action. Required for create, delete, describe, update.
  -o, --output string      Select the desired output format. Allowed values: table, json, pretty. (default "table")
      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
      --wait               Wait until the task is completed, otherwise it will exit immediately. (default true)

SEE ALSO