From 0db688228890e2826676a477c348931b95ecd25f Mon Sep 17 00:00:00 2001 From: Irfan Ur Rehman Date: Fri, 27 Apr 2018 01:19:29 +0530 Subject: [PATCH] Update a note indicating current state of Federation V1 (#8165) * Update a note indicating current state of federation V1 * change horizontal line to
* edit note * capitalize Kubernetes *
unnecessary w/ note callout --- _includes/federation-current-state.md | 7 +++++++ docs/tasks/administer-federation/cluster.md | 2 ++ docs/tasks/administer-federation/configmap.md | 2 ++ docs/tasks/administer-federation/daemonset.md | 3 +++ docs/tasks/administer-federation/deployment.md | 3 +++ docs/tasks/administer-federation/events.md | 2 ++ docs/tasks/administer-federation/hpa.md | 2 ++ docs/tasks/administer-federation/ingress.md | 3 +++ docs/tasks/administer-federation/job.md | 3 +++ docs/tasks/administer-federation/namespaces.md | 3 +++ docs/tasks/administer-federation/replicaset.md | 3 +++ docs/tasks/administer-federation/secret.md | 2 ++ docs/tasks/federation/federation-service-discovery.md | 2 ++ docs/tasks/federation/set-up-cluster-federation-kubefed.md | 2 ++ .../tasks/federation/set-up-coredns-provider-federation.md | 2 ++ .../federation/set-up-placement-policies-federation.md | 2 ++ 16 files changed, 43 insertions(+) create mode 100644 _includes/federation-current-state.md diff --git a/_includes/federation-current-state.md b/_includes/federation-current-state.md new file mode 100644 index 0000000000..56e4decdf3 --- /dev/null +++ b/_includes/federation-current-state.md @@ -0,0 +1,7 @@ +**Note:** `Federation V1`, the current Kubernetes federation API which reuses the Kubernetes API +resources 'as is', is currently considered alpha for many of its features, and there is no clear +path to evolve the API to GA. However, there is a `Federation V2` effort in progress to implement +a dedicated federation API apart from the Kubernetes API. The details can be found at +[sig-multicluster community page](https://github.com/kubernetes/community/tree/master/sig-multicluster). +{: .note} + diff --git a/docs/tasks/administer-federation/cluster.md b/docs/tasks/administer-federation/cluster.md index 4c4fa8f2c7..4859133631 100644 --- a/docs/tasks/administer-federation/cluster.md +++ b/docs/tasks/administer-federation/cluster.md @@ -4,6 +4,8 @@ title: Federated Cluster {% capture overview %} +{% include federation-current-state.md %} + This guide explains how to use Clusters API resource in a Federation control plane. Different than other Kubernetes resources, such as Deployments, Services and ConfigMaps, diff --git a/docs/tasks/administer-federation/configmap.md b/docs/tasks/administer-federation/configmap.md index 0652f73444..2df307d245 100644 --- a/docs/tasks/administer-federation/configmap.md +++ b/docs/tasks/administer-federation/configmap.md @@ -4,6 +4,8 @@ title: Federated ConfigMap {% capture overview %} +{% include federation-current-state.md %} + This guide explains how to use ConfigMaps in a Federation control plane. Federated ConfigMaps are very similar to the traditional [Kubernetes diff --git a/docs/tasks/administer-federation/daemonset.md b/docs/tasks/administer-federation/daemonset.md index 0b79f261e4..03083631f8 100644 --- a/docs/tasks/administer-federation/daemonset.md +++ b/docs/tasks/administer-federation/daemonset.md @@ -3,6 +3,9 @@ title: Federated DaemonSet --- {% capture overview %} + +{% include federation-current-state.md %} + This guide explains how to use DaemonSets in a federation control plane. DaemonSets in the federation control plane ("Federated Daemonsets" in diff --git a/docs/tasks/administer-federation/deployment.md b/docs/tasks/administer-federation/deployment.md index a15cd4620d..c5d985c1e3 100644 --- a/docs/tasks/administer-federation/deployment.md +++ b/docs/tasks/administer-federation/deployment.md @@ -3,6 +3,9 @@ title: Federated Deployment --- {% capture overview %} + +{% include federation-current-state.md %} + This guide explains how to use Deployments in the Federation control plane. Deployments in the federation control plane (referred to as "Federated Deployments" in diff --git a/docs/tasks/administer-federation/events.md b/docs/tasks/administer-federation/events.md index a6e7651f23..2464ff2383 100644 --- a/docs/tasks/administer-federation/events.md +++ b/docs/tasks/administer-federation/events.md @@ -2,6 +2,8 @@ title: Federated Events --- +{% include federation-current-state.md %} + This guide explains how to use events in federation control plane to help in debugging. diff --git a/docs/tasks/administer-federation/hpa.md b/docs/tasks/administer-federation/hpa.md index ee5f14f7c1..b227b90052 100644 --- a/docs/tasks/administer-federation/hpa.md +++ b/docs/tasks/administer-federation/hpa.md @@ -6,6 +6,8 @@ title: Federated Horizontal Pod Autoscalers (HPA) {% include feature-state-alpha.md %} +{% include federation-current-state.md %} + This guide explains how to use federated horizontal pod autoscalers (HPAs) in the federation control plane. HPAs in the federation control plane are similar to the traditional [Kubernetes diff --git a/docs/tasks/administer-federation/ingress.md b/docs/tasks/administer-federation/ingress.md index 5e0b5e8188..ddbdeb2f3b 100644 --- a/docs/tasks/administer-federation/ingress.md +++ b/docs/tasks/administer-federation/ingress.md @@ -3,6 +3,9 @@ title: Federated Ingress --- {% capture overview %} + +{% include federation-current-state.md %} + This page explains how to use Kubernetes Federated Ingress to deploy a common HTTP(S) virtual IP load balancer across a federated service running in multiple Kubernetes clusters. As of v1.4, clusters hosted in Google diff --git a/docs/tasks/administer-federation/job.md b/docs/tasks/administer-federation/job.md index 6835dc2541..e45e65e285 100644 --- a/docs/tasks/administer-federation/job.md +++ b/docs/tasks/administer-federation/job.md @@ -3,6 +3,9 @@ title: Federated Jobs --- {% capture overview %} + +{% include federation-current-state.md %} + This guide explains how to use jobs in the federation control plane. Jobs in the federation control plane (referred to as "federated jobs" in diff --git a/docs/tasks/administer-federation/namespaces.md b/docs/tasks/administer-federation/namespaces.md index 45f85d1c2c..f507f1f138 100644 --- a/docs/tasks/administer-federation/namespaces.md +++ b/docs/tasks/administer-federation/namespaces.md @@ -3,6 +3,9 @@ title: Federated Namespaces --- {% capture overview %} + +{% include federation-current-state.md %} + This guide explains how to use Namespaces in Federation control plane. Namespaces in federation control plane (referred to as "federated Namespaces" in diff --git a/docs/tasks/administer-federation/replicaset.md b/docs/tasks/administer-federation/replicaset.md index c7cca9f6d4..cd4d8a9fd7 100644 --- a/docs/tasks/administer-federation/replicaset.md +++ b/docs/tasks/administer-federation/replicaset.md @@ -3,6 +3,9 @@ title: Federated ReplicaSets --- {% capture overview %} + +{% include federation-current-state.md %} + This guide explains how to use ReplicaSets in the Federation control plane. ReplicaSets in the federation control plane (referred to as "federated ReplicaSets" in diff --git a/docs/tasks/administer-federation/secret.md b/docs/tasks/administer-federation/secret.md index 9b1ee128be..bd16499cf0 100644 --- a/docs/tasks/administer-federation/secret.md +++ b/docs/tasks/administer-federation/secret.md @@ -2,6 +2,8 @@ title: Federated Secrets --- +{% include federation-current-state.md %} + This guide explains how to use secrets in Federation control plane. * TOC diff --git a/docs/tasks/federation/federation-service-discovery.md b/docs/tasks/federation/federation-service-discovery.md index add75c4cda..d0a97dd57b 100644 --- a/docs/tasks/federation/federation-service-discovery.md +++ b/docs/tasks/federation/federation-service-discovery.md @@ -5,6 +5,8 @@ reviewers: title: Cross-cluster Service Discovery using Federated Services --- +{% include federation-current-state.md %} + This guide explains how to use Kubernetes Federated Services to deploy a common Service across multiple Kubernetes clusters. This makes it easy to achieve cross-cluster service discovery and availability zone diff --git a/docs/tasks/federation/set-up-cluster-federation-kubefed.md b/docs/tasks/federation/set-up-cluster-federation-kubefed.md index 73eecf2a75..ac895886e0 100644 --- a/docs/tasks/federation/set-up-cluster-federation-kubefed.md +++ b/docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -4,6 +4,8 @@ reviewers: title: Set up Cluster Federation with Kubefed --- +{% include federation-current-state.md %} + * TOC {:toc} diff --git a/docs/tasks/federation/set-up-coredns-provider-federation.md b/docs/tasks/federation/set-up-coredns-provider-federation.md index aead3266ec..b57e64f59c 100644 --- a/docs/tasks/federation/set-up-coredns-provider-federation.md +++ b/docs/tasks/federation/set-up-coredns-provider-federation.md @@ -4,6 +4,8 @@ title: Set up CoreDNS as DNS provider for Cluster Federation {% capture overview %} +{% include federation-current-state.md %} + This page shows how to configure and deploy CoreDNS to be used as the DNS provider for Cluster Federation. diff --git a/docs/tasks/federation/set-up-placement-policies-federation.md b/docs/tasks/federation/set-up-placement-policies-federation.md index a86f6bffaa..fe3b497d82 100644 --- a/docs/tasks/federation/set-up-placement-policies-federation.md +++ b/docs/tasks/federation/set-up-placement-policies-federation.md @@ -4,6 +4,8 @@ title: Set up placement policies in Federation {% capture overview %} +{% include federation-current-state.md %} + This page shows how to enforce policy-based placement decisions over Federated resources using an external policy engine.