diff options
Diffstat (limited to 'doc/administration/inactive_project_deletion.md')
| -rw-r--r-- | doc/administration/inactive_project_deletion.md | 47 |
1 files changed, 33 insertions, 14 deletions
diff --git a/doc/administration/inactive_project_deletion.md b/doc/administration/inactive_project_deletion.md index a2d2093c57b..224b52d420e 100644 --- a/doc/administration/inactive_project_deletion.md +++ b/doc/administration/inactive_project_deletion.md @@ -9,32 +9,35 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85689) in GitLab 15.0 [with a flag](../administration/feature_flags.md) named `inactive_projects_deletion`. Disabled by default. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to +On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `inactive_projects_deletion`. On GitLab.com, this feature is not available. This feature is not ready for production use. Administrators of large GitLab instances can find that over time, projects become inactive and are no longer used. -These projects take up unnecessary disk space. With inactive project deletion, you can identify these projects, warn -the maintainers ahead of time, and then delete the projects if they remain inactive. When an inactive project is +These projects take up unnecessary disk space. With inactive project deletion, you can identify these projects, warn +the maintainers ahead of time, and then delete the projects if they remain inactive. When an inactive project is deleted, the action generates an audit event that it was performed by the first active administrator. ## Configure inactive project deletion -You can configure inactive projects deletion or turn it off using the -[Application settings API](../api/settings.md#change-application-settings). +You can configure inactive projects deletion or turn it off using either: + +- [The GitLab API](#using-the-api) (GitLab 15.0 and later). +- [The GitLab UI](#using-the-gitlab-ui) (GitLab 15.1 and later). The following options are available: -- `delete_inactive_projects`: Enable or disable inactive project deletion. -- `inactive_projects_min_size_mb`: Minimum size (MB) of inactive projects to be considered for deletion. - Projects smaller in size than this threshold aren't considered inactive. -- `inactive_projects_delete_after_months`: Minimum duration (months) after which a project is scheduled for deletion if - it continues be inactive. -- `inactive_projects_send_warning_email_after_months`: Minimum duration (months) after which a deletion warning email is - sent if a project continues to be inactive. The warning email is sent to users with the Owner and Maintainer roles of - the inactive project. This duration should be less than the `inactive_projects_delete_after_months` duration. +- **Delete inactive projects** (`delete_inactive_projects`): Enable or disable inactive project deletion. +- **Delete inactive projects that exceed** (`inactive_projects_min_size_mb`): Minimum size (MB) of inactive projects to + be considered for deletion. Projects smaller in size than this threshold aren't considered inactive. +- **Delete project after** (`inactive_projects_delete_after_months`): Minimum duration (months) after which a project is + scheduled for deletion if it continues be inactive. +- **Send warning email** (`inactive_projects_send_warning_email_after_months`): Minimum duration (months) after which a + deletion warning email is sent if a project continues to be inactive. The warning email is sent to users with the + Owner and Maintainer roles of the inactive project. This duration must be less than the + **Delete project after** (`inactive_projects_delete_after_months`) duration. -For example: +For example (using the API): - `delete_inactive_projects` enabled. - `inactive_projects_min_size_mb` set to `50`. @@ -49,6 +52,22 @@ In this scenario, when a project's size is: with the scheduled date of deletion. - More than 12 months, the project is scheduled for deletion. +### Using the API + +You can use the [Application settings API](../api/settings.md#change-application-settings) to configure inactive projects. + +### Using the GitLab UI + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85575) in GitLab 15.1. + +To configure inactive projects with the GitLab UI: + +1. On the top bar, select **Menu > Admin**. +1. On the left sidebar, select **Settings > Repository**. +1. Expand **Repository maintenance**. +1. In the **Inactive project deletion** section, configure the necessary options. +1. Select **Save changes**. + ## Determine when a project was last active You can view a project's activities and determine when the project was last active in the following ways: |