kubernetes: Expand example to show best practices for interacting with k8s provider. #564
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
devurandom
reviewed
Jan 28, 2021
examples/kubernetes/README.md
Outdated
Comment on lines
40
to
49
| Optionally, this example can generate a kubeconfig file in the current working | ||
| directory. However, the token in this config will expire. The token can be | ||
| refreshed by running `terraform apply` again and setting `write_kubeconfig` to | ||
| `true`. | ||
|
|
||
| ``` | ||
| terraform apply -var="write_kubeconfig=true" | ||
| export KUBECONFIG=$(terraform output -raw kubeconfig_path | ||
| kubectl get pods -n test | ||
| ``` |
There was a problem hiding this comment.
I use a combination of terraform refresh and terraform output kubeconfig > .../kubeconfig. That seems less intimidating (i.e. potentially destructive) that terraform apply.
There was a problem hiding this comment.
Since this creates a local_file resource, apply is needed to replace the file if new credentials are needed.
Co-authored-by: Dennis Schridde <[email protected]>
scotchneat
approved these changes
Jan 29, 2021
andrewsomething
added a commit
that referenced
this pull request
Apr 26, 2021
…h k8s provider. (#564) * kubernetes: Expand example to show best practices for interacting with k8s provider. * Add README to the kubernetes example. * Update Kubernetes provider interoperability acceptance test for 2.0.x * kubernetes: Update documentation. * Update examples/kubernetes/README.md Co-authored-by: Dennis Schridde <[email protected]> * Update examples/kubernetes/README.md Co-authored-by: Samuel Guyah <[email protected]> * k8s: Replace the interpolation example with one using the data source. * Document using the exec plugin w/ doctl. Co-authored-by: Dennis Schridde <[email protected]> Co-authored-by: Samuel Guyah <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As seen in #562, using interpolation to pass credentials to the Kubernetes provider from other resources can cause some issues due to the order in which Terraform evaluates the provider blocks vs. actual resources. In fact, the Kubernetes provider docs have added a warning to discourage using interpolation to pass credentials:
https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#stacking-with-managed-kubernetes-cluster-resources
This PR expands the Kubernetes example in this repo to be more complete and better adhere to best practices for interacting with the Kubernetes provider. It also adds a notes to the Kubernetes cluster resource docs addressing the issue and linking to that example. Finally, it updates usage of the Kubernetes provider for it 2.0.x release (specifically the removal of the
load_config_fileattribute).Fixes: #562