diff options
Diffstat (limited to 'doc/ci/components/catalog.md')
| -rw-r--r-- | doc/ci/components/catalog.md | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/doc/ci/components/catalog.md b/doc/ci/components/catalog.md index 2194e72d56c..36ed7065e1c 100644 --- a/doc/ci/components/catalog.md +++ b/doc/ci/components/catalog.md @@ -11,15 +11,20 @@ info: To determine the technical writer assigned to the Stage/Group associated w The CI/CD catalog is a list of [components repositories](index.md#components-repository), each containing resources that you can add to your CI/CD pipelines. -## Mark a components repository as a catalog resource +Each top level namespace has its own catalog, which contains all the releases from +components repositories hosted under it. You can create components repositories anywhere +under the desired top level namespace and the released components are available to +all projects in that namespace. + +## Add a components repository to the Catalog After components are added to a components repository, they can immediately be [used](index.md#use-a-component-in-a-cicd-configuration) to build pipelines in other projects. -However, this repository is not discoverable. You must mark this project as a catalog resource -to allow it to be visible in the CI/CD Catalog so other users can discover it. +However, the repository is not discoverable. You must set the project as a catalog resource +for it to be visible in the CI/CD Catalog, then other users can discover it. You should only set a repository as a catalog resource when the components are ready for usage. -To mark a project as a catalog resource: +To set a project as a catalog resource: 1. On the left sidebar, select **Search or go to** and find your project. 1. On the left sidebar, select **Settings > General**. @@ -30,4 +35,15 @@ Ensure the project has a clear [description](../../user/project/settings/index.m as the project description is displayed in the component list in the catalog. NOTE: -This action is not reversible. +This action is not reversible, and the +component is always visible in the Catalog unless the repository is deleted. If a component has a bug or other issue, you can [create a new release](index.md#release-a-component) with an updated version. + +After the repository is set as a components repository, it appears in the CI/CD Catalog of the namespace. + +## View available components in the CI/CD Catalog + +To view the components available to your project from the CI/CD Catalog: + +1. On the left sidebar, select **Search or go to** and find your project. +1. On the left sidebar, select **Build > Pipeline Editor**. +1. Select **Browse CI/CD Catalog**. |