How to Retrieve the Cluster Configuration for Vultr Kubernetes Engine

Updated on September 25, 2024

Retrieving a VKE Cluster Configuration allows you to access essential details about your Kubernetes cluster, including API endpoints, authentication credentials, and resource specifications. This process is crucial for managing and interacting with your cluster effectively. Vultr Kubernetes Engine provides straightforward methods to retrieve these configurations, ensuring you have the necessary information to operate and scale your cluster efficiently.

Follow this guide to retrieve the Kubernetes Cluster configuration on your Vultr account using the Vultr Customer Portal, API, or CLI.

  • Vultr Customer Portal
  • Vultr API
  • Vultr CLI
  1. Navigate to Products and click Kubernetes.

    Kubernetes option in products menu

  2. Click your target Kubernetes Cluster to open its management page.

    Selection of a target Kubernetes cluster

  3. Click Download Configuration.

    Button to download the Kubernetes cluster configuration

  1. Send a GET request to the List Kubernetes Clusters endpoint and note the target Kubernetes Cluster's ID.

    console
    $ curl -X GET "https://api.vultr.com/v2/kubernetes/clusters" \
        -H "Authorization: Bearer ${VULTR_API_KEY}" \
        -H "Content-Type: application/json"
    
  2. Send a GET request to the Kubernetes Clusters Config endpoint to get the config file for the target Kubernetes Cluster.

    console
    $ curl -X GET "https://api.vultr.com/v2/kubernetes/clusters/<cluster-id>/config" \
        -H "Authorization: Bearer ${VULTR_API_KEY}" \
        -H "Content-Type: application/json" \
        -o kubeconfig.yaml
    
  1. List the available Kubernetes subscriptions in your Vultr account and note the target Kubernetes Cluster's ID.

    console
    $ vultr-cli kubernetes list --summarize
    
  2. Get the Kubernetes Cluster configuration file.

    console
    $ vultr-cli kubernetes config <cluster-id> --output yaml