Skip to content

Commit

Permalink
chore: docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
alekc committed May 23, 2022
1 parent bccfa81 commit 73d6e2c
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 53 deletions.
4 changes: 2 additions & 2 deletions .run/Template Go Test.run.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<env name="KUBECONFIG" value="$PROJECT_DIR$/scripts/kubeconfig.yaml" />
</envs>
<kind value="DIRECTORY" />
<package value="github.com/gavinbunney/terraform-provider-kubectl" />
<package value="github.com/alekc/terraform-provider-kubectl" />
<directory value="$PROJECT_DIR$" />
<filePath value="$PROJECT_DIR$" />
<framework value="gotest" />
<method v="2" />
</configuration>
</component>
</component>
36 changes: 8 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -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!
Expand All @@ -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
Expand Down Expand Up @@ -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.

---

Expand All @@ -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
```

Expand Down Expand Up @@ -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

22 changes: 1 addition & 21 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/kubectl_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 73d6e2c

Please sign in to comment.