2020-09-23 14:10:15 -04:00
---
stage: Enablement
group: Distribution
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-09-23 14:10:15 -04:00
---
2021-01-28 01:08:59 -05:00
# Place GitLab into a read-only state **(FREE SELF)**
2020-09-23 14:10:15 -04:00
2020-12-04 16:09:29 -05:00
WARNING:
2020-09-23 14:10:15 -04:00
This document should be used as a temporary solution.
There's work in progress to make this
[possible with Geo ](https://gitlab.com/groups/gitlab-org/-/epics/2149 ).
In some cases, you might want to place GitLab under a read-only state.
The configuration for doing so depends on your desired outcome.
## Make the repositories read-only
The first thing you'll want to accomplish is to ensure that no changes can be
made to your repositories. There's two ways you can accomplish that:
- Either stop Unicorn/Puma to make the internal API unreachable:
```shell
sudo gitlab-ctl stop puma # or unicorn
```
- Or, open up a Rails console:
```shell
sudo gitlab-rails console
```
And set the repositories for all projects read-only:
```ruby
Project.all.find_each { |project| project.update!(repository_read_only: true) }
```
When you're ready to revert this, you can do so with the following command:
```ruby
Project.all.find_each { |project| project.update!(repository_read_only: false) }
```
## Shut down the GitLab UI
If you don't mind shutting down the GitLab UI, then the easiest approach is to
stop `sidekiq` and `puma` /`unicorn`, and you'll effectively ensure that no
changes can be made to GitLab:
```shell
sudo gitlab-ctl stop sidekiq
sudo gitlab-ctl stop puma # or unicorn
```
When you're ready to revert this:
```shell
sudo gitlab-ctl start sidekiq
sudo gitlab-ctl start puma # or unicorn
```
## Make the database read-only
If you want to allow users to use the GitLab UI, then you'll need to ensure that
the database is read-only:
1. Take a [GitLab backup ](../raketasks/backup_restore.md#back-up-gitlab )
in case things don't go as expected.
2021-02-15 19:09:01 -05:00
1. Enter PostgreSQL on the console as an administrator user:
2020-09-23 14:10:15 -04:00
```shell
sudo \
-u gitlab-psql /opt/gitlab/embedded/bin/psql \
-h /var/opt/gitlab/postgresql gitlabhq_production
```
1. Create the `gitlab_read_only` user. Note that the password is set to `mypassword` ,
change that to your liking:
```sql
-- NOTE: Use the password defined earlier
CREATE USER gitlab_read_only WITH password 'mypassword';
GRANT CONNECT ON DATABASE gitlabhq_production to gitlab_read_only;
GRANT USAGE ON SCHEMA public TO gitlab_read_only;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO gitlab_read_only;
GRANT SELECT ON ALL SEQUENCES IN SCHEMA public TO gitlab_read_only;
-- Tables created by "gitlab" should be made read-only for "gitlab_read_only"
-- automatically.
ALTER DEFAULT PRIVILEGES FOR USER gitlab IN SCHEMA public GRANT SELECT ON TABLES TO gitlab_read_only;
ALTER DEFAULT PRIVILEGES FOR USER gitlab IN SCHEMA public GRANT SELECT ON SEQUENCES TO gitlab_read_only;
```
1. Get the hashed password of the `gitlab_read_only` user and copy the result:
```shell
sudo gitlab-ctl pg-password-md5 gitlab_read_only
```
1. Edit `/etc/gitlab/gitlab.rb` and add the password from the previous step:
```ruby
postgresql['sql_user_password'] = 'a2e20f823772650f039284619ab6f239'
postgresql['sql_user'] = "gitlab_read_only"
```
1. Reconfigure GitLab and restart PostgreSQL:
```shell
sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart postgresql
```
When you're ready to revert the read-only state, you'll need to remove the added
lines in `/etc/gitlab/gitlab.rb` , and reconfigure GitLab and restart PostgreSQL:
```shell
sudo gitlab-ctl reconfigure
sudo gitlab-ctl restart postgresql
```
Once you verify all works as expected, you can remove the `gitlab_read_only`
user from the database.