From 956eb48e72d76d0dfa5290e95037d059e386562f Mon Sep 17 00:00:00 2001 From: bhumijgupta Date: Sat, 3 Jul 2021 09:36:30 +0530 Subject: [PATCH] Move kubectl-convert installation info under Optional kubectl configurations and plugins Signed-off-by: bhumijgupta --- .../included/kubectl-convert-overview.md | 9 ++ .../tools/included/kubectl-whats-next.md | 1 - .../docs/tasks/tools/install-kubectl-linux.md | 95 +++++++------ .../docs/tasks/tools/install-kubectl-macos.md | 131 ++++++++++-------- .../tasks/tools/install-kubectl-windows.md | 68 ++++----- 5 files changed, 166 insertions(+), 138 deletions(-) create mode 100644 content/en/docs/tasks/tools/included/kubectl-convert-overview.md diff --git a/content/en/docs/tasks/tools/included/kubectl-convert-overview.md b/content/en/docs/tasks/tools/included/kubectl-convert-overview.md new file mode 100644 index 0000000000..7490fc9832 --- /dev/null +++ b/content/en/docs/tasks/tools/included/kubectl-convert-overview.md @@ -0,0 +1,9 @@ +--- +title: "kubectl-convert overview" +description: "What is kubectl-convert plugin?" +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. +For more info, visit [migrate to non deprecated apis](/docs/reference/using-api/deprecation-guide/#migrate-to-non-deprecated-apis) \ No newline at end of file diff --git a/content/en/docs/tasks/tools/included/kubectl-whats-next.md b/content/en/docs/tasks/tools/included/kubectl-whats-next.md index c5d6839617..4b0da49bbc 100644 --- a/content/en/docs/tasks/tools/included/kubectl-whats-next.md +++ b/content/en/docs/tasks/tools/included/kubectl-whats-next.md @@ -4,7 +4,6 @@ description: "What's next after installing kubectl." headless: true --- -* [What is kubectl-convert](/docs/reference/using-api/deprecation-guide/#migrate-to-non-deprecated-apis) * [Install Minikube](https://minikube.sigs.k8s.io/docs/start/) * See the [getting started guides](/docs/setup/) for more about creating clusters. * [Learn how to launch and expose your application.](/docs/tasks/access-application-cluster/service-access-application-cluster/) diff --git a/content/en/docs/tasks/tools/install-kubectl-linux.md b/content/en/docs/tasks/tools/install-kubectl-linux.md index ff8be80f19..f771b9cb0c 100644 --- a/content/en/docs/tasks/tools/install-kubectl-linux.md +++ b/content/en/docs/tasks/tools/install-kubectl-linux.md @@ -41,13 +41,7 @@ For example, to download version {{< param "fullversion" >}} on Linux, type: ``` {{< /note >}} - Download kubectl-convert (optional) - - ```bash - curl -LO https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl-convert - ``` - -1. Validate the kubectl binary (optional) +1. Validate the binary (optional) Download the kubectl checksum file: @@ -78,49 +72,12 @@ For example, to download version {{< param "fullversion" >}} on Linux, type: Download the same version of the binary and checksum. {{< /note >}} -1. Validate the kubectl-convert binary (optional) - - Download the kubectl-convert checksum file: - - ```bash - curl -LO "https://dl.k8s.io/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl-convert.sha256" - ``` - - Validate the kubectl-convert binary against the checksum file: - - ```bash - echo "$(}} - Download the same version of the binary and checksum. - {{< /note >}} - 1. Install kubectl ```bash sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` - Install kubectl-convert (optional) - - ```bash - sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert - ``` - {{< note >}} If you do not have root access on the target system, you can still install kubectl to the `~/.local/bin` directory: @@ -214,7 +171,7 @@ kubectl version --client {{< include "included/verify-kubectl.md" >}} -## Optional kubectl configurations +## Optional kubectl configurations and plugins ### Enable shell autocompletion @@ -227,6 +184,54 @@ 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 + +{{< include "included/kubectl-convert-overview.md" >}} + +1. Download the latest release with the command: + + ```bash + curl -LO https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl-convert + ``` + +1. Validate the binary (optional) + + Download the kubectl-convert checksum file: + + ```bash + curl -LO "https://dl.k8s.io/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl-convert.sha256" + ``` + + Validate the kubectl-convert binary against the checksum file: + + ```bash + echo "$(}} + Download the same version of the binary and checksum. + {{< /note >}} + +1. Install kubectl-convert + + ```bash + sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert + ``` + + ## {{% heading "whatsnext" %}} {{< include "included/kubectl-whats-next.md" >}} diff --git a/content/en/docs/tasks/tools/install-kubectl-macos.md b/content/en/docs/tasks/tools/install-kubectl-macos.md index b3231dc36f..fed72a6dbd 100644 --- a/content/en/docs/tasks/tools/install-kubectl-macos.md +++ b/content/en/docs/tasks/tools/install-kubectl-macos.md @@ -36,16 +36,6 @@ The following methods exist for installing kubectl on macOS: {{< /tab >}} {{< /tabs >}} - Download kubectl-convert (optional) - {{< tabs name="download_binary_macos" >}} - {{< tab name="Intel" codelang="bash" >}} - curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert" - {{< /tab >}} - {{< tab name="Apple Silicon" codelang="bash" >}} - curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert" - {{< /tab >}} - {{< /tabs >}} - {{< note >}} To download a specific version, replace the `$(curl -L -s https://dl.k8s.io/release/stable.txt)` portion of the command with the specific version. @@ -63,7 +53,7 @@ The following methods exist for installing kubectl on macOS: {{< /note >}} -1. Validate the kubectl binary (optional) +1. Validate the binary (optional) Download the kubectl checksum file: @@ -99,54 +89,12 @@ The following methods exist for installing kubectl on macOS: Download the same version of the binary and checksum. {{< /note >}} -1. Validate the kubectl-convert binary (optional) - - Download the kubectl checksum file: - - {{< tabs name="download_checksum_macos" >}} - {{< tab name="Intel" codelang="bash" >}} - curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert.sha256" - {{< /tab >}} - {{< tab name="Apple Silicon" codelang="bash" >}} - curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert.sha256" - {{< /tab >}} - {{< /tabs >}} - - Validate the kubectl binary against the checksum file: - - ```bash - echo "$(}} - Download the same version of the binary and checksum. - {{< /note >}} - 1. Make the kubectl binary executable. ```bash chmod +x ./kubectl ``` - Make kubectl-convert binary executable (optional). - - ```bash - chmod +x ./kubectl-convert - ``` - 1. Move the kubectl binary to a file location on your system `PATH`. ```bash @@ -154,13 +102,6 @@ The following methods exist for installing kubectl on macOS: sudo chown root: /usr/local/bin/kubectl ``` - Move the kubectl-convert binary to your system `PATH` (optional) - - ```bash - sudo mv ./kubectl /usr/local/bin/kubectl-convert - sudo chown root: /usr/local/bin/kubectl-convert - ``` - {{< note >}} Make sure `/usr/local/bin` is in your PATH environment variable. {{< /note >}} @@ -214,7 +155,7 @@ If you are on macOS and using [Macports](https://macports.org/) package manager, {{< include "included/verify-kubectl.md" >}} -## Optional kubectl configurations +## Optional kubectl configurations and plugins ### Enable shell autocompletion @@ -227,6 +168,74 @@ 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 + +{{< include "included/kubectl-convert-overview.md" >}} + +1. Download the latest release with the command: + + {{< tabs name="download_convert_binary_macos" >}} + {{< tab name="Intel" codelang="bash" >}} + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert" + {{< /tab >}} + {{< tab name="Apple Silicon" codelang="bash" >}} + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert" + {{< /tab >}} + {{< /tabs >}} + +1. Validate the binary (optional) + + Download the kubectl checksum file: + + {{< tabs name="download_convert_checksum_macos" >}} + {{< tab name="Intel" codelang="bash" >}} + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert.sha256" + {{< /tab >}} + {{< tab name="Apple Silicon" codelang="bash" >}} + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert.sha256" + {{< /tab >}} + {{< /tabs >}} + + Validate the kubectl-convert binary against the checksum file: + + ```bash + echo "$(}} + Download the same version of the binary and checksum. + {{< /note >}} + +1. Make kubectl-convert binary executable + + ```bash + chmod +x ./kubectl-convert + ``` + +1. Move the kubectl-convert binary to a file location on your system `PATH`. + + ```bash + sudo mv ./kubectl /usr/local/bin/kubectl-convert + sudo chown root: /usr/local/bin/kubectl-convert + ``` + + {{< note >}} + Make sure `/usr/local/bin` is in your PATH environment variable. + {{< /note >}} + ## {{% heading "whatsnext" %}} {{< include "included/kubectl-whats-next.md" >}} diff --git a/content/en/docs/tasks/tools/install-kubectl-windows.md b/content/en/docs/tasks/tools/install-kubectl-windows.md index a02c861bfd..956eb50a61 100644 --- a/content/en/docs/tasks/tools/install-kubectl-windows.md +++ b/content/en/docs/tasks/tools/install-kubectl-windows.md @@ -33,17 +33,11 @@ The following methods exist for installing kubectl on Windows: curl -LO https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/windows/amd64/kubectl.exe ``` - Download kubectl-convert binary (optional) - - ```powershell - curl -LO https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/windows/amd64/kubectl-convert.exe - ``` - {{< note >}} To find out the latest stable version (for example, for scripting), take a look at [https://dl.k8s.io/release/stable.txt](https://dl.k8s.io/release/stable.txt). {{< /note >}} -1. Validate the kubectl binary (optional) +1. Validate the binary (optional) Download the kubectl checksum file: @@ -66,29 +60,6 @@ The following methods exist for installing kubectl on Windows: $($(CertUtil -hashfile .\kubectl.exe SHA256)[1] -replace " ", "") -eq $(type .\kubectl.exe.sha256) ``` -1. Validate the kubectl-convert binary (optional) - - Download the kubectl-convert checksum file: - - ```powershell - curl -LO https://dl.k8s.io/{{< param "fullversion" >}}/bin/windows/amd64/kubectl-convert.exe.sha256 - ``` - - Validate the kubectl-convert binary against the checksum file: - - - Using Command Prompt to manually compare `CertUtil`'s output to the checksum file downloaded: - - ```cmd - CertUtil -hashfile kubectl-convert.exe SHA256 - type kubectl-convert.exe.sha256 - ``` - - - Using PowerShell to automate the verification using the `-eq` operator to get a `True` or `False` result: - - ```powershell - $($(CertUtil -hashfile .\kubectl-convert.exe SHA256)[1] -replace " ", "") -eq $(type .\kubectl-convert.exe.sha256) - ``` - 1. Add the binary in to your `PATH`. 1. Test to ensure the version of `kubectl` is the same as downloaded: @@ -159,7 +130,7 @@ Edit the config file with a text editor of your choice, such as Notepad. {{< include "included/verify-kubectl.md" >}} -## Optional kubectl configurations +## Optional kubectl configurations and plugins ### Enable shell autocompletion @@ -169,6 +140,41 @@ 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 + +{{< include "included/kubectl-convert-overview.md" >}} + +1. Download the latest release with the command: + + ```powershell + curl -LO https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/windows/amd64/kubectl-convert.exe + ``` + +1. Validate the binary (optional) + + Download the kubectl-convert checksum file: + + ```powershell + curl -LO https://dl.k8s.io/{{< param "fullversion" >}}/bin/windows/amd64/kubectl-convert.exe.sha256 + ``` + + Validate the kubectl-convert binary against the checksum file: + + - Using Command Prompt to manually compare `CertUtil`'s output to the checksum file downloaded: + + ```cmd + CertUtil -hashfile kubectl-convert.exe SHA256 + type kubectl-convert.exe.sha256 + ``` + + - Using PowerShell to automate the verification using the `-eq` operator to get a `True` or `False` result: + + ```powershell + $($(CertUtil -hashfile .\kubectl-convert.exe SHA256)[1] -replace " ", "") -eq $(type .\kubectl-convert.exe.sha256) + ``` + +1. Add the binary in to your `PATH`. + ## {{% heading "whatsnext" %}} {{< include "included/kubectl-whats-next.md" >}}