Skip to content

Commit

Permalink
Added clarifiction in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wonko authored and alekc committed Dec 15, 2023
1 parent c8fdb35 commit f8c80d6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ terraform {
}
```

#### Install manually
### 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/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.
Expand Down Expand Up @@ -77,6 +77,18 @@ YAML

See [User Guide](https://registry.terraform.io/providers/alekc/kubectl/latest) for details on installation and all the provided data and resource types.

## Changing providers for existing resources

When you used another fork of this provider in the past, it is possible to change the provider on all existing resources within your state. A common use-case of this is to switch from `gavinbunney/kubectl` towards this fork.

Change the `required_providers` sections in your main code and in all used modules to reflect the usage of `alekc/kubectl` as shown above. Once this is done, use the `state replace-provider` to make the switch on all existing resources in your state.

```
terraform state replace-provider gavinbunney/kubectl alekc/kubectl
```

You should then `terraform init`, and the next terraform actions will use this provider.

---

## Development Guide
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/kubectl_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ Optional:
* `namespace` - Extracted object namespace from `yaml_body`.
* `uid` - Kubernetes unique identifier from last run.
* `live_uid` - Current uuid from Kubernetes.
* `yaml_incluster` - Current yaml within Kubernetes.
* `live_manifest_incluster` - Current manifest within Kubernetes.
* `yaml_incluster` - A fingerprint of the current yaml within Kubernetes.
* `live_manifest_incluster` - A fingerprint of the current manifest within Kubernetes.

## Sensitive Fields

Expand Down

0 comments on commit f8c80d6

Please sign in to comment.