1
0
mirror of synced 2025-12-23 03:44:00 -05:00

Add feature preview for container registry (#16424)

* Add new article with user account procedure

* Update reusables

* Add other prereq

* Add product variable

* Add a reminder reusable for getting started procedures

* Revise organization article

* Condense enabling articles into one

* Deets

* Delete old article

* wording tweak

* Minor tweak

* Add personal user account explanation

* Rework explanation

* Apply suggestions from code review

Co-authored-by: Kayla Ngan <kaylangan@github.com>

* Apply suggestions from code review

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Kayla Ngan <kaylangan@github.com>

* Update screenshot and remove other feature previews

* Create a reusable for accessing the feature preview

* ✂️ per @lucascosti's suggestion

* Update images

* Update article title

* Apply suggestions from code review

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Kayla Ngan <kaylangan@github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
This commit is contained in:
jmarlena
2020-11-16 14:54:32 -08:00
committed by GitHub
parent a8f16c63f7
commit 0dac557081
15 changed files with 57 additions and 29 deletions

View File

@@ -8,7 +8,7 @@ versions:
{% note %}
**Note:** {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free.
**Note:** {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. To use {% data variables.product.prodname_github_container_registry %}, you must enable the feature for your account. For more information, see "[Enabling improved container support](/packages/getting-started-with-github-container-registry/enabling-improved-container-support)."
{% endnote %}

View File

@@ -1,21 +0,0 @@
---
title: Enabling GitHub Container Registry for your organization
intro: 'In an organization, organization admins can allow organization members to publish public or private container images to {% data variables.product.prodname_github_container_registry %}.'
product: '{% data reusables.gated-features.packages %}'
versions:
free-pro-team: '*'
---
{% data reusables.package_registry.container-registry-beta %}
Before organization members can publish container images to {% data variables.product.prodname_github_container_registry %}, an organization admin must enable package creation.
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.member-privileges %}
5. Under "Package creation", choose whether you want to enable the creation of public or private container images.
- To enable organization members to create a public container image, click **Public**.
- To enable organization members to create a private container image that is only visible to other organization members, click **Private**. You can further customize the visibility of a private container image. For more information, see "[Configuring access control and visibility for container images](/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images)."
![Options to enable public or private packages ](/assets/images/help/package-registry/package-creation-org-settings.png)

View File

@@ -0,0 +1,39 @@
---
title: Enabling improved container support
intro: 'To use {% data variables.product.prodname_github_container_registry %}, you must enable it for your user or organization account.'
product: '{% data reusables.gated-features.packages %}'
versions:
free-pro-team: '*'
---
{% note %}
**Note:** {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. For more information, see "[About {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry/about-github-container-registry)."
{% endnote %}
### Enabling {% data variables.product.prodname_github_container_registry %} for your personal account
Once {% data variables.product.prodname_github_container_registry %} is enabled for your personal user account, you can publish containers to {% data variables.product.prodname_github_container_registry %} owned by your user account.
To use {% data variables.product.prodname_github_container_registry %} within an organization, the organization owner must enable the feature for organization members.
{% data reusables.feature-preview.feature-preview-setting %}
2. On the left, select "Improved container support", then click **Enable**.
![Improved container support](/assets/images/help/settings/improved-container-support.png)
### Enabling {% data variables.product.prodname_github_container_registry %} for your organization account
Before organization owners or members can publish container images to {% data variables.product.prodname_github_container_registry %}, an organization owner must enable the feature preview for the organization.
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
4. On the left, click **Packages**.
5. Under "Improved container support", select "Enable improved container support" and click **Save**.
![Enable container registry support option and save button](/assets/images/help/package-registry/enable-improved-container-support-for-orgs.png)
6. Under "Container creation", choose whether you want to enable the creation of public and/or private container images.
- To enable organization members to create public container images, click **Public**.
- To enable organization members to create private container images that are only visible to other organization members, click **Private**. You can further customize the visibility of private container images. For more information, see "[Configuring access control and visibility for container images](/packages/managing-container-images-with-github-container-registry/configuring-access-control-and-visibility-for-container-images)."
![Options to enable public or private packages ](/assets/images/help/package-registry/package-creation-org-settings.png)

View File

@@ -8,8 +8,8 @@ versions:
{% data reusables.package_registry.container-registry-beta %}
{% link_in_list /about-github-container-registry %}
{% link_in_list /enabling-improved-container-support %}
{% link_in_list /core-concepts-for-github-container-registry %}
{% link_in_list /migrating-to-github-container-registry-for-docker-images %}
{% link_in_list /enabling-github-container-registry-for-your-organization %}
For more information about configuring, deleting, pushing, or pulling container images, see "[Managing container images with {% data variables.product.prodname_github_container_registry %}](/packages/managing-container-images-with-github-container-registry)."

View File

@@ -31,6 +31,8 @@ The domain for the {% data variables.product.prodname_container_registry %} is `
### Authenticating with the container registry
{% data reusables.package_registry.feature-preview-for-container-registry %}
You will need to authenticate to the {% data variables.product.prodname_container_registry %} with the base URL `ghcr.io`. We recommend creating a new access token for using the {% data variables.product.prodname_container_registry %}.
{% data reusables.package_registry.authenticate_with_pat_for_container_registry %}
@@ -70,6 +72,8 @@ To move Docker images that you host on {% data variables.product.prodname_regist
### Updating your {% data variables.product.prodname_actions %} workflow
{% data reusables.package_registry.feature-preview-for-container-registry %}
If you have a {% data variables.product.prodname_actions %} workflow that uses a Docker image from the {% data variables.product.prodname_registry %} Docker registry, you may want to update your workflow to the {% data variables.product.prodname_container_registry %} to allow for anonymous access for public container images, finer-grain access permissions, and better storage and bandwidth compatibility for containers.
1. Migrate your Docker images to the new {% data variables.product.prodname_container_registry %} at `ghcr.io`. For an example, see "[Migrating a Docker image using the Docker CLI](#migrating-a-docker-image-using-the-docker-cli)."