Skip to content

Docs Only - Document cluster applications from our template

What does this MR do?

P.S.: This is a big MR, but it's a MAJOR copy/paste.

The changes related to this are all the files I created inside:

doc/user/infrastructure/clusters/manage/management_project_applications/*

It documents cluster applications from our Cluster Management Project Template

GitLab Managed apps CI/CD got deprecated in 14.0. The apps got moved to
a project template. Although, the documentation for installing those
apps still lives under the deprecated page for GMA CI/CD.

This change creates separate pages to document each supported app.
It also creates links from the project template documentation to each
documented app.

There's no completely new content being created here. This change basically consists of copy/paste of the documentation that already existed in https://docs.gitlab.com/ee/user/clusters/applications.html, but extracting each CI/CD app into its own page.

The only changes made are some replacements of:

- > [Introduced] ...
+ > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.

to match the MR that introduces the Project Template.

I also replaced how applications are installed to reflect the template:

- The following configuration is required to install APP_XYZ using GitLab CI/CD:
-   APP_XYZ:
-   installed: true
+ Assuming you already have a [Cluster management project](../management_project.md) created from a
+ [management project template](../management_project_template.md), to install APP_XYZ you should
+ uncomment this line from your `helmfile.yaml`:
    path: applications/APP_XYZ/helmfile.yaml

and where the applications are configured:

- .gitlab/managed-apps/APP_XYZ/values.yaml
+ applications/APP_XYZ/values.yaml

Related issues

#333301 (closed)

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by João Alexandre Cunha

Merge request reports