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: Remove the word "necessary" from optional fields #5659

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

jonathan-innis
Copy link
Contributor

Fixes #N/A

Description

This updates the docs to clarify that only one of spec.role and spec.instanceProfile is needed since the previous wording might have been confusing with respect to this.

How was this change tested?

Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: #
  • No

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

Copy link

netlify bot commented Feb 13, 2024

Deploy Preview for karpenter-docs-prod ready!

Name Link
🔨 Latest commit b7591d6
🔍 Latest deploy log https://app.netlify.com/sites/karpenter-docs-prod/deploys/65cc002a07ce7c0008c59ae5
😎 Deploy Preview https://deploy-preview-5659--karpenter-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@coveralls
Copy link

coveralls commented Feb 13, 2024

Pull Request Test Coverage Report for Build 7894271127

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.514%

Totals Coverage Status
Change from base Build 7893386178: 0.0%
Covered Lines: 5016
Relevant Lines: 6079

💛 - Coveralls

@andrewhibbert
Copy link
Contributor

Would it be possible to clarify this bit:

For private clusters that do not have access to the public internet, using spec.instanceProfile is required. spec.role cannot be used since Karpenter needs to access IAM endpoints to manage a generated instance profile. IAM doesn’t support private endpoints to enable accessing the service without going to the public internet.

If you're in a private cluster with access to internet via NAT gateway, you'll reach IAM over the public internet, so it would be good to know the implications of this in terms of cost, does it contact the endpoint just once to generate the profile or is it a repetitive process?

@jonathan-innis
Copy link
Contributor Author

good to know the implications of this in terms of cost

I'm not sure what you mean in terms of cost. IAM entities don't incur additional cost so I don't think that should be a concern there. In terms of the actual behavior of Karpenter, it is a continuous reconciliation so if you were to delete the instance profile accidentally or remove the role, Karpenter would add it back. You need constant access to IAM if you are using the spec.role field.

@jonathan-innis jonathan-innis merged commit 95f42f1 into aws:main Feb 14, 2024
16 checks passed
@andrewhibbert
Copy link
Contributor

Possibly I'm missing something, if using an instance profile, it wouldn't go over public internet to IAM, whereas with a role it would and do so continuously to reconcile? Sounds like it would cost more

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