Skip to content

Documentation: Add note about executor for managed cluster apps

Phil Zona requested to merge philbz-master-patch-98997 into master

What does this MR do?

We received a support ticket in which a customer was having problems running the Managed-Cluster-Applications.gitlab-ci.yml template. It turned out they were trying to use a runner with the shell executor.

It's common that people will have small instances with only a couple of runners registered for proof-of-concept type projects. Since this is an alpha feature, this will likely be the type of environment where customers will test it out.

Looking at the template, I think it's simple to tell this requires a Docker-based runner (from the image) keyword, but I also think that adding a short note here removes the need for a debugging step at all. This may be somewhat of an edge case, but if it helps make for a smoother developer experience I think it's worth including.

Related issues

Here's the customer ticket: https://gitlab.zendesk.com/agent/tickets/162997 (internal only)

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

  • Optional: 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.

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.
Edited by Phil Zona

Merge request reports