Skip to main content

Setting the Kubeconfig File as an Environment Variable

To configure Kubernetes access on different operating systems, you can set the KUBECONFIG environment variable to point to your specific Kubernetes configuration file (kubeconfig.yaml). This allows Kubernetes command-line tools like kubectl to automatically use the configuration without needing the --kubeconfig flag every time.


For Linux

  1. Download the Kubeconfig File — Log in to the MyAccount dashboard, navigate to your Kubernetes cluster, and download the kubeconfig file (typically named kubeconfig.yaml) from the cluster details section.

  2. Set the Kubeconfig Path — Open your terminal and edit the .bashrc file in your home directory:

    vim ~/.bashrc
  3. Add the Environment Variable — Add the following line at the end of the .bashrc file. Replace /path/to/your/kube-config-file with the actual path to your downloaded kubeconfig.yaml:

    export KUBECONFIG="/path/to/your/kube-config-file"
  4. Apply the Changes — Reload the .bashrc file to apply the new variable:

    source ~/.bashrc
  5. Verify the Configuration — Confirm access to your cluster without the --kubeconfig flag:

    kubectl get nodes

For Windows

  1. Download the Kubeconfig File — Log in to the MyAccount dashboard, navigate to your Kubernetes cluster, and download the kubeconfig file (typically named kubeconfig.yaml) from the cluster details section.

  2. Set the Environment Variable for a Specific User — Open PowerShell with Administrator privileges by right-clicking the PowerShell icon and selecting Run as Administrator. Then run:

    [System.Environment]::SetEnvironmentVariable("KUBECONFIG", "C:\Users\UserName\Downloads\kubeconfig.yaml", [System.EnvironmentVariableTarget]::User)
  3. For All Users (Global System-Wide) — To set the environment variable for all users on the machine, run:

    [System.Environment]::SetEnvironmentVariable("KUBECONFIG", "C:\Users\Administrator\Downloads\kubeconfig.yaml", [System.EnvironmentVariableTarget]::Machine)
  4. Verify the Configuration — Confirm access to your cluster without the --kubeconfig flag:

    kubectl get nodes

For macOS

  1. Download the Kubeconfig File — Log in to the MyAccount dashboard, navigate to your Kubernetes cluster, and download the kubeconfig file (typically named kubeconfig.yaml) from the cluster details section.

  2. Set the Kubeconfig Path — Open the terminal and edit the .zshrc file in your home directory:

    vim ~/.zshrc
  3. Add the Environment Variable — Add the following line at the end of the .zshrc file. Replace /path/to/your/kube-config-file with the actual path to your downloaded kubeconfig.yaml:

    export KUBECONFIG="/path/to/your/kube-config-file"
  4. Apply the Changes — Reload the .zshrc file to apply the new variable:

    source ~/.zshrc
  5. Verify the Configuration — Confirm access to your cluster without the --kubeconfig flag:

    kubectl get nodes

Key Points

  • KUBECONFIG Variable — Setting this environment variable tells kubectl and other Kubernetes tools where to find your kubeconfig file.
  • Path Customization — Replace /path/to/your/kube-config-file with the actual path to the kubeconfig file on your system.
  • Verification — After setting the variable and applying the changes, run kubectl get nodes to confirm you can access your Kubernetes cluster.