Skip to content
Snippets Groups Projects

Draft: Add section for configuring registry database

Closed Suleimi Ahmed requested to merge document-registry-database-config into master

What does this MR do and why?

Introduces documentation on how to setup registry experimental metadata database : container-registry#1071 (closed)

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Screenshot_2023-08-24_at_11.28.42_AM

Screenshot_2023-08-24_at_11.28.56_AM

Screenshot_2023-08-24_at_11.29.11_AM

Screenshot_2023-08-24_at_11.29.22_AM

How to set up and validate locally

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Suleimi Ahmed

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
990 990
991 991 ::EndTabs
992 992
993 ## Configure a metadata database for the Container Registry
994
995 WARNING:
996 At this time, the metadata database is considered an experimental feature of the container registry and should only be used
997 after reviewing the [detailed documentation](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs-gitlab/database-quick-start.md).
998
  • 990 990
    991 991 ::EndTabs
    992 992
    993 ## Configure a metadata database for the Container Registry
    994
    995 WARNING:
    996 At this time, the metadata database is considered an experimental feature of the container registry and should only be used
    997 after reviewing the [detailed documentation](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs-gitlab/database-quick-start.md).
    998
    999 ### Use metadata database
    1000
    1001 To use the registry metadata database feature, you must first procure a postgres database and create a user and a password to access the database on behalf of the registry.
    • Suggested change
      1001 To use the registry metadata database feature, you must first procure a postgres database and create a user and a password to access the database on behalf of the registry.
      1001 To use the registry metadata database feature, you must first procure a postgres database and create a user and a password to access the database on behalf of the registry.
    • Suleimi Ahmed changed this line in version 3 of the diff

      changed this line in version 3 of the diff

    • Please register or sign in to reply
  • 990 990
    991 991 ::EndTabs
    992 992
    993 ## Configure a metadata database for the Container Registry
    994
    995 WARNING:
    996 At this time, the metadata database is considered an experimental feature of the container registry and should only be used
    997 after reviewing the [detailed documentation](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs-gitlab/database-quick-start.md).
    998
    999 ### Use metadata database
    1000
    1001 To use the registry metadata database feature, you must first procure a postgres database and create a user and a password to access the database on behalf of the registry.
    1002
    1003 The choice of where-to or how-to procure the registry database is left up to you, the main requirement is; the database must be a postgres database that is accessible from your registry instance(s).
  • 1038 enabled: true
    1039 host: 'database-host'
    1040 port: database-port
    1041 user: 'registry-database-user'
    1042 password: 'registry-database-password'
    1043 dbname: 'registry-database-name'
    1044 sslmode: 'disable' # one of disable, allow, prefer, require, verify-ca or verify-full. See the PostgreSQL documentation for additional information https://www.postgresql.org/docs/current/libpq-ssl.html.
    1045 ```
    1046
    1047 1. Restart the registry service.
    1048
    1049 ::EndTabs
    1050
    1051 **Existing GitLab installations**
    1052
    1053 If you are not enabling the registry database on a new GitLab installation and/or you would like to import existing registry data from an older registry storage into a metadata database ,then you will need to follow the steps highlighted in the [metadata database quick start guide](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs-gitlab/database-quick-start.md#existing-registry).
    • The beginning of this section is a bit confusing. I think we shouldn't point to the quick start guide yet as it will confuse users on what to do first. So I think we should simply go in to the step-by-step section below.

      Suggested change
      1053 If you are not enabling the registry database on a new GitLab installation and/or you would like to import existing registry data from an older registry storage into a metadata database ,then you will need to follow the steps highlighted in the [metadata database quick start guide](https://gitlab.com/gitlab-org/container-registry/-/blob/master/docs-gitlab/database-quick-start.md#existing-registry).
      1053 To enable the metadata database and keep your existing container repositories, yo will need to follow the steps below to configure the database, migrate your existing content and start using the database.
    • Suleimi Ahmed changed this line in version 3 of the diff

      changed this line in version 3 of the diff

    • Please register or sign in to reply
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading