diff options
| author | Toon Claes <toon@iotcl.com> | 2017-09-19 10:44:58 +0300 |
|---|---|---|
| committer | Toon Claes <toon@iotcl.com> | 2017-10-06 23:37:40 +0300 |
| commit | d13669716ab0c31ce9039ae9f7f073e33a4dc40f (patch) | |
| tree | 001bb2e6aa76ea7531c93e469c396f7fdcc408a7 /doc | |
| parent | 2cf5dca8f80cdefeb8932bf80417f52f289668c8 (diff) | |
Create idea of read-only database
In GitLab EE, a GitLab instance can be read-only (e.g. when it's a Geo
secondary node). But in GitLab CE it also might be useful to have the
"read-only" idea around. So port it back to GitLab CE.
Also having the principle of read-only in GitLab CE would hopefully
lead to less errors introduced, doing write operations when there
aren't allowed for read-only calls.
Closes gitlab-org/gitlab-ce#37534.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/verifying_database_capabilities.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/development/verifying_database_capabilities.md b/doc/development/verifying_database_capabilities.md index cc6d62957e3..ffdeff47d4a 100644 --- a/doc/development/verifying_database_capabilities.md +++ b/doc/development/verifying_database_capabilities.md @@ -24,3 +24,15 @@ else run_query end ``` + +# Read-only database + +The database can be used in read-only mode. In this case we have to +make sure all GET requests don't attempt any write operations to the +database. If one of those requests wants to write to the database, it needs +to be wrapped in a `Gitlab::Database.read_only?` or `Gitlab::Database.read_write?` +guard, to make sure it doesn't for read-only databases. + +We have a Rails Middleware that filters any potentially writing +operations (the CUD operations of CRUD) and prevent the user from trying +to update the database and getting a 500 error (see `Gitlab::Middleware::ReadOnly`). |