Commit 453dccb8 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'selhorn-note-that-4' into 'master'

Remove 'note that' phrase

See merge request gitlab-org/gitlab!67077
parents 2660273f ef56277e
...@@ -22,7 +22,7 @@ guidance of a Support Engineer, or running them in a test environment with a ...@@ -22,7 +22,7 @@ guidance of a Support Engineer, or running them in a test environment with a
backup of the instance ready to be restored, just in case. backup of the instance ready to be restored, just in case.
WARNING: WARNING:
Please also note that as GitLab changes, changes to the code are inevitable, As GitLab changes, changes to the code are inevitable,
and so some scripts may not work as they once used to. These are not kept and so some scripts may not work as they once used to. These are not kept
up-to-date as these scripts/commands were added as they were found/needed. As up-to-date as these scripts/commands were added as they were found/needed. As
mentioned above, we recommend running these scripts under the supervision of a mentioned above, we recommend running these scripts under the supervision of a
......
...@@ -135,7 +135,7 @@ and they will assist you with any issues you are having. ...@@ -135,7 +135,7 @@ and they will assist you with any issues you are having.
# source-style commands should also work # source-style commands should also work
cd /srv/gitlab && bundle exec rake gitlab:check RAILS_ENV=production cd /srv/gitlab && bundle exec rake gitlab:check RAILS_ENV=production
# run GitLab check. Note that the output can be confusing and invalid because of the specific structure of GitLab installed via helm chart # run GitLab check. The output can be confusing and invalid because of the specific structure of GitLab installed via helm chart
/usr/local/bin/gitlab-rake gitlab:check /usr/local/bin/gitlab-rake gitlab:check
# open console without entering pod # open console without entering pod
......
...@@ -265,7 +265,7 @@ user.save!(validate: false) ...@@ -265,7 +265,7 @@ user.save!(validate: false)
This is not recommended, as validations are usually put in place to ensure the This is not recommended, as validations are usually put in place to ensure the
integrity and consistency of user-provided data. integrity and consistency of user-provided data.
Note that a validation error will prevent the entire object from being saved to A validation error will prevent the entire object from being saved to
the database. We'll see a little of this in the next section. If you're getting the database. We'll see a little of this in the next section. If you're getting
a mysterious red banner in the GitLab UI when submitting a form, this can often a mysterious red banner in the GitLab UI when submitting a form, this can often
be the fastest way to get to the root of the problem. be the fastest way to get to the root of the problem.
......
...@@ -199,7 +199,7 @@ To fix this problem: ...@@ -199,7 +199,7 @@ To fix this problem:
git config --global http.sslCAInfo ~/.ssl/gitlab.domain.tld.crt git config --global http.sslCAInfo ~/.ssl/gitlab.domain.tld.crt
``` ```
- Disable SSL verification in your Git client. Note that this intended as a - Disable SSL verification in your Git client. This is intended as a
temporary measure, as it could be considered a security risk. temporary measure, as it could be considered a security risk.
```shell ```shell
......
...@@ -57,7 +57,7 @@ Available types for the `action` parameter, and the resources that might be affe ...@@ -57,7 +57,7 @@ Available types for the `action` parameter, and the resources that might be affe
- Design - Design
- Wiki page - Wiki page
Note that these options are in lower case. These options are in lowercase.
### Target Types ### Target Types
...@@ -71,7 +71,7 @@ Available target types for the `target_type` parameter are: ...@@ -71,7 +71,7 @@ Available target types for the `target_type` parameter are:
- `snippet` - `snippet`
- `user` - `user`
Note that these options are in lower case. These options are in lowercase.
### Date formatting ### Date formatting
......
...@@ -130,7 +130,7 @@ POST /features/:name ...@@ -130,7 +130,7 @@ POST /features/:name
| `project` | string | no | A projects path, for example `gitlab-org/gitlab-foss` | | `project` | string | no | A projects path, for example `gitlab-org/gitlab-foss` |
| `force` | boolean | no | Skip feature flag validation checks, such as a YAML definition | | `force` | boolean | no | Skip feature flag validation checks, such as a YAML definition |
Note that you can enable or disable a feature for a `feature_group`, a `user`, You can enable or disable a feature for a `feature_group`, a `user`,
a `group`, and a `project` in a single API call. a `group`, and a `project` in a single API call.
```shell ```shell
......
...@@ -33,7 +33,7 @@ To use this in a [`script` definition](../ci/yaml/index.md#script) inside ...@@ -33,7 +33,7 @@ To use this in a [`script` definition](../ci/yaml/index.md#script) inside
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable. - The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job downloads the artifacts of the job with ID For example, the following job downloads the artifacts of the job with ID
`42`. Note that the command is wrapped into single quotes because it contains a `42`. The command is wrapped in single quotes because it contains a
colon (`:`): colon (`:`):
```yaml ```yaml
...@@ -98,7 +98,7 @@ To use this in a [`script` definition](../ci/yaml/index.md#script) inside ...@@ -98,7 +98,7 @@ To use this in a [`script` definition](../ci/yaml/index.md#script) inside
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable. - The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job downloads the artifacts of the `test` job For example, the following job downloads the artifacts of the `test` job
of the `main` branch. Note that the command is wrapped into single quotes of the `main` branch. The command is wrapped in single quotes
because it contains a colon (`:`): because it contains a colon (`:`):
```yaml ```yaml
......
...@@ -85,7 +85,7 @@ Supported attributes: ...@@ -85,7 +85,7 @@ Supported attributes:
## Get a blob from repository ## Get a blob from repository
Allows you to receive information about blob in repository like size and Allows you to receive information about blob in repository like size and
content. Note that blob content is Base64 encoded. This endpoint can be accessed content. Blob content is Base64 encoded. This endpoint can be accessed
without authentication if the repository is publicly accessible. without authentication if the repository is publicly accessible.
```plaintext ```plaintext
...@@ -149,7 +149,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.com/api/v4/pr ...@@ -149,7 +149,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.com/api/v4/pr
## Compare branches, tags or commits ## Compare branches, tags or commits
This endpoint can be accessed without authentication if the repository is This endpoint can be accessed without authentication if the repository is
publicly accessible. Note that diffs could have an empty diff string if [diff limits](../development/diffs.md#diff-limits) are reached. publicly accessible. Diffs can have an empty diff string if [diff limits](../development/diffs.md#diff-limits) are reached.
```plaintext ```plaintext
GET /projects/:id/repository/compare GET /projects/:id/repository/compare
...@@ -607,7 +607,7 @@ template: | ...@@ -607,7 +607,7 @@ template: |
{% end %} {% end %}
``` ```
Note that when specifying the template you should use `template: |` and not When specifying the template you should use `template: |` and not
`template: >`, as the latter doesn't preserve newlines in the template. `template: >`, as the latter doesn't preserve newlines in the template.
### Template data ### Template data
......
...@@ -24,7 +24,7 @@ in the following table. ...@@ -24,7 +24,7 @@ in the following table.
## Get file from repository ## Get file from repository
Allows you to receive information about file in repository like name, size, Allows you to receive information about file in repository like name, size,
content. Note that file content is Base64 encoded. This endpoint can be accessed content. File content is Base64 encoded. This endpoint can be accessed
without authentication if the repository is publicly accessible. without authentication if the repository is publicly accessible.
```plaintext ```plaintext
......
...@@ -259,7 +259,7 @@ GET /projects/:id/services/buildkite ...@@ -259,7 +259,7 @@ GET /projects/:id/services/buildkite
## Campfire ## Campfire
Send notifications about push events to Campfire chat rooms. Send notifications about push events to Campfire chat rooms.
Note that [new users can no longer sign up for Campfire](https://basecamp.com/retired/campfire). [New users can no longer sign up for Campfire](https://basecamp.com/retired/campfire).
### Create/Edit Campfire service ### Create/Edit Campfire service
......
...@@ -408,7 +408,7 @@ users. Either `password`, `reset_password`, or `force_random_password` ...@@ -408,7 +408,7 @@ users. Either `password`, `reset_password`, or `force_random_password`
must be specified. If `reset_password` and `force_random_password` are must be specified. If `reset_password` and `force_random_password` are
both `false`, then `password` is required. both `false`, then `password` is required.
Note that `force_random_password` and `reset_password` take priority `force_random_password` and `reset_password` take priority
over `password`. In addition, `reset_password` and over `password`. In addition, `reset_password` and
`force_random_password` can be used together. `force_random_password` can be used together.
...@@ -1600,7 +1600,7 @@ Example response: ...@@ -1600,7 +1600,7 @@ Example response:
> Requires admin permissions. > Requires admin permissions.
> Token values are returned once. Make sure you save it - you can't access it again. > Token values are returned once. Make sure you save it - you can't access it again.
It creates a new impersonation token. Note that only administrators can do this. It creates a new impersonation token. Only administrators can do this.
You are only able to create impersonation tokens to impersonate the user and perform You are only able to create impersonation tokens to impersonate the user and perform
both API calls and Git reads and writes. The user can't see these tokens in their profile both API calls and Git reads and writes. The user can't see these tokens in their profile
settings page. settings page.
......
...@@ -8,7 +8,7 @@ group: database ...@@ -8,7 +8,7 @@ group: database
This document is a proposal to work towards reducing and limiting table sizes on GitLab.com. We establish a **measurable target** by limiting table size to a certain threshold. This will be used as an indicator to drive database focus and decision making. With GitLab.com growing, we continuously re-evaluate which tables need to be worked on to prevent or otherwise fix violations. This document is a proposal to work towards reducing and limiting table sizes on GitLab.com. We establish a **measurable target** by limiting table size to a certain threshold. This will be used as an indicator to drive database focus and decision making. With GitLab.com growing, we continuously re-evaluate which tables need to be worked on to prevent or otherwise fix violations.
Note that this is not meant to be a hard rule but rather a strong indication that work needs to be done to break a table apart or otherwise reduce its size. This is not meant to be a hard rule but rather a strong indication that work needs to be done to break a table apart or otherwise reduce its size.
This is meant to be read in context with the [Database Sharding blueprint](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64115), This is meant to be read in context with the [Database Sharding blueprint](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64115),
which paints the bigger picture. This proposal here is thought to be part of the "debloating step" below, as we aim to reduce storage requirements and improve data modeling. Partitioning is part of the standard tool-belt: where possible, we can already use partitioning as a solution to cut physical table sizes significantly. Both will help to prepare efforts like decomposition (database usage is already optimized) and sharding (database is already partitioned along an identified data access dimension). which paints the bigger picture. This proposal here is thought to be part of the "debloating step" below, as we aim to reduce storage requirements and improve data modeling. Partitioning is part of the standard tool-belt: where possible, we can already use partitioning as a solution to cut physical table sizes significantly. Both will help to prepare efforts like decomposition (database usage is already optimized) and sharding (database is already partitioned along an identified data access dimension).
...@@ -124,7 +124,7 @@ In order to maintain and improve operational stability and lessen development bu ...@@ -124,7 +124,7 @@ In order to maintain and improve operational stability and lessen development bu
1. Indexes are smaller, can be maintained more efficiently and fit better into memory 1. Indexes are smaller, can be maintained more efficiently and fit better into memory
1. Data migrations are easier to reason about, take less time to implement and execute 1. Data migrations are easier to reason about, take less time to implement and execute
Note that this target is *pragmatic*: We understand table sizes depend on feature usage, code changes and other factors - which all change over time. We may not always find solutions where we can tightly limit the size of physical tables once and for all. That is acceptable though and we primarily aim to keep the situation on GitLab.com under control. We adapt our efforts to the situation present on GitLab.com and will re-evaluate frequently. This target is *pragmatic*: We understand table sizes depend on feature usage, code changes and other factors - which all change over time. We may not always find solutions where we can tightly limit the size of physical tables once and for all. That is acceptable though and we primarily aim to keep the situation on GitLab.com under control. We adapt our efforts to the situation present on GitLab.com and will re-evaluate frequently.
While there are changes we can make that lead to a constant maximum physical table size over time, this doesn't need to be the case necessarily. Consider for example hash partitioniong, which breaks a table down into a static number of partitions. With data growth over time, individual partitions will also grow in size and may eventually reach the threshold size again. We strive to get constant table sizes, but it is acceptable to ship easier solutions that don't have this characteristic but improve the situation for a considerable amount of time. While there are changes we can make that lead to a constant maximum physical table size over time, this doesn't need to be the case necessarily. Consider for example hash partitioniong, which breaks a table down into a static number of partitions. With data growth over time, individual partitions will also grow in size and may eventually reach the threshold size again. We strive to get constant table sizes, but it is acceptable to ship easier solutions that don't have this characteristic but improve the situation for a considerable amount of time.
......
...@@ -64,7 +64,7 @@ We already use Database Lab from [postgres.ai](https://postgres.ai/), which is a ...@@ -64,7 +64,7 @@ We already use Database Lab from [postgres.ai](https://postgres.ai/), which is a
Internally, this is based on ZFS and implements a "thin-cloning technology". That is, ZFS snapshots are being used to clone the data and it exposes a full read/write PostgreSQL cluster based on the cloned data. This is called a *thin clone*. It is rather short lived and is going to be destroyed again shortly after we are finished using it. Internally, this is based on ZFS and implements a "thin-cloning technology". That is, ZFS snapshots are being used to clone the data and it exposes a full read/write PostgreSQL cluster based on the cloned data. This is called a *thin clone*. It is rather short lived and is going to be destroyed again shortly after we are finished using it.
It is important to note that a thin clone is fully read/write. This allows us to execute migrations on top of it. A thin clone is fully read/write. This allows us to execute migrations on top of it.
Database Lab provides an API we can interact with to manage thin clones. In order to automate the migration and query testing, we add steps to the `gitlab/gitlab-org` CI pipeline. This triggers automation that performs the following steps for a given merge request: Database Lab provides an API we can interact with to manage thin clones. In order to automate the migration and query testing, we add steps to the `gitlab/gitlab-org` CI pipeline. This triggers automation that performs the following steps for a given merge request:
......
...@@ -79,7 +79,7 @@ GitLab CI/CD supports numerous configuration options: ...@@ -79,7 +79,7 @@ GitLab CI/CD supports numerous configuration options:
| [Optimize GitLab and GitLab Runner for large repositories](large_repositories/index.md) | Recommended strategies for handling large repositories. | | [Optimize GitLab and GitLab Runner for large repositories](large_repositories/index.md) | Recommended strategies for handling large repositories. |
| [`.gitlab-ci.yml` full reference](yaml/index.md) | All the attributes you can use with GitLab CI/CD. | | [`.gitlab-ci.yml` full reference](yaml/index.md) | All the attributes you can use with GitLab CI/CD. |
Note that certain operations can only be performed according to the Certain operations can only be performed according to the
[user](../user/permissions.md#gitlab-cicd-permissions) and [job](../user/permissions.md#job-permissions) permissions. [user](../user/permissions.md#gitlab-cicd-permissions) and [job](../user/permissions.md#job-permissions) permissions.
## Feature set ## Feature set
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment