Instana kubectl plug-in

A kubectl plugin is available that helps install the operator and also enables you to trigger administrative actions that the operator will then perform. The binary must be available somewhere on the system's PATH. kubectl will then recognize it automatically as a plugin.

Here's the default help output of the plugin. Help is integrated into the plugin and can be displayed for any command 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     Cleanup 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 plugin is versioned together with the operator and all Instana components. Updating to a new version of Instana requires to download the plugin in the version you want to install.

Installation

Ubuntu/Debian

As root, execute the following lines:

echo "deb [arch=amd64] https://self-hosted.instana.io/apt generic main" > /etc/apt/sources.list.d/instana-product.list
wget -qO - "https://self-hosted.instana.io/signing_key.gpg" | apt-key add -
apt-get update
apt-get install instana-kubectl

To avoid getting major updates during automated upgrades, please execute

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

RedHat/CentOS

As root, execute the following lines:

cat > /etc/yum.repos.d/Instana-Product.repo << EOF
[instana-product]
name=Instana-Product
baseurl=https://self-hosted.instana.io/rpm/release/product/rpm/generic/x86_64/Packages
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://self-hosted.instana.io/signing_key.gpg
priority=5
sslverify=1
#proxy=http://x.x.x.x:8080
#proxy_username=
#proxy_password=
EOF

yum makecache -y fast
yum install -y instana-kubectl

To avoid getting major updates during automated updates, please execute

yum versionlock add instana-kubectl

Manual Installation

Download the plugin for your platform and installing it in your PATH so kubectl can pick it up.

All binaries are signed using this key.

After downloading unpack the binary and you will end up with a file named kubectl-instana. Put the extracted file on your PATH but make sure to not change the binary name. kubectl automatically discovers binaries on the PATH prefixed with kubectl- as plugins.

For Linux/MaxOS:

export PATH=$PATH:<path_to_binary_directory>

Now check the plugin is available:

kubectl instana --version

And you should see output similar to this:

kubectl-instana version 215-2 (commit=e467ebde94c5ed63aaa133526f79282508e9564f, date=2021-11-24T13:31:36Z, image=215-2, branch=release)

Required Database Versions:
  * Cassandra:     3.11.10
  * Clickhouse:    21.3.8.76
  * Cockroach:     21.1.7
  * Elasticsearch: 7.10.2
  * Kafka:         2.7.1
  * Zookeeper:     3.6.3