Agent for Kubernetes docs update for manifest sync in Premium
What does this MR do?
https://forum.gitlab.com/t/gitlab-ce-14-5-0-kubernetes-agent/61844/12 says that the docs in https://docs.gitlab.com/ee/user/clusters/agent/install/ imply that everything is in Free.
I started analysing the forum topic, to understand the user's flow how they came to a non-working state.
We provide a minimal example configuration, which uses the gitops
keyword and shows how to sync manifests. From there, it is not clear that this is a Premium feature; you really need to click on the URL to see the Premium
tier chapter marker over there.
Following the path, the user copied the gitops
configuration for their CE free tier setup. This errored out on the KAS server, and led to debugging questions.
This MR is to address the example configuration, and split it into two parts:
- Show the CI/CD tunnel access (free tier)
- Show the manifest sync gitops config (Premium marker)
That way, users can decide the flow in the documentation whether to use the free or premium configuration, and learn more in the linked chapter then.
The MR introduces a bit of config duplication, but avoids confusion until we decide whether to move the gitops
feature to all tiers in #346567 (closed)
Related issues
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are 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.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.