Access methods

This page describes basic scenarios for accessing clusters from the command line. Choose the method that fits your situation, then follow the linked instructions.

Two main approaches

  1. Getting cluster kubeconfig — download kubeconfig from the GUI and use kubectl.
  2. kubectl-shturval-plugin — install the plugin, use kubectl-shturval-plugin.yaml, or sign in directly with kubectl shturval login.

See the table below for a detailed comparison.

Prerequisites

  • kubectl installed;
  • a platform account with access to the target cluster;
  • for kubectl-shturval-plugin scenarios — the kubectl-shturval-plugin plugin installed;
  • for non-GUI scenarios — known shturval-backend connection parameters, including server-url, username, and client-secret;
  • if client-secret is unavailable, request it from the platform administrator. The value is in the backend-* secret in the shturval-backend namespace of the management cluster.

Scenario comparison

ScenarioGUI requiredOutputWhen to useLimitations
Downloaded kubeconfigYesclustername.confQuick access to a single clusterToken is valid for 24 hours by default
Plugin config from GUIYeskubectl-shturval-plugin.yaml, then clustername.conf or all-clusters.confGUI is available and you prefer not to enter parameters manuallyRequires the plugin to be installed
Plugin config from CLINokubectl-shturval-plugin.yaml, then kubeconfigGUI is unavailable or you prefer not to use it, and connection parameters are knownConnection parameters must be known in advance
Direct login without config fileNokubeconfig for one or more clustersOne-time login without saving a YAML fileAll parameters must be passed to the command

See Typical access errors if cluster login does not work.

← What to do if you don't have enough access rights?
Getting cluster kubeconfig →