kctxsync

kctxsync is a command-line tool designed to synchronize the certificate and key data from a remote Kubernetes cluster's kubeconfig file to your local kubeconfig. It is particularly useful for updating the local kubeconfig when certificates or keys have changed in the remote cluster, ensuring that your local environment is always in sync with the remote server.

Features

• Sync kubeconfig: Automatically fetches the kubeconfig file from a remote server via SSH and updates the local kubeconfig with any changes in the certificate-authority-data, client-certificate-data, or client-key-data.
• Effortless updates: No need to manually inspect or copy certificates and keys between your local and remote environments. The tool ensures that your local kubeconfig always contains the latest certificates from the remote cluster.
• Flexible configuration: Specify the path to your local kubeconfig file, SSH user, and even the SSH host for remote access, allowing for a customizable workflow.
• Sync all contexts: The --all flag allows you to sync all contexts from your local kubeconfig in one go.

How it works

1. The tool connects to the remote server using SSH.
2. It retrieves the remote kubeconfig from the default path (~/.kube/config).
3. The tool compares the certificates and keys in the remote kubeconfig with those in your local kubeconfig.
4. If differences are found, the local kubeconfig is updated with the remote data, ensuring that your environment has the correct and up-to-date credentials.

Usage

Sync a specific context

To sync the local kubeconfig with the remote server's kubeconfig, use the following command:

kctxsync sync <context_name>

• <context_name>: (Optional) The name of the Kubernetes context you wish to sync.
• Optionally, you can specify the path to the local kubeconfig and the SSH user:

kctxsync sync <context_name> --config /path/to/kubeconfig --user <ssh_user>

If you do not provide a context and there are multiple contexts in the kubeconfig, an error will prompt you to select a context explicitly.

Sync all contexts

You can sync all the contexts in your local kubeconfig with the remote server by using the --all flag:

kctxsync sync --all

Specify a custom SSH host

If you need to connect to a specific SSH host (instead of using the server from the kubeconfig), you can use the --ssh flag:

kctxsync sync <context_name> --ssh <ssh_host>

This will allow you to connect to a specific SSH host, overriding the server defined in the kubeconfig for the context.

Example

kctxsync sync dev --user ubuntu --ssh my.remote.server.com

This will connect to the specified remote server my.remote.server.com using the SSH user ubuntu, fetch the kubeconfig file, and sync the context dev from the remote kubeconfig to your local kubeconfig.

Installation

Homebrew

brew install vvrnv/tap/kctxsync

Go

go install github.com/vvrnv/kctxsync@latest

Download binary

release page link