istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds a separate docs page for istioctl. (#4274)

This commit is contained in:
Jason Clark 2019-06-07 17:06:50 -04:00 committed by Martin Taillefer
parent f30d7df422
commit a5860faa1d
2 changed files with 104 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
content/docs/ops/setup/istioctl/index.md Normal file
View File

@ -0,0 +1,103 @@
---
title: Using the istioctl command-line tool
description: Istio includes a supplemental tool that provides debugging and diagnosis for Istio service mesh deployments.
weight: 20
keywords: [istioctl,bash,zsh,shell,command-line]
---
## Overview
The `istioctl` tool is a configuration command line utility that allows service operators to debug and diagnose their Istio service mesh deployments. The Istio project also includes two helpful scripts for `istioctl` that enable auto-completion for Bash and ZSH. Both of these scripts provide support for the currently available `istioctl` commands.
Documentation for the complete set of supported commands can be found in [`istioctl` reference](/docs/reference/commands/istioctl/).
## `istioctl` auto-completion
{{< tabset cookie-name="prereqs" >}}
{{< tab name="macOS" cookie-value="macos" >}}
If you are using the macOS operating system with the Bash terminal shell, make sure that the `bash-completion` package is installed. With the [brew](https://brew.sh) package manager for macOS, you can check to see if the `bash-completion` package is installed with the following command:
{{< text bash >}}
$ brew info bash-completion
bash-completion: stable 1.3 (bottled)
{{< /text >}}
If you find that the `bash-completion` package is _not_ installed, proceed with installing the `bash-completion` package with the following command:
{{< text bash >}}
$ brew install bash-completion
{{< /text >}}
Once the `bash-completion package` has been installed on your macOS system, add the following line to your `~/.bash_profile` file:
`[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"`
{{< /tab >}}
{{< tab name="Linux" cookie-value="linux" >}}
If you are using a Linux-based operating system, you can install the Bash completion package with the `apt-get install bash-completion` command for Debian-based Linux distributions or `yum install bash-completion` for RPM-based Linux distributions, the two most common occurrences.
Once the `bash-completion` package has been installed on your Linux system, add the following line to your `~/.bash_profile` file:
`[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"`
{{< /tab >}}
{{< /tabset >}}
### Enabling auto-completion
To enable `istioctl` completion on your system, follow the steps for your preferred shell:
{{< tabset cookie-name="profile" >}}
{{< tab name="Bash" cookie-value="bash" >}}
Installing the bash auto-completion file
If you are using bash, the `istioctl` auto-completion file is located in the `tools` directory. To use it, copy the `istioctl.bash` file to your home directory, then add the following line to source the `istioctl` tab completion file from your `.bashrc` file:
{{< text bash >}}
$ source ~/istioctl.bash
{{< /text >}}
{{< /tab >}}
{{< tab name="ZSH" cookie-value="zsh" >}}
Installing the ZSH auto-completion file
For ZSH users, the `istioctl` auto-completion file is located in the `tools` directory. Copy the `_istioctl` file to your home directory, then source the `istioctl` auto-completion file as follows:
{{< text zsh >}}
source ~/_istioctl
{{< /text >}}
{{< tip >}}
If you get an error like `complete:13: command not found: compdef`, then add the following to the beginning of your `~/.zshrc` file:
{{< text bash >}}
$ autoload -Uz compinit
$ compinit
{{< /text >}}
{{< /tip >}}
You may also add the `_istioctl` file to a directory listed in the `fpath` variable. To achieve this, place the `_istioctl` file in an existing directory in the `fpath`, or create a new directory and add it to the `fpath` variable in your `~/.zshrc` file.
{{< /tab >}}
{{< /tabset >}}
### Using auto-completion
If the `istioctl` completion file has been installed correctly, press the Tab key while writing an `istioctl` command, and it should return a set of command suggestions for you to choose from:
{{< text bash >}}
$ istioctl proxy-<TAB>
proxy-config proxy-status
{{< /text >}}

64
content/docs/setup/kubernetes/getting-started/index.md
View File

@ -81,66 +81,4 @@ services from all other namespaces.
$ export PATH=$PWD/bin:$PATH
{{< /text >}}
## Enabling `istioctl` tab completion
If you are using Bash or ZSH, `istioctl` includes a helpful script that enables tab completion for the currently available `istioctl` commands.
### Installing the `istioctl` tab completion file
If you are using Bash, the `istioctl` tab completion file is located in the `tools` directory. To use it, copy the `istioctl.bash` file to your home directory, then add the following line to source the `istioctl` tab completion file from your `.bashrc` file:
{{< text bash >}}
$ source ~/istioctl.bash
{{< /text >}}
For ZSH users, an additional `istioctl` tab completion file is also located in the `tools` directory. In a similar fashion, you can copy the `_istioctl` file to your home directory, then source the `istioctl` tab completion file as follows:
{{< text zsh >}}
$ source < _istioctl
{{< /text >}}
{{< tip >}}
If you get an error like `complete:13: command not found: compdef`, then add the following to the beginning of your `~/.zshrc` file:
{{< text bash >}}
$ autoload -Uz compinit
$ compinit
{{< /text >}}
{{< /tip >}}
You may also add the `_istioctl` file to a directory listed in the `FPATH` variable. To achieve this, place the `_istioctl` file in an existing directory in the `FPATH`, or create a new directory and add it to the `FPATH` variable in your `~/.zshrc` file.
### Prerequisites for macOS
If you are using macOS with the Bash shell, make sure that the `bash-completion` package is installed. If you are using the [brew](https://brew.sh) package manager for macOS, you can check to see if the `bash-completion` package is installed with the following command:
{{< text bash >}}
$ brew info bash-completion
bash-completion: stable 1.3 (bottled)
{{< /text >}}
If the bash-completion package is _not_ installed, proceed with installing the bash-completion package with the following command:
{{< text bash >}}
$ brew install bash-completion
{{< /text >}}
{{< tip >}}
Once the bash-completion package has been installed on your macOS system, also make sure to add the following line to your `~/.bash_profile` file:
`[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"`
{{< /tip >}}
### Prerequisites for Linux
For Linux, to install the bash completion package, you would use the `apt-get install bash-completion` command for Debian-based Linux distributions or `yum install bash-completion` for RPM-based Linux distributions, the two most common occurrences.
## Using `istioctl` auto-completion
If the `istioctl` completion file has been installed correctly, press the Tab key while writing an `istioctl` command, and it should return a set of command suggestions for you to choose from:
{{< text bash >}}
$ istioctl proxy-<TAB>
proxy-config proxy-status
{{< /text >}}
1. You can enable the [auto-completion option](/docs/ops/setup/istioctl) when working with a bash or ZSH console.