kubernetes-sigs/mcs-api

Intro tutorials for MCS API use cases

Open

#21 opened on Nov 17, 2022

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (45 forks)auto 404
good first issuehelp wantedsig/multicluster

Repository metrics

Stars
 (260 stars)
PR merge metrics
 (PR metrics pending)

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 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 for example)

Contributor guide

Research direction
Research the three suggested use cases for MCS API: single cluster stateful service, same named stateless service for failover, and same named stateless service for blue green upgrade. Study existing walkthroughs and videos to understand the patterns. Write vendor agnostic, implementation agnostic tutorials focusing on the concepts and steps without tying to specific providers.
Tech stack
gokubernetes
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Kubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90