Draft: Add section for configuring registry database
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.
How to set up and validate locally
- configure gdk with gitlab-docs
- Make sure the branch used by gdk to fetch the
gitlab
repo isdocument-registry-database-config
and not master - Start gdk (and make sure gitlab-docs is up and running)
- Navigate to your local gitlab docs page: http://localhost:3005/ee/administration/packages/container_registry.html?tab=Linux+package+%28Omnibus%29#configure-a-metadata-database-for-the-container-registry
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
changed milestone to %16.4
assigned to @suleimiahmed
- A deleted user
added documentation label
2 Warnings 8724612e: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. Please add a merge request subtype to this merge request. 1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/administration/packages/container_registry.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
added devopspackage sectionci labels
added typemaintenance label
added docs-only label
requested review from @jaime
requested review from @hswimelar
Hey @jaime @hswimelar Hoping i can get a review here on the accuracy of the information we want to communicate before soliciting a TW review
This MR is marked as draft because it depends on the completion of omnibus-gitlab!7100 (merged)
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. 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. changed this line in version 3 of the diff
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). We should probably mention the minimum requirements we need like the Postgres version. As for the chosen solution, we should follow what we say for Charts or point to https://docs.gitlab.com/charts/advanced/external-db/
changed this line in version 3 of the diff
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.
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. changed this line in version 3 of the diff