pipeline icon indicating copy to clipboard operation
pipeline copied to clipboard

doc: Make it clearer what the auth documentation is about #7737

Open leodahal4 opened this issue 1 year ago • 6 comments

Changes

This PR addresses the issues raised in #7737 regarding the clarity and accuracy of the authentication documentation, specifically the sections related to Docker authentication.

Key Changes:

Overview Section:

	Provides a comprehensive explanation of the authentication process, including the two stages (Pod Scheduling and Image Pulling, and Step Execution).
	Describes the credential initialization process and the generated credential file locations.

	Configuring Docker Authentication Section:

	Clarifies the role of imagePullSecrets and their usage during the Pod creation phase for pulling images from private registries.
	Includes examples of specifying imagePullSecrets in run.yaml for TaskRun and PipelineRun.

Benefits:

	Addresses confusion and lack of clarity in the existing documentation.
	Improves understanding of when and how Docker credentials are used, particularly during the Pod creation phase.
	Enhances comprehension of the authentication flow and setup within the container.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [x] Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • [ ] Has Tests included if any functionality added or changed
  • [ ] pre-commit Passed
  • [ ] Follows the commit message standard
  • [ ] Meets the Tekton contributor standards (including functionality, content, code)
  • [ ] Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [ ] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • [ ] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

leodahal4 avatar May 19 '24 08:05 leodahal4

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: leodahal4 / name: Mou Sam Dahal (d944b4c644eab06c5754655ea3f9c400632c92b0, 7d5b243b8d1719e708c6de815fb910e05b9be5b2, d531f2f6ea0f19beb80ea2569fe1c4ceeed2975e, 4e95f12ef7309aae89e42a7b7c28496408376c41, c37f8141398fb5bf9c5d9dffacf9428f55e7fea0, 756bdf1ac84112fcb8dddd991ccff2133d61ecc6)

Hi @leodahal4. Thanks for your PR.

I'm waiting for a tektoncd 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.

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.

tekton-robot avatar May 19 '24 08:05 tekton-robot

/ok-to-test

khrm avatar May 19 '24 15:05 khrm

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel

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

tekton-robot avatar May 19 '24 15:05 tekton-robot

@vdemeester can you review this PR again ? I have made some changes for clarification on both of the things.

leodahal4 avatar May 24 '24 15:05 leodahal4

@leodahal4 thank you for your contribution! Are you still working on this PR?

afrittoli avatar Sep 05 '24 10:09 afrittoli

/hold

vdemeester avatar Feb 18 '25 08:02 vdemeester

@leodahal4 can you rebase instead of merge from main ? as is, it can't be merge by prow/the bot

vdemeester avatar Jun 25 '25 08:06 vdemeester