Skip to content

Commit ef0f7ee

Browse files
committed
Rewrite README intro
1 parent 105f9dc commit ef0f7ee

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Kubernetes projects require that you sign a Contributor License Agreement (CLA)
66

77
## Learn About Kubernetes Cluster Federation
88
If you want to learn about KubeFed, please read through the doc:
9-
https://github.com/kubernetes-sigs/kubefed#kubefed
9+
https://github.com/kubernetes-sigs/kubefed#kubernetes-cluster-federation
1010

1111
To learn how to use Kubernetes Cluster Federation, please read through the User Guide:
1212
https://github.com/kubernetes-sigs/kubefed/blob/master/docs/userguide.md

README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,16 @@
66

77
# Kubernetes Cluster Federation
88

9-
This repo contains an in-progress prototype of some of the
10-
foundational aspects of Kubernetes Cluster Federation. The prototype
11-
builds on the sync controller (a.k.a. push reconciler) from
12-
[Federation v1](https://github.com/kubernetes/federation/) to iterate
13-
on the API concepts laid down in the [brainstorming
14-
doc](https://docs.google.com/document/d/159cQGlfgXo6O4WxXyWzjZiPoIuiHVl933B43xhmqPEE/edit#)
15-
and further refined in the [architecture
16-
doc](https://docs.google.com/document/d/1ihWETo-zE8U_QNuzw5ECxOWX0Df_2BVfO3lC4OesKRQ/edit#).
17-
Access to both documents is available to members of the
18-
[kubernetes-sig-multicluster google
19-
group](https://groups.google.com/forum/#!forum/kubernetes-sig-multicluster).
9+
Kubernetes Cluster Federation (KubeFed for short) allows you to coordinate the
10+
configuration of multiple Kubernetes clusters from a single set of APIs in a
11+
hosting cluster. KubeFed aims to provide mechanisms for expressing which
12+
clusters should have their configuration managed and what that configuration
13+
should be. The mechanisms that KubeFed provides are intentionally low-level, and
14+
intended to be foundational for more complex multicluster use cases such as
15+
deploying multi-geo applications and disaster recovery.
16+
17+
KubeFed is currently **alpha** and moving rapidly toward its initial
18+
[beta release](https://github.com/kubernetes-sigs/kubefed/milestone/4).
2019

2120
## Concepts
2221

0 commit comments

Comments
 (0)