kubernetes-sigs / kubernetes-sigs/mcs-api

Intro tutorials for MCS API use cases

Open
#21 7 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted sig/multicluster
Dominant language
Go
Stars
261
Forks
49
Avg merge
2d 11h
Merged PRs (30d)
3

Description

Develop some vendor agnostic intro tutorials about the MCS API that can be easily digested as part of a generic documentation push. Keep them implementation agnostic but I think it would be useful to tie them to some common use cases as suggested below.

Ideas:
* MCS for a single-cluster stateful service serving multiple clusters (single ServiceExport case) (see [this walkthrough](https://cloud.google.com/kubernetes-engine/docs/how-to/migrate-gke-multi-cluster#migrate_to_multi-cluster_services) for some inspo)
* MCS for a same-named stateless service in clusters in different regions for simple failover (merged ServiceExport case)
* MCS for a same-named stateless service for blue-green upgrade (see [this video](https://youtu.be/hztXW7Hk6Vo) for example)

Contributor guide

Open the contributing guide

Research direction

Start with the three MCS API use cases listed in the issue, reviewing the linked GKE walkthrough and blue-green example for context. Draft vendor-agnostic introductory tutorials that explain each use case without implementation-specific steps, and confirm that all three scenarios are covered and readable as generic documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
distributed-systems, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.