Chapter 9. Istioctl tool

Use the

istioctl

command line utility to perform diagnostic and debugging tasks for OpenShift Service Mesh 3 service mesh components.

9.1. Support for Istioctl
Copy link

OpenShift Service Mesh 3 supports a selection of Istioctl commands.

Expand

Table 9.1. Supported Istioctl commands
Command	Description
`admin`	Manage the control plane ( `istiod` ) configuration
`analyze`	Analyze the Istio configuration and print validation messages
`completion`	Generate the autocompletion script for the specified shell
`create-remote-secret`	Create a secret with credentials to allow Istio to access remote Kubernetes API servers
`help`	Display help about any command
`proxy-config` , `pc`	Retrieve information about the proxy configuration from Envoy (Kubernetes only)
`proxy-status` , `ps`	Retrieve the synchronization status of each Envoy in the mesh
`remote-clusters`	List the remote clusters each `istiod` instance is connected to
`validate` , `v`	Validate the Istio policy and rules files
`version`	Print out the build version information
`waypoint`	Manage the waypoint configuration
`ztunnel-config`	Update or retrieve the current Ztunnel configuration.

Install the

istioctl

command-line utility to debug and diagnose Istio service mesh deployments.

Prerequisites

Procedure

Confirm which version of the
```
Istio
```
resource runs on the installation by running the following command:
```
$ oc get istio -ojsonpath="{range .items[*]}{.spec.version}{'\n'}{end}" | sed s/^v// | sort
```
If there are multiple
```
Istio
```
resources with different versions, choose the latest version. The latest version is displayed last.
In the OpenShift Container Platform web console, click the Help icon and select Command Line Tools.
Click Download istioctl. Choose the version and architecture that matches your system.
Extract the
```
istioctl
```
binary file.
1. If you are using a Linux operating system, run the following command:
  $ tar xzf istioctl-<VERSION>-<OS>-<ARCH>.tar.gz
2. If you are using an Apple Mac operating system, unpack and extract the archive.
3. If you are using a Microsoft Windows operating system, use the zip software to extract the archive.
Move to the uncompressed directory by running the following command:
```
$ cd istioctl-<VERSION>-<OS>-<ARCH>
```
Add the
```
istioctl
```
client to the path by running the following command:
```
$ export PATH=$PWD:$PATH
```
Confirm that the
```
istioctl
```
client version and the Istio control plane version match or are within one version by running the following command:
```
$ istioctl version
```
Sample output:
```
client version: 1.20.0
control plane version: 1.24.3_ossm
data plane version: none
```