Skip to content

Commit 13bfc5f

Browse files
authored
Merge pull request kubernetes-sigs#10534 from fabriziopandini/remove-staging-use-cases
📖 Drop docs not maintained
2 parents e632c07 + 8261acf commit 13bfc5f

File tree

5 files changed

+19
-426
lines changed

5 files changed

+19
-426
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
### 👋 Welcome to our project! Our [Book](https://cluster-api.sigs.k8s.io) can help you get started and provides lots of in-depth information.
1414

1515
#### Useful links
16-
- [Scope, objectives, goals and requirements](./docs/scope-and-objectives.md)
1716
- [Feature proposals](./docs/proposals)
18-
- [Reference use cases](./docs/staging-use-cases.md)
1917
- [Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html)
2018

2119
## ✨ What is the Cluster API?

docs/book/src/introduction.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,23 @@ However, while kubeadm and other bootstrap providers reduce installation complex
5555

5656
SIG Cluster Lifecycle began the Cluster API project as a way to address these gaps by building declarative, Kubernetes-style APIs, that automate cluster creation, configuration, and management. Using this model, Cluster API can also be extended to support any infrastructure provider (AWS, Azure, vSphere, etc.) or bootstrap provider (kubeadm is default) you need. See the growing list of [available providers](./reference/providers.md).
5757

58-
{{#include ../../scope-and-objectives.md:Goals}}
58+
### Goals
59+
60+
- To manage the lifecycle (create, scale, upgrade, destroy) of Kubernetes-conformant clusters using a declarative API.
61+
- To work in different environments, both on-premises and in the cloud.
62+
- To define common operations, provide a default implementation, and provide the ability to swap out implementations for alternative ones.
63+
- To reuse and integrate existing ecosystem components rather than duplicating their functionality (e.g. node-problem-detector, cluster autoscaler, SIG-Multi-cluster).
64+
- To provide a transition path for Kubernetes lifecycle products to adopt Cluster API incrementally. Specifically, existing cluster lifecycle management tools should be able to adopt Cluster API in a staged manner, over the course of multiple releases, or even adopting a subset of Cluster API.
65+
66+
### Non-goals
67+
68+
- To add these APIs to Kubernetes core (kubernetes/kubernetes).
69+
- This API should live in a namespace outside the core and follow the best practices defined by api-reviewers, but is not subject to core-api constraints.
70+
- To manage the lifecycle of infrastructure unrelated to the running of Kubernetes-conformant clusters.
71+
- To force all Kubernetes lifecycle products (kOps, Kubespray, GKE, AKS, EKS, IKS etc.) to support or use these APIs.
72+
- To manage non-Cluster API provisioned Kubernetes-conformant clusters.
73+
- To manage a single cluster spanning multiple infrastructure providers.
74+
- To configure a machine at any time other than create or upgrade.
75+
- To duplicate functionality that exists or is coming to other tooling, e.g., updating kubelet configuration (c.f. dynamic kubelet configuration), or updating apiserver, controller-manager, scheduler configuration (c.f. component-config effort) after the cluster is deployed.
5976

6077
{{#include ../../../README.md:Community}}

docs/scope-and-objectives.md

Lines changed: 0 additions & 177 deletions
This file was deleted.

0 commit comments

Comments
 (0)