diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-14 03:11:26 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-14 03:11:26 +0300 |
commit | 2b8ac36bdd626226a93e6759b44bdcb5decc1559 (patch) | |
tree | 32a0e6970564a00b2010a225d920f10f8e85a39c /doc | |
parent | 0851e2f024dfb983596d601f417ff485f33f39f8 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/gitaly/index.md | 2 | ||||
-rw-r--r-- | doc/administration/gitaly/praefect.md | 3 | ||||
-rw-r--r-- | doc/user/project/releases/index.md | 14 | ||||
-rw-r--r-- | doc/user/ssh.md | 23 | ||||
-rw-r--r-- | doc/user/usage_quotas.md | 99 |
5 files changed, 88 insertions, 53 deletions
diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index 8b03312f03f..58a5da50fea 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -595,7 +595,7 @@ To migrate to Gitaly Cluster: 1. Create the required storage. Refer to [repository storage recommendations](praefect.md#repository-storage-recommendations). 1. Create and configure [Gitaly Cluster](praefect.md). -1. Configure the existing Gitaly instance [to use TPC](praefect.md#use-tcp-for-existing-gitlab-instances), if not already configured that way. +1. Configure the existing Gitaly instance [to use TCP](praefect.md#use-tcp-for-existing-gitlab-instances), if not already configured that way. 1. [Move the repositories](../operations/moving_repositories.md#move-repositories). To migrate to Gitaly Cluster, existing repositories stored outside Gitaly Cluster must be moved. There is no automatic migration but the moves can be scheduled with the GitLab API. diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 45e6f89d62b..6e8450a8883 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -28,6 +28,9 @@ The minimum recommended configuration for a Gitaly Cluster requires: - 3 Praefect nodes - 3 Gitaly nodes (1 primary, 2 secondary) +You should configure an odd number of Gitaly nodes so that transactions have a tie-breaker in case one of the +Gitaly nodes fails in a mutating RPC call. + See the [design document](https://gitlab.com/gitlab-org/gitaly/-/blob/master/doc/design_ha.md) for implementation details. diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index fd01dd451c2..75a25678125 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -462,6 +462,20 @@ In the API: This includes associated Git-tag-names, release description, author information of the releases. However, other repository-related information, such as [source code](release_fields.md#source-code), [release evidence](#release-evidence) are redacted. +### Publish releases without giving access to source code + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216485) in GitLab 15.6. + +Releases can be made accessible to non-project members while keeping repository-related information such as +[source code](release_fields.md#source-code) and [release evidence](#release-evidence) private. This is useful for +projects that use releases as a way to give access to new versions of software but do not want the source code to +be public. + +To make releases available publicly, set the following [project settings](../settings/index.md#project-feature-settings): + +- Repository is enabled and set to **Only Project Members** +- Releases is enabled and set to **Everyone With Access** + ### Create, update, and delete a release and its assets - Users with at least the Developer role diff --git a/doc/user/ssh.md b/doc/user/ssh.md index 00b97d64656..85332446334 100644 --- a/doc/user/ssh.md +++ b/doc/user/ssh.md @@ -252,6 +252,29 @@ To generate ED25519_SK or ECDSA_SK SSH keys, you must use OpenSSH 8.2 or later: A public and private key are generated. [Add the public SSH key to your GitLab account](#add-an-ssh-key-to-your-gitlab-account). +## Generate an SSH key pair with a password manager + +### Generate an SSH key pair with 1Password + +You can use [1Password](https://1password.com/) and the [1Password browser extension](https://support.1password.com/getting-started-browser/) to either: + +- Automatically generate a new SSH key. +- Use an existing SSH in your 1Password vault to authenticate with GitLab. + +1. Sign in to GitLab. +1. On the top bar, in the top right corner, select your avatar. +1. Select **Preferences**. +1. On the left sidebar, select **SSH Keys**. +1. Select **Key**, and you should see the 1Password helper appear. +1. Select the 1Password icon and unlock 1Password. +1. You can then select **Create SSH Key** or select an existing SSH key to fill in the public key. +1. In the **Title** box, type a description, like `Work Laptop` or + `Home Workstation`. +1. Optional. Update **Expiration date** to modify the default expiration date. +1. Select **Add key**. + +To learn more about using 1Password with SSH keys, see [1Password's documentation](https://developer.1password.com/docs/ssh/get-started). + ## Add an SSH key to your GitLab account > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/271239) in GitLab 15.4, default expiration date suggested in UI. diff --git a/doc/user/usage_quotas.md b/doc/user/usage_quotas.md index b2da663af4b..7df5ade215d 100644 --- a/doc/user/usage_quotas.md +++ b/doc/user/usage_quotas.md @@ -7,52 +7,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Storage usage quota **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/13294) in GitLab 12.0. -> - Moved to GitLab Free. - -## Namespace storage limit - -Namespaces on GitLab SaaS have a storage limit. For more information, see our [pricing page](https://about.gitlab.com/pricing/). -This limit is not visible on the Usage quotas page, but will be prior to the limit being [applied](#namespace-storage-limit-application-schedule). Self-managed deployments are not affected. - -Storage types that add to the total namespace storage are: - -- Git repository -- Git LFS -- Artifacts -- Container registry -- Package registry -- Dependency proxy -- Wiki -- Snippets - -If your total namespace storage exceeds the available namespace storage quota, all projects under the namespace are locked. -A locked project cannot push to the repository, run pipelines and jobs, or build and push packages. - -To prevent exceeding the namespace storage quota, you can: - -- Reduce storage consumption by following the suggestions in the [Manage Your Storage Usage](#manage-your-storage-usage) section of this page. -- Apply for [GitLab for Education](https://about.gitlab.com/solutions/education/join/), [GitLab for Open Source](https://about.gitlab.com/solutions/open-source/join/), or [GitLab for Startups](https://about.gitlab.com/solutions/startups/) if you meet the eligibility requirements. -- Consider using a [self-managed instance](../subscriptions/self_managed/index.md) of GitLab which does not have these limits on the free tier. -- [Purchase additional storage](../subscriptions/gitlab_com/index.md#purchase-more-storage-and-transfer) units at $60/year for 10GB of storage. -- [Start a trial](https://about.gitlab.com/free-trial/) or [upgrade to GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) which include higher limits and features that enable growing teams to ship faster without sacrificing on quality. -- [Talk to an expert](https://page.gitlab.com/usage_limits_help.html) to learn more about your options and ask questions. - -### Namespace storage limit application schedule - -Information on when namespace-level storage limits will be applied is available on these FAQ pages for the [Free](https://about.gitlab.com/pricing/faq-efficient-free-tier/#storage-limits-on-gitlab-saas-free-tier) and [Paid](https://about.gitlab.com/pricing/faq-paid-storage-transfer/) tier. - -## Project storage limit - -Projects on GitLab SaaS have a 10GB storage limit on their Git repository and LFS storage. -After namespace-level storage limits are applied, the project limit will be removed. A namespace has either a namespace-level storage limit or a project-level storage limit, but not both. - -When a project's repository and LFS reaches the quota, the project is locked. -You cannot push changes to a locked project. To monitor the size of each -repository in a namespace, including a breakdown for each project, -[view storage usage](#view-storage-usage). To allow a project's repository and LFS to exceed the free quota -you must purchase additional storage. For more details, see [Excess storage usage](#excess-storage-usage). - ## View storage usage Prerequisites: @@ -72,7 +26,7 @@ is updated every 90 minutes. If your namespace shows `'Not applicable.'`, push a commit to any project in the namespace to recalculate the storage. -## Storage usage statistics +### Storage usage statistics > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68898) project-level graph in GitLab 14.4 [with a flag](../administration/feature_flags.md) named `project_storage_ui`. Disabled by default. > - Enabled on GitLab.com in GitLab 14.4. @@ -97,7 +51,22 @@ Depending on your role, you can also use the following methods to manage or redu - [Reduce container registry storage](packages/container_registry/reduce_container_registry_storage.md). - [Reduce wiki repository size](../administration/wikis/index.md#reduce-wiki-repository-size). -## Excess storage usage +## Manage your transfer usage + +Depending on your role, to manage your transfer usage you can [reduce Container Registry data transfers](packages/container_registry/reduce_container_registry_data_transfer.md). + +## Project storage limit + +Projects on GitLab SaaS have a 10GB storage limit on their Git repository and LFS storage. +After namespace-level storage limits are applied, the project limit will be removed. A namespace has either a namespace-level storage limit or a project-level storage limit, but not both. + +When a project's repository and LFS reaches the quota, the project is locked. +You cannot push changes to a locked project. To monitor the size of each +repository in a namespace, including a breakdown for each project, +[view storage usage](#view-storage-usage). To allow a project's repository and LFS to exceed the free quota +you must purchase additional storage. For more details, see [Excess storage usage](#excess-storage-usage). + +### Excess storage usage Excess storage usage is the amount that a project's repository and LFS exceeds the [project storage limit](#project-storage-limit). If no purchased storage is available the project is locked. You cannot push changes to a locked project. @@ -112,7 +81,7 @@ The **Storage** tab of the **Usage Quotas** page warns you of the following: - Projects that are locked because purchased storage available is zero. Locked projects are marked with an information icon (**{information-o}**) beside their name. -### Excess storage example +#### Excess storage example The following example describes an excess storage scenario for a namespace: @@ -141,8 +110,34 @@ available decreases. All projects remain unlocked because 40 GB purchased storag | Yellow | 5 GB | 0 GB | 10 GB | Not locked | | **Totals** | **45 GB** | **10 GB** | - | - | -## Manage your transfer usage +## Namespace storage limit + +Namespaces on GitLab SaaS have a storage limit. For more information, see our [pricing page](https://about.gitlab.com/pricing/). +This limit is not visible on the **Usage quotas** page, but will be prior to the limit being [applied](#namespace-storage-limit-application-schedule). Self-managed deployments are not affected. + +Storage types that add to the total namespace storage are: + +- Git repository +- Git LFS +- Artifacts +- Container registry +- Package registry +- Dependency proxy +- Wiki +- Snippets + +If your total namespace storage exceeds the available namespace storage quota, all projects under the namespace are locked. +A locked project cannot push to the repository, run pipelines and jobs, or build and push packages. -Depending on your role, you can use the following methods to manage or reduce your transfer: +To prevent exceeding the namespace storage quota, you can: + +- Reduce storage consumption by following the suggestions in the [Manage Your Storage Usage](#manage-your-storage-usage) section of this page. +- Apply for [GitLab for Education](https://about.gitlab.com/solutions/education/join/), [GitLab for Open Source](https://about.gitlab.com/solutions/open-source/join/), or [GitLab for Startups](https://about.gitlab.com/solutions/startups/) if you meet the eligibility requirements. +- Consider using a [self-managed instance](../subscriptions/self_managed/index.md) of GitLab which does not have these limits on the free tier. +- [Purchase additional storage](../subscriptions/gitlab_com/index.md#purchase-more-storage-and-transfer) units at $60/year for 10GB of storage. +- [Start a trial](https://about.gitlab.com/free-trial/) or [upgrade to GitLab Premium or Ultimate](https://about.gitlab.com/pricing/) which include higher limits and features that enable growing teams to ship faster without sacrificing on quality. +- [Talk to an expert](https://page.gitlab.com/usage_limits_help.html) to learn more about your options and ask questions. + +### Namespace storage limit application schedule -- [Reduce Container Registry data transfers](packages/container_registry/reduce_container_registry_data_transfer.md). +Information on when namespace-level storage limits will be applied is available on these FAQ pages for the [Free](https://about.gitlab.com/pricing/faq-efficient-free-tier/#storage-limits-on-gitlab-saas-free-tier) and [Paid](https://about.gitlab.com/pricing/faq-paid-storage-transfer/) tier. |