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.

Sign up for GitHub

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

Jump to bottom

Correct ECR credential provider example #40841

Merged
merged 1 commit into from
May 19, 2023
Merged

Correct ECR credential provider example #40841

merged 1 commit into from
May 19, 2023

Conversation

cartermckinnon
Copy link
Contributor

The example credential provider config file is misleading in a few ways:

  1. The image pattern for ECR China has the wrong domain name.
  2. The args section implied that get-credentials is used by the ECR credential provider. It isn't.
  3. The name of the credential provider does not match the name of the executable produced from: https://github.com/kubernetes/cloud-provider-aws/tree/master/cmd/ecr-credential-provider

If this example is not intended to be for the ecr-credential-provider implemented in kubernetes/cloud-provider-aws -- the second two points are arguable; but the first is not in my opinion.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 25, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Apr 25, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @cartermckinnon!

It looks like this is your first PR to kubernetes/website 🎉. 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/website 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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 25, 2023
@cartermckinnon cartermckinnon mentioned this pull request Apr 25, 2023
Merged
@dims
Copy link
Member

dims commented Apr 25, 2023

/approve
/lgtm

thanks @cartermckinnon

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 25, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 690d9877f44c38f6e77666ef02b46649ae3a49d0

@cartermckinnon
Copy link
Contributor Author

deploy/netlify timed out after an hour 🤷

/retest

@k8s-ci-robot
Copy link
Contributor

@cartermckinnon: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

deploy/netlify timed out after an hour 🤷

/retest

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/test-infra repository.

sftim
sftim reviewed Apr 27, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks.

I have a question about the region setting.

/sig cloud-provider

content/en/docs/tasks/administer-cluster/kubelet-credential-provider.md Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/kubelet-credential-provider.md
Comment on lines 55 to +57
The configuration file passed into `--image-credential-provider-config` is read by the kubelet to determine which exec plugins
should be invoked for which container images. Here's an example configuration file you may end up using if you are using the
[ECR](https://aws.amazon.com/ecr/)-based plugin:
[ECR-based plugin](https://github.com/kubernetes/cloud-provider-aws/tree/master/cmd/ecr-credential-provider):
Copy link
Contributor

Choose a reason for hiding this comment

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

Even better, if feasible, is to link to the AWS documentation for configuring this.

Do we know if there's anything to link to?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The mkdocs don't have anything useful: https://cloud-provider-aws.sigs.k8s.io/#aws-credential-provider

My call was: it's better to link to the cred provider implementation versus some other doc

Copy link
Contributor

Choose a reason for hiding this comment

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

https://cloud-provider-aws.sigs.k8s.io/#aws-credential-provider is actually Kubernetes documentation, not AWS documentation.

Sounds like there's no AWS docs on this detail.

@k8s-ci-robot k8s-ci-robot added the sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. label Apr 27, 2023
@netlify
Copy link

netlify bot commented Apr 27, 2023 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 28cb031
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6467a0cb47453300084549eb
😎 Deploy Preview https://deploy-preview-40841--kubernetes-io-main-staging.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 settings.

sftim
sftim reviewed May 9, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

LGTM for docs

content/en/docs/tasks/administer-cluster/kubelet-credential-provider.md
Comment on lines 55 to +57
The configuration file passed into `--image-credential-provider-config` is read by the kubelet to determine which exec plugins
should be invoked for which container images. Here's an example configuration file you may end up using if you are using the
[ECR](https://aws.amazon.com/ecr/)-based plugin:
[ECR-based plugin](https://github.com/kubernetes/cloud-provider-aws/tree/master/cmd/ecr-credential-provider):
Copy link
Contributor

Choose a reason for hiding this comment

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

https://cloud-provider-aws.sigs.k8s.io/#aws-credential-provider is actually Kubernetes documentation, not AWS documentation.

Sounds like there's no AWS docs on this detail.

@sftim
Copy link
Contributor

sftim commented May 9, 2023

With #40841 (comment) in mind
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims, sftim

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 9, 2023
@cartermckinnon
Copy link
Contributor Author

/retest

@k8s-ci-robot
Copy link
Contributor

@cartermckinnon: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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/test-infra repository.

@cartermckinnon
Copy link
Contributor Author

@sftim can you add ok-to-test so I can get this mergeable?

@k8s-ci-robot k8s-ci-robot merged commit f88b5fc into kubernetes:main May 19, 2023
@cartermckinnon cartermckinnon deleted the patch-1 branch May 19, 2023 16:20
@cartermckinnon cartermckinnon mentioned this pull request Jul 19, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mmerkes mmerkes mmerkes left review comments

@sftim sftim sftim left review comments

@cheftako cheftako Awaiting requested review from cheftako

@liggitt liggitt Awaiting requested review from liggitt

Assignees

@dims dims

@sftim sftim

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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@cartermckinnon @k8s-ci-robot @dims @sftim @mmerkes