diff options
Diffstat (limited to 'doc/administration/inactive_project_deletion.md')
| -rw-r--r-- | doc/administration/inactive_project_deletion.md | 79 |
1 files changed, 32 insertions, 47 deletions
diff --git a/doc/administration/inactive_project_deletion.md b/doc/administration/inactive_project_deletion.md index ea5658bef84..aad6a420246 100644 --- a/doc/administration/inactive_project_deletion.md +++ b/doc/administration/inactive_project_deletion.md @@ -8,70 +8,55 @@ 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. > - [Feature flag `inactive_projects_deletion`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96803) removed in GitLab 15.4. +> - Configuration through GitLab UI [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85575) in GitLab 15.1. 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 -deleted, the action generates an audit event that it was performed by the @GitLab-Admin-Bot. +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 @GitLab-Admin-Bot. For the default setting on GitLab.com, see the [GitLab.com settings page](../user/gitlab_com/index.md#inactive-project-deletion). ## Configure inactive project deletion -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** (`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. +To configure deletion of inactive projects: -For example (using the API): - -- `delete_inactive_projects` enabled. -- `inactive_projects_min_size_mb` set to `50`. -- `inactive_projects_delete_after_months` set to `12`. -- `inactive_projects_send_warning_email_after_months` set to `6`. - -In this scenario, when a project's size is: +1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, select **Settings > Repository**. +1. Expand **Repository maintenance**. +1. In the **Inactive project deletion** section, select **Delete inactive projects**. +1. Configure the settings. + - The warning email is sent to users who have the Owner and Maintainer role for the inactive project. + - The email duration must be less than the **Delete project after** duration. +1. Select **Save changes**. -- Less than 50 MB, the project is not considered inactive. -- Greater than 50 MB and it is inactive for: - - More than 6 months, a deletion warning is email is sent to users with the Owner and Maintainer role on the project - with the scheduled date of deletion. - - More than 12 months, the project is scheduled for deletion. +Inactive projects that meet the criteria are scheduled for deletion and a warning email is sent. If the +projects remain inactive, they are deleted after the specified duration. -### Using the API +### Configuration example -You can use the [Application settings API](../api/settings.md#change-application-settings) to configure inactive projects. +If you use these settings: -### Using the GitLab UI +- **Delete inactive projects** enabled. +- **Delete inactive projects that exceed** set to `50`. +- **Delete project after** set to `12`. +- **Send warning email** set to `6`. -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/85575) in GitLab 15.1. +If a project is less than 50 MB, the project is not considered inactive. -To configure inactive projects with the GitLab UI: +If a project is more than 50 MB and it is inactive for: -1. On the top bar, select **Main 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**. +- More than 6 months: A deletion warning email is sent. This mail includes the date that the project will be deleted. +- More than 12 months: The project is scheduled for deletion. ## 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: -1. Go to the [activity page](../user/project/working_with_projects.md#view-project-activity) for the project and view - the date of the latest event. -1. View the `last_activity_at` attribute for the project using the [Projects API](../api/projects.md). -1. List the visible events for the project using the [Events API](../api/events.md#list-a-projects-visible-events). - View the `created_at` attribute of the latest event. +- Go to the [activity page](../user/project/working_with_projects.md#view-project-activity) for the project and view + the date of the latest event. +- View the `last_activity_at` attribute for the project using the [Projects API](../api/projects.md). +- List the visible events for the project using the [Events API](../api/events.md#list-a-projects-visible-events). + View the `created_at` attribute of the latest event. |