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

docs: Add section on helpful tools #497

Merged
merged 1 commit into from
Jul 7, 2021
Merged

Conversation

yuvipanda
Copy link
Member

This document can collect tools that are required to work
with the infrastructure deployed from this repo, and any
additional tips / resources that are specifically useful
to us. The hope is that this list grows over time as we gain
more experience.

Ref #476

This document can collect tools that are required to work
with the infrastructure deployed from this repo, and any
additional tips / resources that are specifically useful
to us. The hope is that this list grows over time as we gain
more experience.

Ref 2i2c-org#476

#### Tips

- Consider aliasing it to `k`, as you might be typing it a lot!
Copy link
Contributor

Choose a reason for hiding this comment

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

That is a good idea although I would keep kubectl in our docs when we showcase commands...

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I agree!

Copy link
Contributor

@damianavila damianavila left a comment

Choose a reason for hiding this comment

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

This is a great start!!
And I agree this is something to iterate on... so 👍 on merging early than later!

Copy link
Member

@sgibson91 sgibson91 left a comment

Choose a reason for hiding this comment

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

Love it! 💖 Also agree with @damianavila that this can be iterated upon and I think it's fine to merge as is and open new PRs as folk discover new things :)

@yuvipanda yuvipanda merged commit 861b55c into 2i2c-org:master Jul 7, 2021
@yuvipanda
Copy link
Member Author

Pinging @consideRatio who probably knows a bunch of useful tools and tricks

@consideRatio
Copy link
Member

Some tricks using the helm cli are...

  • the --repo flag is nice, helps you do a single command to do something with a chart without using helm repo add etc. first.
    helm template --repo https://jupyterhub.github.io/helm-chart/ jupyterhub
  • the --show-only flag is nice, helps you review a specific helm chart template instead of the entire chart.
    # example on how to access a specific template
    helm template --repo https://jupyterhub.github.io/helm-chart/ jupyterhub \
        --show-only templates/hub/deployment.yaml
    
    # example on how to access a specific template from a subchart
    # note we need to specify version, as there is no non-pre-release
    # version available
    helm template --repo https://jupyterhub.github.io/helm-chart/ binderhub \
        --version=0.2.0-n611.he777436 \
        --set jupyterhub.hub.services.binder.apiToken=asd \
        --show-only charts/jupyterhub/templates/hub/deployment.yaml
  • the --validate flag with helm template will not only render the templates, but also send --dry-run requests to the configured k8s api-server to see if the k8s api-server would accept those rendered manifests. This is useful as helm template would render almost anything, even if its not valid k8s resources.

@damianavila
Copy link
Contributor

Some tricks using the helm cli are...

A PR adding these tricks is more than welcome 😜 !

@consideRatio
Copy link
Member

Thanks for the nudge @damianavila.

I'm relieved to see markdown based documentation instead of rST 😌 - I'm totally sold on the use of MyST for project documentation atm.

#499 opened

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

Successfully merging this pull request may close these issues.

4 participants