Q1FY2023 KR: Refactor Kubernetes Management Documentation
Based on a request for additional focus, we will refactor the Kubernetes management workflow documentation.
Assumptions
- Approval of a proposed reorganization of Ops/Fulfillment stage writers.
- Sufficient Dev/PM support for technical questions and reviews.
- Suzanne is the DRI for the content design, refactoring, and reorganization of the content.
- Marcia, as the Configure group TW, provides technical expertise and additional refactoring support if necessary.
Steps for completion
-
Review the existing content and understand gaps and known issues -
Clearly outline the scope of the work -
Refactor 12 pages based on scope determination: - Done Connect cluster
- Done GitOps workflow (new page after separating from other content)
- Done CI/CD workflow (was CI/CD tunnel)
- Done Install the agent
- Done Work with the agent
- Done Migrate to agent
- Done Manage cluster applications
-
Done Track cluster resources (was
Inventory objects
) - Done Install GitLab Runner with the agent for Kubernetes
- Done Install the agent server
- Done Using the GitLab-KAS chart
- Done Troubleshoot (new page after separating from connect page)
-
Final polish, Vale fixes - Done Add naming conventions to the installation page: https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/identity_and_auth.md#L13 (gitlab!85635 (merged))
- Done Rename the ci_cd_tunnel.md and redirect to new.
- Done Rename repository.md to a better name and redirect to new.
- Done Change the runner install page to describe usage with the Runner Operator. While the docs says it's for OpenShift, the docs are wrong ... operators are for Kubernetes, they are just easy to use with OpenShift.
- From the same page, remove the plain text registration token and point to security docs.
- Make sure we link to this page from the other gitlab repo pages.
- Redirect the AWS and GKE pages to be in the new folder under
/user/clusters/connect
- Make sure all the troubleshooting content is in the right place.
Edited by Suzanne Selhorn