Add info to verify successfull installation and address other suggestions

Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
This commit is contained in:
bhumijgupta 2021-07-05 17:15:04 +05:30
parent 956eb48e72
commit 437e2a74f8
4 changed files with 31 additions and 6 deletions

View File

@ -1,9 +1,11 @@
---
title: "kubectl-convert overview"
description: "What is kubectl-convert plugin?"
description: >-
A kubectl plugin that allows you to convert manifests from one version
of a Kubernetes API to a different version.
headless: true
---
kubectl-convert is a kubectl plugin which allows to convert manifests between different api
versions. This can be particularly helpful to migrate manifests to a non-deprecated api version.
A plugin for Kubernetes command-line tool `kubectl`, which allows you to convert manifests between different API
versions. This can be particularly helpful to migrate manifests to a non-deprecated api version with newer Kubernetes release.
For more info, visit [migrate to non deprecated apis](/docs/reference/using-api/deprecation-guide/#migrate-to-non-deprecated-apis)

View File

@ -184,7 +184,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}}
{{< /tabs >}}
### Install kubectl convert plugin
### Install `kubectl convert` plugin
{{< include "included/kubectl-convert-overview.md" >}}
@ -231,6 +231,13 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert
```
1. Verify plugin is successfully installed
```shell
kubectl convert --help
```
If you do not see an error, it means the plugin is successfully installed.
## {{% heading "whatsnext" %}}

View File

@ -168,7 +168,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}}
{{< /tabs >}}
### Install kubectl convert plugin
### Install `kubectl convert` plugin
{{< include "included/kubectl-convert-overview.md" >}}
@ -236,6 +236,14 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
Make sure `/usr/local/bin` is in your PATH environment variable.
{{< /note >}}
1. Verify plugin is successfully installed
```shell
kubectl convert --help
```
If you do not see an error, it means the plugin is successfully installed.
## {{% heading "whatsnext" %}}
{{< include "included/kubectl-whats-next.md" >}}

View File

@ -140,7 +140,7 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th
{{< include "included/optional-kubectl-configs-zsh.md" >}}
### Install kubectl-convert plugin
### Install `kubectl convert` plugin
{{< include "included/kubectl-convert-overview.md" >}}
@ -175,6 +175,14 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th
1. Add the binary in to your `PATH`.
1. Verify plugin is successfully installed
```shell
kubectl convert --help
```
If you do not see an error, it means the plugin is successfully installed.
## {{% heading "whatsnext" %}}
{{< include "included/kubectl-whats-next.md" >}}