Skip to main content

diagrid k8s-operator uninstall

Uninstall the Catalyst Kubernetes operator

Description​

Uninstall the Catalyst Kubernetes operator from a cluster.

This removes the operator's Helm release (deployment, RBAC, webhook configuration and the cert-manager objects the chart created). A missing release is treated as success, so the command is safe to re-run.

The Catalyst service account and API key that 'install' created in the control plane are left in place by default — they may be shared with operators on other clusters. Pass --delete-credentials to prune the API keys this tool minted for the operator (matching --api-key-name), or --delete-service-account to remove the whole service account (and with it all of its keys).

cert-manager and any namespaces you migrated to Catalyst are left untouched.

diagrid k8s-operator uninstall [flags]

Examples​


  # Uninstall the operator from the current kube context
  diagrid k8s-operator uninstall

  # Target a specific cluster
  diagrid k8s-operator uninstall --context my-eks

  # Also prune the API keys this tool minted for the operator
  diagrid k8s-operator uninstall --delete-credentials

  # Remove the operator and its Catalyst service account entirely
  diagrid k8s-operator uninstall --delete-service-account

  # Preview what would be removed without deleting anything
  diagrid k8s-operator uninstall --dry-run

  # Skip the confirmation prompt (e.g. in CI)
  diagrid k8s-operator uninstall --yes

Options​

  -n, --namespace string         Namespace the operator is installed in. (default "catalyst-system")
      --release-name string      Helm release name of the operator. (default "catalyst-operator")
      --kubeconfig string        Path to the kubeconfig file. Defaults to the standard resolution (KUBECONFIG / ~/.kube/config).
      --context string           Name of the kube context to uninstall from. Defaults to your current context.
      --delete-credentials       Prune the API keys this tool minted for the operator (matching --api-key-name) from the service account.
      --delete-service-account   Delete the operator's Catalyst service account entirely (removes all of its API keys).
      --service-account string   Name of the operator's Catalyst service account (used by --delete-credentials / --delete-service-account). (default "catalyst-k8s-operator")
      --api-key-name string      Name prefix of the API keys to prune with --delete-credentials. (default "diagrid-k8s-operator")
      --wait                     Wait for the operator resources to be fully removed before returning.
      --timeout duration         Time to wait for resources when --wait is set. (default 5m0s)
      --keep-history             Retain the Helm release history instead of purging it.
      --dry-run                  Print what would be removed without deleting anything.
      --approve                  Skip confirmation prompt.
  -y, --yes                      Skip confirmation prompt
  -h, --help                     help for uninstall

SEE ALSO​

Last updated on