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

Separate the command line commands in the getting started guide into independent bash files #1412

Merged
merged 5 commits into from
Feb 25, 2022
Merged

Separate the command line commands in the getting started guide into independent bash files #1412

merged 5 commits into from
Feb 25, 2022

Conversation

spring1843
Copy link
Contributor

1. Issue, if available:
Relates to:
#1351
#1358
#1344

2. Description of changes:

Separates the CLI parts of the getting started guide into independent bash files and adds a run-all-steps.sh file that sequentially runs all those files.

Some of the benefits of this change:

  • User can just run one script to run the entire installation process, instead of copy and pasting multiple steps from browser to command line
  • We can detect bad commands (e.g. typos)
  • We can detect incompatibilities between Karpenter and a few other tools/things (e.g. eksctl, aws-cli, helm charts)
  • Allows us to automate this process prior to a release in future, giving us a formal proof that Karpenter can be installed

The appearance of the docs will remain unchanged after this change with the exception of introducing a new environment variable (KARPENTER_VERSION).

3. How was this change tested?

4. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

… bash files

and adds a run-all-steps.sh file that sequentially runs all those files.
By running the run-all-steps.sh we can verify that all steps work
@netlify
Copy link

netlify bot commented Feb 24, 2022

✔️ Deploy Preview for karpenter-docs-prod ready!

🔨 Explore the source changes: 7bc8090

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/62183a19304db900084c452f

😎 Browse the preview: https://deploy-preview-1412--karpenter-docs-prod.netlify.app

Copy link
Contributor

@bwagner5 bwagner5 left a comment

Choose a reason for hiding this comment

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

niceeeeeeeeeeeeeeeeeeeeeeeeee!

Copy link
Contributor

@ellistarn ellistarn left a comment

Choose a reason for hiding this comment

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

Really nice work!

Copy link
Contributor

@bwagner5 bwagner5 left a comment

Choose a reason for hiding this comment

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

nice work!

@bwagner5 bwagner5 merged commit 2396c10 into aws:main Feb 25, 2022
@spring1843 spring1843 deleted the separate-start-guide-scripts branch March 25, 2022 18:33
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.

3 participants