System Administrator - Configure System Remote CLI & Kubernetes Remote CLI

Configure the StarlingX remote CLI and kubernetes remote CLI on your Linux-based system so that you can remotely access your StarlingX system through remote CLI commands.

This procedure should be performed on your Linux-based system.

Prerequisites

  • You need to have a Linux-based system with python installed and either with Docker installed or ‘sudo’ capability to install Docker.

  • You need to have the stx-remote-access.tar file from your system administrator, containing system information related to your StarlingX system.

Procedure

  1. Install Docker on your Linux-based system. The following example is for ubuntu.

    # Add Docker's official GPG key:
$ sudo apt-get update
$ sudo apt-get install ca-certificates curl
$ sudo install -m 0755 -d /etc/apt/keyrings
$ sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
$ sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
$ echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
$ sudo apt-get update

# Install Docker Packages
$ sudo apt-get install docker-ce docker-ce-cli `containerd.io <http://containerd.io>`__ docker-buildx-plugin docker-compose-plugin

# Verify that the Docker Engine installation is successful by running the hello-world image.
$ sudo docker run hello-world

# Manage docker as non-root user
$ sudo groupadd docker
$ sudo usermod -aG docker $USER
$ sudo reboot

  2. Download and extract the StarlingX remote CLI tar file from the StarlingX site.

    $ cd ~
$ wget https://mirror.starlingx.cengn.ca/mirror/starlingx/master/debian/monolithic/latest_build/outputs/remote-cli/stx-remote-cli-1.0.tgz
$ tar xvf stx-remote-cli-1.0.tgz

  3. Extract the StarlingX system information from the stx-remote-access-info.tar file from your StarlingX system administrator.

    # Files from your StarlingX System Administrator
$ ls ~/stx-remote-access-info.tar

$ cd ~/remote_cli
$ tar xvf ~/stx-remote-access-info.tar

  4. Update the starlingxrc file.

    $ vi ~/remote_cli/stx-remote-access-info/starlingxrc
   // and change YOURUSERNAMEHERE to your StarlingX LDAP Username, everywhere in file

  5. Update the KUBECONFIG file.

    $ vi ~/remote_cli/stx-remote-access-info/kubeconfig
   // and change YOURUSERNAMEHERE to your StarlingX LDAP Username, everywhere in file

  6. Configure the containerized remote CLI clients.

    $ ./configure_client.sh -t platform -r ${HOME}/remote_cli/stx-remote-access-info/starlingxrc -k ${HOME}/remote_cli/stx-remote-access-info/kubeconfig -w ${HOME}/remote_cli -p docker.io/starlingx/stx-platformclients:stx.9.0-v1.5.13

Postrequisites