Instana kubectl plug-in

Installation

The Instana kubectl plug-in helps you install the operator and trigger administrative actions that the operator performs.

The binary file must be available somewhere on the system's PATH so that kubectl recognize it automatically as a plug-in.

See the following default help output of the Instana kubectl plug-in.

The help information is integrated into the plug-in, and can be displayed for any command by using the --help flag.

kubectl instana --help
Commands for managing Instana

Usage:
  kubectl-instana [command]

Available Commands:
  action      Run a utility action on a Core or a Unit
  cleanup     Clean up obsolete services and endpoints
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  images      Print a list of all required images
  license     Download the license
  migrate     Migrate a 'settings.hcl' file
  operator    Install the operator or generate manifests
  template    Create YAML templates for namespaces and custom resources

Flags:
  -h, --help      help for kubectl-instana
  -v, --version   version for kubectl-instana

Use "kubectl-instana [command] --help" for more information about a command.

Note: Currently, the plug-in is versioned together with the operator and all Instana components. If you want to update to a new version of Instana, you need to download the plug-in of the new version.

Installation

Ubuntu/Debian

As root, run the following command to add the repository. You need to replace <download_key> with your download key.

export DOWNLOAD_KEY="<download_key>"

echo 'deb [signed-by=/usr/share/keyrings/instana-archive-keyring.gpg] https://artifact-public.instana.io/artifactory/rel-debian-public-virtual generic main' > /etc/apt/sources.list.d/instana-product.list

cat << EOF > /etc/apt/auth.conf
machine artifact-public.instana.io
  login _
  password $DOWNLOAD_KEY
EOF

wget -O- --user=_ --password="$DOWNLOAD_KEY" https://artifact-public.instana.io/artifactory/api/security/keypair/public/repositories/rel-debian-public-virtual | gpg --dearmor > /usr/share/keyrings/instana-archive-keyring.gpg

To install instana-kubectl, run the following command:

apt update -y
apt install -y instana-kubectl

To avoid getting major updates during automated upgrades, run the following commands:

cat > /etc/apt/preferences.d/instana-kubectl <<EOF
Package: instana-kubectl
Pin: version <version to pin>
Pin-Priority: 1000
EOF

Red Hat/CentOS

As root, run the following command to add the repository. You need to replace <download_key> with your download key.

export DOWNLOAD_KEY="<download_key>"

cat << EOF > /etc/yum.repos.d/Instana-Product.repo
[instana-product]
name=Instana-Product
baseurl=https://_:$DOWNLOAD_KEY@artifact-public.instana.io/artifactory/rel-rpm-public-virtual/
enabled=1
gpgcheck=0
gpgkey=https://_:$DOWNLOAD_KEY@artifact-public.instana.io/artifactory/api/security/keypair/public/repositories/rel-rpm-public-virtual
repo_gpgcheck=1
EOF

To install instana-kubectl, run the following command:

yum clean expire-cache -y
yum update -y
yum install -y instana-kubectl

To avoid getting major updates during automated updates, run the following command:

yum versionlock add instana-kubectl

Manual installation

Download the plug-in for your platform, and install it in your PATH so that kubectl can pick it up.

All binary files are signed by using this GPG key:

After the downloading unpacks the binary, you can see a file that is named kubectl-instana.

Put the extracted file on your PATH, but make sure to not change the binary name.

kubectl automatically discovers binary files that are prefixed with kubectl- as plug-ins on the PATH.

For Linux/MaxOS:

export PATH=$PATH:<path_to_binary_directory>

Now check whether the kubectl-instana plug-in is available:

kubectl instana --version

You can see the output as follows:

kubectl-instana version 251-2 (commit=1901aa0570ff2a6b5a8dcf50dbb2f9f9fdc1811c, date=2023-08-03T17:29:25+02:00)

Minimum required database versions:

clickhouse          :	Major: 22.3 	min. Minor: 2
beeinstana          :	Major: 1 	min. Minor: 160
postgres            :	Major: 15 	min. Minor: 0
kafka               :	Major: 3 	min. Minor: 2
elasticsearch       :	Major: 7 	min. Minor: 16
cassandra           :	Major: 4 	min. Minor: 0