Skip to content

Conversation

@euanh
Copy link
Collaborator

@euanh euanh commented Apr 23, 2025

Motivation

Public container registries often have more complex authentication schemes than privately-hosted registries. For instance, they might use authentication tokens instead of passwords, or authentication might be a separate service from the registry. Users will benefit from being able to refer to examples which show suitable .netrc entries, with information about how to generate tokens and avoid common problems.

Modifications

Add example configurations for a number of popular container registries.

Result

New users can refer to concrete examples of .netrc stanzas for popular container registries, along with outline instructions explaining how to generate the necessary authentication tokens.

Test Plan

Manually tested the instructions.
Automated tests continue to pass, no new documentation warnings.

@euanh euanh added area/documentation Improvements or additions to documentation semver/none No version bump required. labels Apr 23, 2025
@euanh euanh requested a review from heckj April 23, 2025 12:34
@euanh euanh force-pushed the docs/authentication-examples branch from 2070895 to 30370f5 Compare April 23, 2025 13:48
@euanh euanh force-pushed the docs/authentication-examples branch from 19d45ad to bb40c7a Compare April 23, 2025 14:03
Copy link
Collaborator

@heckj heckj left a comment

Choose a reason for hiding this comment

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

great examples!!!

A few nits - basically introducing each list of instructions under the headers, and one minor rewrite to tighten and make the call to action more explicit

@heckj heckj merged commit 3326f8f into apple:main Apr 23, 2025
23 checks passed
@euanh euanh deleted the docs/authentication-examples branch April 24, 2025 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants