From 73d6e2ce875eb0fafbe61421afe413df729d5617 Mon Sep 17 00:00:00 2001 From: Alexander Chernov Date: Mon, 23 May 2022 09:19:28 +0100 Subject: [PATCH] chore: docs changes --- .run/Template Go Test.run.xml | 4 ++-- README.md | 36 +++++++----------------------- docs/index.md | 22 +----------------- docs/resources/kubectl_manifest.md | 2 +- templates/index.md | 2 +- 5 files changed, 13 insertions(+), 53 deletions(-) diff --git a/.run/Template Go Test.run.xml b/.run/Template Go Test.run.xml index 7e1a2acf..8bd97a59 100644 --- a/.run/Template Go Test.run.xml +++ b/.run/Template Go Test.run.xml @@ -7,10 +7,10 @@ - + - \ No newline at end of file + diff --git a/README.md b/README.md index 30d4e658..9a2ebd91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kubernetes "kubectl" Provider -![Build Status](https://github.com/gavinbunney/terraform-provider-kubectl/actions/workflows/build.yml/badge.svg) [![user guide](https://img.shields.io/badge/-user%20guide-blue)](https://registry.terraform.io/providers/gavinbunney/kubectl) +![Build Status](https://github.com/alekc/terraform-provider-kubectl/actions/workflows/build.yml/badge.svg) [![user guide](https://img.shields.io/badge/-user%20guide-blue)](https://registry.terraform.io/providers/alekc/kubectl) This provider is the best way of managing Kubernetes resources in Terraform, by allowing you to use the thing Kubernetes loves best - yaml! @@ -25,36 +25,16 @@ terraform { required_providers { kubectl = { - source = "gavinbunney/kubectl" - version = ">= 1.7.0" + source = "alekc/kubectl" + version = ">= 2.0.0" } } } ``` -### Terraform 0.12 - -#### Install latest version - -The following one-liner script will fetch the latest provider version and download it to your `~/.terraform.d/plugins` directory. - -```bash -$ mkdir -p ~/.terraform.d/plugins && \ - curl -Ls https://api.github.com/repos/gavinbunney/terraform-provider-kubectl/releases/latest \ - | jq -r ".assets[] | select(.browser_download_url | contains(\"$(uname -s | tr A-Z a-z)\")) | select(.browser_download_url | contains(\"amd64\")) | .browser_download_url" \ - | xargs -n 1 curl -Lo ~/.terraform.d/plugins/terraform-provider-kubectl.zip && \ - pushd ~/.terraform.d/plugins/ && \ - unzip ~/.terraform.d/plugins/terraform-provider-kubectl.zip -d terraform-provider-kubectl-tmp && \ - mv terraform-provider-kubectl-tmp/terraform-provider-kubectl* . && \ - chmod +x terraform-provider-kubectl* && \ - rm -rf terraform-provider-kubectl-tmp && \ - rm -rf terraform-provider-kubectl.zip && \ - popd -``` - #### Install manually -If you don't want to use the one-liner above, you can download a binary for your system from the [release page](https://github.com/gavinbunney/terraform-provider-kubectl/releases), +If you don't want to use the one-liner above, you can download a binary for your system from the [release page](https://github.com/alekc/terraform-provider-kubectl/releases), then either place it at the root of your Terraform folder or in the Terraform plugin folder on your system. ## Quick Start @@ -96,7 +76,7 @@ YAML } ``` -See [User Guide](https://registry.terraform.io/providers/gavinbunney/kubectl/latest) for details on installation and all the provided data and resource types. +See [User Guide](https://registry.terraform.io/providers/alekc/kubectl/latest) for details on installation and all the provided data and resource types. --- @@ -110,13 +90,13 @@ To compile the provider, run `make build`. This will build the provider and put ### Building The Provider ```sh -$ go get github.com/gavinbunney/terraform-provider-kubectl +$ go get github.com/alekc/terraform-provider-kubectl ``` Enter the provider directory and build the provider ```sh -$ cd $GOPATH/src/github.com/gavinbunney/terraform-provider-kubectl +$ cd $GOPATH/src/github.com/alekc/terraform-provider-kubectl $ make build ``` @@ -146,5 +126,5 @@ $ make testacc ### Inspiration -Thanks to the original provider by [nabancard and lawrecncegripper](https://github.com/nabancard/terraform-provider-kubernetes-yaml) on the original base of this provider. +Thanks to the original provider by [gavinbunney](https://github.com/gavinbunney/terraform-provider-kubectl) on the original base of this provider. Current version has been forked from 1.14 diff --git a/docs/index.md b/docs/index.md index f1ef5cc9..bc492044 100755 --- a/docs/index.md +++ b/docs/index.md @@ -29,29 +29,9 @@ terraform { } ``` -### Terraform 0.12 - -#### Install latest version - -The following one-liner script will fetch the latest provider version and download it to your `~/.terraform.d/plugins` directory. - -```bash -$ mkdir -p ~/.terraform.d/plugins && \ - curl -Ls https://api.github.com/repos/gavinbunney/terraform-provider-kubectl/releases/latest \ - | jq -r ".assets[] | select(.browser_download_url | contains(\"$(uname -s | tr A-Z a-z)\")) | select(.browser_download_url | contains(\"amd64\")) | .browser_download_url" \ - | xargs -n 1 curl -Lo ~/.terraform.d/plugins/terraform-provider-kubectl.zip && \ - pushd ~/.terraform.d/plugins/ && \ - unzip ~/.terraform.d/plugins/terraform-provider-kubectl.zip -d terraform-provider-kubectl-tmp && \ - mv terraform-provider-kubectl-tmp/terraform-provider-kubectl* . && \ - chmod +x terraform-provider-kubectl* && \ - rm -rf terraform-provider-kubectl-tmp && \ - rm -rf terraform-provider-kubectl.zip && \ - popd -``` - #### Install manually -If you don't want to use the one-liner above, you can download a binary for your system from the [release page](https://github.com/gavinbunney/terraform-provider-kubectl/releases), +If you don't want to use the one-liner above, you can download a binary for your system from the [release page](https://github.com/alekc/terraform-provider-kubectl/releases), then either place it at the root of your Terraform folder or in the Terraform plugin folder on your system. ## Configuration diff --git a/docs/resources/kubectl_manifest.md b/docs/resources/kubectl_manifest.md index f9786391..98b0330b 100644 --- a/docs/resources/kubectl_manifest.md +++ b/docs/resources/kubectl_manifest.md @@ -7,7 +7,7 @@ This resource handles creation, deletion and even updating your kubernetes resou Behind the scenes, this provider uses the same capability as the `kubectl apply` command, that is, you can update the YAML inline and the resource will be updated in place in kubernetes. > **TIP:** This resource only supports a single yaml resource. If you have a list of documents in your yaml file, -> use the [kubectl_path_documents](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/kubectl_path_documents) data source to split the files into individual resources. +> use the [kubectl_path_documents](https://registry.terraform.io/providers/alekc/kubectl/latest/docs/data-sources/kubectl_path_documents) data source to split the files into individual resources. ## Example Usage diff --git a/templates/index.md b/templates/index.md index 9da1f5e3..3eaf68e5 100644 --- a/templates/index.md +++ b/templates/index.md @@ -7,7 +7,7 @@ This resource handles creation, deletion and even updating your kubernetes resou Behind the scenes, this provider uses the same capability as the `kubectl apply` command, that is, you can update the YAML inline and the resource will be updated in place in kubernetes. > **TIP:** This resource only supports a single yaml resource. If you have a list of documents in your yaml file, -> use the [kubectl_path_documents](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/kubectl_path_documents) data source to split the files into individual resources. +> use the [kubectl_path_documents](https://registry.terraform.io/providers/alekc/kubectl/latest/docs/data-sources/kubectl_path_documents) data source to split the files into individual resources. ## Example Usage