summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <git@zjvandeweg.nl>2018-10-09 07:59:42 +0200
committerZeger-Jan van de Weg <git@zjvandeweg.nl>2018-10-10 09:08:18 +0200
commit30b4ce940d28804e0b38ea9ea4f89793d41392db (patch)
treeecbf29b27a726867d260521dc799214a4cd6d4c4 /doc/api
parent550f55745a3be5f86bafaf25b3bcc90beba8e2ac (diff)
downloadgitlab-ce-30b4ce940d28804e0b38ea9ea4f89793d41392db.tar.gz
Remove Git circuit breaker
Was introduced in the time that GitLab still used NFS, which is not required anymore in most cases. By removing this, the API it calls will return empty responses. This interface has to be removed in the next major release, expected to be 12.0.
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/repository_storage_health.md75
-rw-r--r--doc/api/settings.md5
2 files changed, 3 insertions, 77 deletions
diff --git a/doc/api/repository_storage_health.md b/doc/api/repository_storage_health.md
index e0c0315c2d7..edf4b04acea 100644
--- a/doc/api/repository_storage_health.md
+++ b/doc/api/repository_storage_health.md
@@ -1,74 +1,5 @@
# Circuitbreaker API
-> [Introduced][ce-11449] in GitLab 9.5.
-
-The Circuitbreaker API is only accessible to administrators. All requests by
-guests will respond with `401 Unauthorized`, and all requests by normal users
-will respond with `403 Forbidden`.
-
-## Repository Storages
-
-### Get all storage information
-
-Returns of all currently configured storages and their health information.
-
-```
-GET /circuit_breakers/repository_storage
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage
-```
-
-```json
-[
- {
- "storage_name": "default",
- "failing_on_hosts": [],
- "total_failures": 0
- },
- {
- "storage_name": "broken",
- "failing_on_hosts": [
- "web01", "worker01"
- ],
- "total_failures": 1
- }
-]
-```
-
-### Get failing storages
-
-This returns a list of all currently failing storages.
-
-```
-GET /circuit_breakers/repository_storage/failing
-```
-
-```bash
-curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage/failing
-```
-
-```json
-[
- {
- "storage_name":"broken",
- "failing_on_hosts":["web01", "worker01"],
- "total_failures":2
- }
-]
-```
-
-## Reset failing storage information
-
-Use this remove all failing storage information and allow access to the storage again.
-
-```
-DELETE /circuit_breakers/repository_storage
-```
-
-```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/circuit_breakers/repository_storage
-```
-
-[ce-11449]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11449
+NOTE: **Deprecated:**
+Support of the circuit breaker is removed, as Gitaly can be configured to
+to work without NFS and [communicate solely over HTTP](../administration/gitaly/index.md).
diff --git a/doc/api/settings.md b/doc/api/settings.md
index 1c41b3345ad..4482030888d 100644
--- a/doc/api/settings.md
+++ b/doc/api/settings.md
@@ -138,11 +138,6 @@ are listed in the descriptions of the relevant settings.
| `authorized_keys_enabled` | boolean | no | By default, we write to the `authorized_keys` file to support Git over SSH without additional configuration. GitLab can be optimized to authenticate SSH keys via the database file. Only disable this if you have configured your OpenSSH server to use the AuthorizedKeysCommand. |
| `auto_devops_domain` | string | no | Specify a domain to use by default for every project's Auto Review Apps and Auto Deploy stages. |
| `auto_devops_enabled` | boolean | no | Enable Auto DevOps for projects by default. It will automatically build, test, and deploy applications based on a predefined CI/CD configuration. |
-| `circuitbreaker_access_retries` | integer | no | The number of attempts GitLab will make to access a storage. |
-| `circuitbreaker_check_interval` | integer | no | Number of seconds in between storage checks. |
-| `circuitbreaker_failure_count_threshold` | integer | no | The number of failures after which GitLab will completely prevent access to the storage. |
-| `circuitbreaker_failure_reset_time` | integer | no | Time in seconds GitLab will keep storage failure information. When no failures occur during this time, the failure information is reset. |
-| `circuitbreaker_storage_timeout` | integer | no | Seconds to wait for a storage access attempt. |
| `clientside_sentry_dsn` | string | required by: `clientside_sentry_enabled` | Clientside Sentry Data Source Name. |
| `clientside_sentry_enabled` | boolean | no | (**If enabled, requires:** `clientside_sentry_dsn`) Enable Sentry error reporting for the client side. |
| `container_registry_token_expire_delay` | integer | no | Container Registry token duration in minutes. |