Skip to content

docs(readme): clarify "Run the server" setup steps - #986

Merged
k8s-ci-robot merged 1 commit into
kubernetes-sigs:masterfrom
ShiriNmi1520:master
Feb 16, 2026
Merged

docs(readme): clarify "Run the server" setup steps#986
k8s-ci-robot merged 1 commit into
kubernetes-sigs:masterfrom
ShiriNmi1520:master

Conversation

@ShiriNmi1520

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
This PR improves the README section 2. Run the server to make the setup actionable for users.

The previous text pointed to deploy/example.yaml but did not clearly describe what must be edited before applying it or how to verify deployment success. This caused confusion during initial setup.

This change adds:

  • required pre-apply edits (replace placeholder IAM ARNs, set a unique clusterID, verify control-plane scheduling rules)
  • concrete deploy/verification commands:
    • kubectl apply -f deploy/example.yaml
    • kubectl -n kube-system rollout status daemonset/aws-iam-authenticator
    • kubectl -n kube-system get pods -l k8s-app=aws-iam-authenticator
  • clarification about where webhook kubeconfig is generated (/etc/kubernetes/aws-iam-authenticator/kubeconfig.yaml or the path configured via --generate-kubeconfig)

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #270

Signed-off-by: Ivan <s20026352@gmail.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 14, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

Welcome @ShiriNmi1520!

It looks like this is your first PR to kubernetes-sigs/aws-iam-authenticator πŸŽ‰. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-iam-authenticator has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. πŸ˜ƒ

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 14, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

Hi @ShiriNmi1520. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 14, 2026
@kmala

kmala commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

/ok-to-test
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 16, 2026
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 16, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kmala, ShiriNmi1520

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 16, 2026
@k8s-ci-robot
k8s-ci-robot merged commit 2a6d62d into kubernetes-sigs:master Feb 16, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc on installing aws-iam-authenticator

3 participants