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

revise provisioner api description #1419

Merged
merged 3 commits into from
Mar 1, 2022
Merged

Conversation

geoffcline
Copy link
Contributor

1. Issue, if available:
#1102

2. Description of changes:
update description of Provisioner API

add kubelet to example
add further desc of ttl values

3. How was this change tested?
netlify preview

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.

@geoffcline geoffcline added the documentation Improvements or additions to documentation label Feb 25, 2022
@geoffcline geoffcline self-assigned this Feb 25, 2022
@netlify
Copy link

netlify bot commented Feb 25, 2022

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

🔨 Explore the source changes: f2f882c

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

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

@geoffcline geoffcline marked this pull request as draft February 25, 2022 21:48
website/content/en/preview/provisioner.md Show resolved Hide resolved

### spec.ttlSecondsUntilExpired

Setting a value here enables node expiry. After nodes reach the defined age in seconds, they will be deleted, even if in use. This enables nodes to effectively be periodically "upgraded" by replacing them with newly provisioned instances. This functionality may be called "repaving" or "rehydrating".
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we delete the last sentence about repaving and rehydrating ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm keeping this in because the PM/DA team did get an explicit question about "repaving" from a customer.

Copy link
Contributor

@ellistarn ellistarn Feb 25, 2022

Choose a reason for hiding this comment

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

Agree with Brandon. This isn't a term of art, even if some users use it. We should avoid proliferating nonstandard terms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's commonly used in the financial industry. The karpenter docs should, where appropriate, use specialized or niche terminology if it helps customers discover how karpenter can help them.

website/content/en/preview/provisioner.md Outdated Show resolved Hide resolved
website/content/en/preview/provisioner.md Outdated Show resolved Hide resolved
website/content/en/preview/provisioner.md Outdated Show resolved Hide resolved
website/content/en/preview/provisioner.md Outdated Show resolved Hide resolved
@ellistarn ellistarn merged commit 0dff9db into aws:main Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants