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

Enhance README.md with commands for creating resources #26

Open
robmorgan opened this issue Feb 7, 2019 · 1 comment
Open

Enhance README.md with commands for creating resources #26

robmorgan opened this issue Feb 7, 2019 · 1 comment
Labels
good first issue Good for newcomers

Comments

@robmorgan
Copy link
Member

Hi Yori,

I was trying to use Kubergrunt to deploy Helm to a GKE cluster. Would it make sense to add a few lines to the README.md file to illustrate how to create a dedicated ServiceAccount and namespace for Helm.

e.g:

❯ kubectl create namespace tiller-world
namespace "tiller-world" created

❯ kubectl create serviceaccount tiller --namespace tiller-world
serviceaccount "tiller" created

That way the user can get started quicker and avoid errors like: ERROR: namespaces "tiller-world" not found if they then run:

kubergrunt helm deploy \
    --tiller-namespace tiller-world \
    --resource-namespace dev \
    --service-account tiller \
    --tls-common-name tiller \
    --tls-org Gruntwork \
    --tls-org-unit IT \
    --tls-city Phoenix \
    --tls-state AZ \
    --tls-country US \
    --rbac-group admin \
    --client-tls-common-name admin \
    --client-tls-org Gruntwork

It also removes the ambiguity from the following statement:

Note: This command does not create Namespaces or ServiceAccounts, delegating that responsibility to other systems.

@robmorgan robmorgan changed the title Enhance README.md with Enhance README.md with commands for creating resources Feb 7, 2019
@yorinasub17
Copy link
Contributor

Makes sense! It's on my radar, but I haven't gotten around to it. There are a few reasons for deprioritizing:

  • I wasn't sure what are the issues we will run into on EKS and GKE. I wanted to make sure we had examples that worked.
  • The tricky bit is making namespaces and service accounts that fit the security model. This includes creating the RBAC roles and bindings. It is probably useful to have several scenarios as well (e.g if they want a clusterwide Tiller but kubergrunt TLS management).
  • Most of our customers are likely to use the Terraform wrappers we provide in GKE, EKS, and terraform-kubernetes-helm, which means this won't be an issue.

I think once all the code is working in the GKE and EKS modules, we can come back and revisit the dedicated docs in kubergrunt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants