-
Notifications
You must be signed in to change notification settings - Fork 288
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
Add apiServerExtraArgs as optional configuration to docs #7853
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7853 +/- ##
=======================================
Coverage 73.47% 73.47%
=======================================
Files 577 577
Lines 35745 35745
=======================================
Hits 26262 26262
Misses 7826 7826
Partials 1657 1657 ☔ View full report in Codecov by Sentry. |
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I have a few comments on the user docs.
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
service-account-issuer: "https://issuer-url" | ||
service-account-jwks-uri: "https://issuer-url/openid/v1/jwks" | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to show a example here that reflects a real-world customer use case. If this example is useful, I would suggest adding a couple of paragraphs, describing what the example achieves and why someone would do it. In particular, the OIDC use that you describe in the design doc might be a good thing to explain.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the template with other API Server options and described some example usecase below
c03dac6
to
9f3df9a
Compare
|:--------------:|:-------:|:----------:|:-------:|:----------:|:----:| | ||
| **Supported?** | ✓ | ✓ | ✓ | ✓ | ✓ | | ||
|
||
In order to configure a cluster with API Server extra args, you need to configure your cluster by updating the cluster configuration file to include the details below. The feature flag `API_SERVER_EXTRA_ARGS_ENABLED=true` needs to be set. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where do customers set API_SERVER_EXTRA_ARGS_ENABLED=true
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They set it as an env variable. Updated the statement
|
||
The above example configures the `disable-admission-plugins` and `enable-admission-plugins` options of the API Server to enable additional admission plugins or disable some of the default ones. You can configure any of the API Server options using the above template. | ||
|
||
### controlPlaneConfiguration.apiServerExtraArgs (required) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a required field?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's optional
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs/getting-started/optional/api-server-extra-args.md
Outdated
Show resolved
Hide resolved
spec: | ||
... | ||
controlPlaneConfiguration: | ||
apiServerExtraArgs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can these be updated for existing clusters on all of the providers? (ie. by running an eksctl anywhere upgrade
and by applying new spec with K8s API-compatible tooling such as GitOps or kubectl)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
@@ -0,0 +1,36 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to update each of these pages to say that these additional settings can be configured
https://anywhere.eks.amazonaws.com/docs/getting-started/vsphere/vsphere-spec/
https://anywhere.eks.amazonaws.com/docs/getting-started/baremetal/bare-spec/
https://anywhere.eks.amazonaws.com/docs/getting-started/snow/snow-spec/
https://anywhere.eks.amazonaws.com/docs/getting-started/cloudstack/cloud-spec/
https://anywhere.eks.amazonaws.com/docs/getting-started/nutanix/nutanix-spec/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Issue #, if available:
#2091
Description of changes:
controlPlaneConfiguration.apiServerExtraArgs
as an optional configuration to the docsBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.