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

Add apiServerExtraArgs as optional configuration to docs #7853

Merged
merged 2 commits into from
Apr 3, 2024

Conversation

sp1999
Copy link
Member

@sp1999 sp1999 commented Mar 15, 2024

Issue #, if available:
#2091

Description of changes:

  • Added controlPlaneConfiguration.apiServerExtraArgs as an optional configuration to the docs
  • Mini design doc for configuring api server extra args

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@eks-distro-bot eks-distro-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 15, 2024
Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.47%. Comparing base (0cfc4f0) to head (602f615).
Report is 7 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@eks-distro-bot eks-distro-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 18, 2024
designs/api-server-extra-args.md Outdated Show resolved Hide resolved
designs/api-server-extra-args.md Outdated Show resolved Hide resolved
Copy link
Member

@chrisnegus chrisnegus left a 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.

service-account-issuer: "https://issuer-url"
service-account-jwks-uri: "https://issuer-url/openid/v1/jwks"
```

Copy link
Member

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.

Copy link
Member Author

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

@sp1999 sp1999 force-pushed the update-docs branch 2 times, most recently from c03dac6 to 9f3df9a Compare March 28, 2024 21:46
|:--------------:|:-------:|:----------:|:-------:|:----------:|:----:|
| **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.
Copy link
Member

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 ?

Copy link
Member Author

@sp1999 sp1999 Mar 30, 2024

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)
Copy link
Member

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?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's optional

spec:
...
controlPlaneConfiguration:
apiServerExtraArgs:
Copy link
Member

@csplinter csplinter Mar 29, 2024

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)

Copy link
Member Author

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 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated

@chrisnegus
Copy link
Member

/lgtm

@eks-distro-bot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@eks-distro-bot eks-distro-bot merged commit 1a9c2d8 into aws:main Apr 3, 2024
8 checks passed
@sp1999 sp1999 deleted the update-docs branch April 3, 2024 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/docs Documentation documentation lgtm size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants