Client Installation
  • 16 Jun 2023
  • Dark
    Light

Client Installation

  • Dark
    Light

Article summary

Install CSE Software

Prerequisite: Python 3.73 or greater, which can be found at python.org

With the installation of Python,  python’s package manager, Pip,  is installed by default.

Install and Verify CSE

Enter these commands to install and verify CSE

Install and Verify CSE
$ pip3 install container-service-extension
...
 
$ cse version
CSE, Container Service Extension for VMware vCloud Director, version 2.5.0

Enable CSE in vCD-CLI

The CLI and the container-service-extension must be installed on the machine running the commands and the profile located at ~/.vcd-cli/profiles.yaml must be updated to reflect the presence of the extension.  Additional details on this config are available at - https://vmware.github.io/container-service-extension/#tenant-installation  Example below...

Profile Config File
Profile Config File
active: default
extensions:
- container_service_extension.client.cse
profiles:



For more information, see https://vmware.github.io/container-service-extension/cse3_1/INSTALLATION.html


Install and Set Up kubectl

The Kubernetes command-line tool, kubectl, allows you to run commands against Kubernetes clusters. You can use kubectl to deploy applications, inspect and manage cluster resources, and view logs. For a complete list of kubectl operations, see Overview of kubectl.

Before you begin

You must use a kubectl version that is within one minor version difference of your cluster. For example, a v1.2 client should work with v1.1, v1.2, and v1.3 master. Using the latest version of kubectl helps avoid unforeseen issues.

Install kubectl on Linux

Install kubectl binary with curl on Linux

  1. Download the latest release with the command:

    curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
    

    To download a specific version, replace the $(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt) portion of the command with the specific version.

    For example, to download version v1.16.0 on Linux, type:

    curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.16.0/bin/linux/amd64/kubectl
    
  2. Make the kubectl binary executable.

    chmod +x ./kubectl
    
  3. Move the binary in to your PATH.

    sudo mv ./kubectl /usr/local/bin/kubectl
    
  4. Test to ensure the version you installed is up-to-date:

    kubectl version
    

Install using native package management


sudo apt-get update <span style="color: rgb(102, 102, 102);">&&</span> sudo apt-get install -y apt-transport-https curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
<span style="color: rgb(170, 34, 255);">echo</span> <span style="color: rgb(187, 68, 68);">"deb https://apt.kubernetes.io/ kubernetes-xenial main"</span> | sudo tee -a /etc/apt/sources.list.d/kubernetes.list sudo apt-get update sudo apt-get install -y kubectl

Install with snap

If you are on Ubuntu or another Linux distribution that support snap package manager, kubectl is available as a snap application.

  1. Switch to the snap user and run the installation command:

    sudo snap install kubectl --classic
    
  2. Test to ensure the version you installed is up-to-date:

    kubectl version
    

Install kubectl on macOS

Install kubectl binary with curl on macOS

  1. Download the latest release:

    curl -LO "https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl"
    

    To download a specific version, replace the $(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt) portion of the command with the specific version.

    For example, to download version v1.16.0 on macOS, type:

    curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.16.0/bin/darwin/amd64/kubectl
    
  2. Make the kubectl binary executable.

    chmod +x ./kubectl
    
  3. Move the binary in to your PATH.

    sudo mv ./kubectl /usr/local/bin/kubectl
    
  4. Test to ensure the version you installed is up-to-date:

    kubectl version
    

Install with Homebrew on macOS

If you are on macOS and using Homebrew package manager, you can install kubectl with Homebrew.

  1. Run the installation command:

    brew install kubectl 

    or

    brew install kubernetes-cli
    
  2. Test to ensure the version you installed is up-to-date:

    kubectl version
    

Install with Macports on macOS

If you are on macOS and using Macports package manager, you can install kubectl with Macports.

  1. Run the installation command:

    sudo port selfupdate sudo port install kubectl
    
  2. Test to ensure the version you installed is up-to-date:

    kubectl version
    

Install kubectl on Windows

Install kubectl binary with curl on Windows

  1. Download the latest release v1.16.0 from this link.

    Or if you have curl installed, use this command:

    curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.16.0/bin/windows/amd64/kubectl.exe
    

    To find out the latest stable version (for example, for scripting), take a look at https://storage.googleapis.com/kubernetes-release/release/stable.txt.

  2. Add the binary in to your PATH.

  3. Test to ensure the version of kubectl is the same as downloaded:

    kubectl version
    

Note: Docker Desktop for Windows adds its own version of kubectl to PATH. If you have installed Docker Desktop before, you may need to place your PATH entry before the one added by the Docker Desktop installer or remove the Docker Desktop’s kubectl.

Install with Powershell from PSGallery

If you are on Windows and using Powershell Gallery package manager, you can install and update kubectl with Powershell.

  1. Run the installation commands (making sure to specify a DownloadLocation):

    Install-Script -Name install-kubectl -Scope CurrentUser -Force install-kubectl.ps1 [-DownloadLocation <path>]
    

    Note: If you do not specify a DownloadLocation, kubectl will be installed in the user’s temp Directory.

    The installer creates $HOME/.kube and instructs it to create a config file

  2. Test to ensure the version you installed is up-to-date:

    kubectl version
    

    Note: Updating the installation is performed by rerunning the two commands listed in step 1.

Verifying kubectl configuration

In order for kubectl to find and access a Kubernetes cluster, it needs a kubeconfig file, which is created automatically when you create a cluster using kube-up.sh or successfully deploy a Minikube cluster. By default, kubectl configuration is located at ~/.kube/config.

Check that kubectl is properly configured by getting the cluster state:

kubectl cluster-info

If you see a URL response, kubectl is correctly configured to access your cluster.

If you see a message similar to the following, kubectl is not configured correctly or is not able to connect to a Kubernetes cluster.

The connection to the server <server-name:port> was refused - did you specify the right host or port?

For example, if you are intending to run a Kubernetes cluster on your laptop (locally), you will need a tool like Minikube to be installed first and then re-run the commands stated above.

If kubectl cluster-info returns the url response but you can’t access your cluster, to check whether it is configured properly, use:

kubectl cluster-info dump



Install and Set Up kubectl by kubernetes.io is licensed under CCA 4.0



Was this article helpful?