Skip to content

Clarify limits of using template on self-managed GitLab

Michael Gibson requested to merge mgibsongl-master-patch-42916 into master

What does this MR do?

While attempting to use the Cluster Management template on a Self-Managed GitLab instance, I ran into multiple GitLab CI configuration errors, such as:

This GitLab CI configuration is invalid: Project `renovate-bot/renovate-runner` not found or access denied! Make sure any includes in the pipeline configuration are correctly defined.

I asked about this in Slack and it appears that this template only works as-is on SaaS.

As such, this MR removes the line that refers to installation on self-managed GitLab as well as updates the tier badge, but I am not sure how we want to call this limitation out, or whether the template itself should also be removed from the Omnibus installation packages or not. So, those are questions open to comment/suggestion/review.

It appears that a permanent fix to get it working on self-managed might also be possible, as well. If so, in the long-run this change to the documentation will not be needed, but for now it can potentially head off some confusion for users.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Suzanne Selhorn

Merge request reports