Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for configuring the provider #1132

Merged
merged 1 commit into from
Mar 9, 2021
Merged

Conversation

jrhouston
Copy link
Collaborator

Description

This PR improves the docs for configuring the provider

@Nuru
Copy link

Nuru commented Feb 10, 2021

@jrhouston There is another way to configure the provider, specifically for AWS EKS clusters, which is with data sources:

data "aws_eks_cluster" "eks" {
  name = var.eks_cluster_id
}

data "aws_eks_cluster_auth" "eks" {
  name = var.eks_cluster_id
}

provider "kubernetes" {
  token                  = data.aws_eks_cluster_auth.eks.token)
  host                   = data.aws_eks_cluster.eks.endpoint)
  cluster_ca_certificate = base64decode(data.aws_eks_cluster.eks.certificate_authority.0.data))
}

This should be used instead of the "Exec-based credential plugins" style which is problematic in that it depends on the presence of the aws command.

Please also fix the getting started guide website/docs/guides/getting-started.html.markdown lines 115-119.

@jrhouston jrhouston closed this Mar 9, 2021
@jrhouston jrhouston force-pushed the update-config-docs branch from e58cc08 to 7289d86 Compare March 9, 2021 16:36
@ghost ghost added size/XS and removed size/M labels Mar 9, 2021
@jrhouston jrhouston reopened this Mar 9, 2021
@ghost ghost added size/M and removed size/XS labels Mar 9, 2021
@jrhouston jrhouston merged commit 353b94a into master Mar 9, 2021
@jrhouston jrhouston deleted the update-config-docs branch March 9, 2021 16:41
@ghost ghost added size/XS and removed size/M labels Mar 9, 2021
@dak1n1
Copy link
Contributor

dak1n1 commented Mar 9, 2021

@jrhouston FYI the website-lint is failing.

(or default) location. Depending on whether you have a current context set
this _may_ require `config_context_auth_info` and/or `config_context_cluster`
and/or `config_context`.
For a full list of supported provider authentication arguments and their corresponding environment variables, see the [argument reference](#argument-reference) below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, this section makes it a bit more clear. I like the addition of the links.

@ghost
Copy link

ghost commented Apr 9, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Apr 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants