kubermatic / kubermatic/docs

Write introduction to GitOps workflows for KKP CRDs

Open
#1,405 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/documentation
Dominant language
SCSS
Stars
19
Forks
117
Avg merge
13h 29m
Merged PRs (30d)
13

Description

We mention "GitOps" workflows (mostly interacting with KKP through the Kubernetes API directly) in several places, e.g. our release notes, but we should probably write a comprehensive introduction to how to use it, what limitations it has (in particular with RBAC), and how it can allow you to integrate with popular GitOps tools (without going into too much detail).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing release notes and documentation about KKP CRDs and direct Kubernetes API use to identify the current GitOps references. Document the workflow, RBAC limitations, and high-level integration options for popular GitOps tools without deep tool-specific instructions; done means the introduction is comprehensive and consistent with those references.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.