diff options
Diffstat (limited to 'doc/user/workspace/gitlab_agent_configuration.md')
-rw-r--r-- | doc/user/workspace/gitlab_agent_configuration.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/user/workspace/gitlab_agent_configuration.md b/doc/user/workspace/gitlab_agent_configuration.md index bef935f2426..1bba00b4d0e 100644 --- a/doc/user/workspace/gitlab_agent_configuration.md +++ b/doc/user/workspace/gitlab_agent_configuration.md @@ -28,6 +28,8 @@ provided that the agent is properly configured for remote development. | [`network_policy`](#network_policy) | Firewall rules for workspaces. | | [`default_resources_per_workspace_container`](#default_resources_per_workspace_container) | Default requests and limits for CPU and memory per workspace container. | | [`max_resources_per_workspace`](#max_resources_per_workspace) | Maximum requests and limits for CPU and memory per workspace. | +| [`workspaces_quota`](#workspaces_quota) | Maximum number of workspaces for the GitLab agent. | +| [`workspaces_per_user_quota`](#workspaces_per_user_quota) | Maximum number of workspaces per user. | NOTE: If a setting has an invalid value, it's not possible to update any setting until you fix that value. @@ -202,6 +204,52 @@ remote_development: The maximum resources you define must include any resources required for init containers to perform bootstrapping operations such as cloning the project repository. +### `workspaces_quota` + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. + +Use this setting to set the maximum number of workspaces for the GitLab agent. + +You cannot create new workspaces for an agent when: + +- The number of workspaces for the agent has reached the defined `workspaces_quota`. +- `workspaces_quota` is set to `0`. + +This setting does not affect existing workspaces for the agent. + +The default value is `-1` (unlimited). +Possible values are greater than or equal to `-1`. + +**Example configuration:** + +```yaml +remote_development: + workspaces_quota: 10 +``` + +### `workspaces_per_user_quota` + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11586) in GitLab 16.9. + +Use this setting to set the maximum number of workspaces per user. + +You cannot create new workspaces for a user when: + +- The number of workspaces for the user has reached the defined `workspaces_per_user_quota`. +- `workspaces_per_user_quota` is set to `0`. + +This setting does not affect existing workspaces for the user. + +The default value is `-1` (unlimited). +Possible values are greater than or equal to `-1`. + +**Example configuration:** + +```yaml +remote_development: + workspaces_per_user_quota: 3 +``` + ## Configuring user access with remote development You can configure the `user_access` module to access the connected Kubernetes cluster with your GitLab credentials. |