diff options
| -rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 2 | ||||
| -rw-r--r-- | doc/administration/gitaly/index.md | 29 | ||||
| -rw-r--r-- | doc/development/licensing.md | 6 |
3 files changed, 29 insertions, 8 deletions
diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index fe690d708ed..69bd7335d44 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -10,7 +10,9 @@ level: warning ignorecase: true swap: admin: administrator + blacklist(ed|ing)?: denylist config: configuration distro: distribution info: information repo: repository + whitelist(ed|ing)?: allowlist diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index 808fa315636..a8a092f3f36 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -334,13 +334,30 @@ then all Gitaly requests will fail. Additionally, you need to [disable Rugged if previously manually enabled](../high_availability/nfs.md#improving-nfs-performance-with-gitlab). -We assume that your `gitaly1.internal` Gitaly server can be reached at -`gitaly1.internal:8075` from your Gitaly clients, and that Gitaly server -can read and write to `/mnt/gitlab/default` and `/mnt/gitlab/storage1`. +Gitaly makes the following assumptions: + +- Your `gitaly1.internal` Gitaly server can be reached at `gitaly1.internal:8075` + from your Gitaly clients, and that Gitaly server can read and write to + `/mnt/gitlab/default` and `/mnt/gitlab/storage1`. +- Your `gitaly2.internal` Gitaly server can be reached at `gitaly2.internal:8075` + from your Gitaly clients, and that Gitaly server can read and write to + `/mnt/gitlab/storage2`. +- Your `gitaly1.internal` and `gitaly2.internal` Gitaly servers can reach each other. + +Note that you can't use mixed installation setup when at least one of your +Gitaly servers is configured as a local server with the `path` setting +provided, because other Gitaly instances can't communicate with it. +The following setup is _incorrect_, because you must replace `path` with +`gitaly_address` containing a proper value, and the +address must be reachable from the other two addresses provided: -We assume also that your `gitaly2.internal` Gitaly server can be reached at -`gitaly2.internal:8075` from your Gitaly clients, and that Gitaly server -can read and write to `/mnt/gitlab/storage2`. +```ruby +git_data_dirs({ + 'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075' }, + 'storage1' => { 'path' => '/var/opt/gitlab/git-data' }, + 'storage2' => { 'gitaly_address' => 'tcp://gitaly2.internal:8075' }, +}) +``` **For Omnibus GitLab** diff --git a/doc/development/licensing.md b/doc/development/licensing.md index e1be1faa61b..947c77cd715 100644 --- a/doc/development/licensing.md +++ b/doc/development/licensing.md @@ -12,6 +12,8 @@ Some gems may not include their license information in their `gemspec` file, and ### License Finder commands +> Note: License Finder currently uses GitLab misused terms of whitelist and blacklist. As a result, the commands below references those terms. We've created an [issue on their project](https://github.com/pivotal/LicenseFinder/issues/745) to propose that they rename their commands. + There are a few basic commands License Finder provides that you'll need in order to manage license detection. To verify that the checks are passing, and/or to see what dependencies are causing the checks to fail: @@ -20,13 +22,13 @@ To verify that the checks are passing, and/or to see what dependencies are causi bundle exec license_finder ``` -To whitelist a new license: +To allowlist a new license: ```shell license_finder whitelist add MIT ``` -To blacklist a new license: +To denylist a new license: ```shell license_finder blacklist add GPLv2 |