Skip to content

Explain how to override environment names

Amy Qualls requested to merge 211592-aqualls-apps-production into master

What does this MR do?

This MR attempts to address the need identified in #211592 (closed) - https://docs.gitlab.com/ee/user/clusters/applications.html#usage needs to discuss the * scope, and describe how to override this scope.

I've patched together words from several different engineers in the hopes of coming up with something that is coherent, but it likely won't sound smooth to a more experienced user.

It creates a new subheading, Override environment or cluster scope, which contains a bare-bones YAML example scraped from @bdowney's example file (https://gitlab.com/gitops-demo/apps/cluster-management/-/blob/master/.gitlab-ci.yml). I tried to anonymize it slightly, and I took out much of the .managed-apps section, but I'm guessing here at how much the user truly needs. Treat it more as "hey code should go here" and edit it accordingly, rather than assuming I got it even remotely right.

Related issues

Closes #211592 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports