From 56021dc6710b7a12bda237cd475b43a92ea3c537 Mon Sep 17 00:00:00 2001 From: Dani Comnea Date: Tue, 12 Mar 2019 20:38:39 +0000 Subject: [PATCH] Reorganize Federation tasks so we have it group and under one topic (#12900) * Reorganize Federation tasks so we have it group and under one topic * Intended replacement --- .../concepts/cluster-administration/federation.md | 4 +++- .../docs/contribute/style/content-organization.md | 1 - content/en/docs/contribute/style/style-guide.md | 2 +- .../en/docs/tasks/administer-federation/_index.md | 5 ----- content/en/docs/tasks/federation/_index.md | 2 +- .../federation/administer-federation/_index.md | 5 +++++ .../administer-federation/cluster.md | 6 +++--- .../administer-federation/configmap.md | 6 +++--- .../administer-federation/daemonset.md | 6 +++--- .../administer-federation/deployment.md | 6 +++--- .../administer-federation/events.md | 6 +++--- .../{ => federation}/administer-federation/hpa.md | 6 +++--- .../administer-federation/ingress.md | 6 +++--- .../{ => federation}/administer-federation/job.md | 6 +++--- .../administer-federation/namespaces.md | 6 +++--- .../administer-federation/replicaset.md | 6 +++--- .../administer-federation/secret.md | 6 +++--- .../federation/federation-service-discovery.md | 9 +++++---- .../federation/set-up-cluster-federation-kubefed.md | 10 ++++++---- .../set-up-coredns-provider-federation.md | 7 ++++--- .../set-up-placement-policies-federation.md | 7 ++++--- content/en/docs/test.md | 2 +- .../en/includes/federated-task-tutorial-prereqs.md | 13 +++++-------- content/en/includes/federation-content-moved.md | 2 -- content/en/includes/federation-current-state.md | 1 - .../includes/federation-deprecation-warning-note.md | 3 +++ i18n/en.toml | 3 +++ layouts/shortcodes/deprecationfilewarning.html | 3 +++ static/css/callouts.css | 9 +++++++++ 29 files changed, 86 insertions(+), 68 deletions(-) delete mode 100755 content/en/docs/tasks/administer-federation/_index.md create mode 100755 content/en/docs/tasks/federation/administer-federation/_index.md rename content/en/docs/tasks/{ => federation}/administer-federation/cluster.md (97%) rename content/en/docs/tasks/{ => federation}/administer-federation/configmap.md (95%) rename content/en/docs/tasks/{ => federation}/administer-federation/daemonset.md (95%) rename content/en/docs/tasks/{ => federation}/administer-federation/deployment.md (97%) rename content/en/docs/tasks/{ => federation}/administer-federation/events.md (92%) rename content/en/docs/tasks/{ => federation}/administer-federation/hpa.md (98%) rename content/en/docs/tasks/{ => federation}/administer-federation/ingress.md (99%) rename content/en/docs/tasks/{ => federation}/administer-federation/job.md (97%) rename content/en/docs/tasks/{ => federation}/administer-federation/namespaces.md (96%) rename content/en/docs/tasks/{ => federation}/administer-federation/replicaset.md (97%) rename content/en/docs/tasks/{ => federation}/administer-federation/secret.md (96%) delete mode 100644 content/en/includes/federation-content-moved.md delete mode 100644 content/en/includes/federation-current-state.md create mode 100644 content/en/includes/federation-deprecation-warning-note.md create mode 100644 layouts/shortcodes/deprecationfilewarning.html diff --git a/content/en/docs/concepts/cluster-administration/federation.md b/content/en/docs/concepts/cluster-administration/federation.md index 16fc92d1f7..501568531b 100644 --- a/content/en/docs/concepts/cluster-administration/federation.md +++ b/content/en/docs/concepts/cluster-administration/federation.md @@ -6,7 +6,9 @@ weight: 80 {{% capture overview %}} -{{< include "federation-current-state.md" >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This page explains why and how to manage multiple Kubernetes clusters using federation. diff --git a/content/en/docs/contribute/style/content-organization.md b/content/en/docs/contribute/style/content-organization.md index a89e686ac9..e954c98118 100644 --- a/content/en/docs/contribute/style/content-organization.md +++ b/content/en/docs/contribute/style/content-organization.md @@ -108,7 +108,6 @@ Another widely used example is the `includes` bundle. It sets `headless: true` i en/includes ├── default-storage-class-prereqs.md ├── federated-task-tutorial-prereqs.md -├── federation-content-moved.md ├── index.md ├── partner-script.js ├── partner-style.css diff --git a/content/en/docs/contribute/style/style-guide.md b/content/en/docs/contribute/style/style-guide.md index 744989acdd..e0cc3f17d4 100644 --- a/content/en/docs/contribute/style/style-guide.md +++ b/content/en/docs/contribute/style/style-guide.md @@ -327,7 +327,7 @@ Shortcodes inside include statements will break the build. You must insert them ``` {{}} -{{}} +{{}} {{}} ``` diff --git a/content/en/docs/tasks/administer-federation/_index.md b/content/en/docs/tasks/administer-federation/_index.md deleted file mode 100755 index e3cb1fe59d..0000000000 --- a/content/en/docs/tasks/administer-federation/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Federation - Run an App on Multiple Clusters" -weight: 160 ---- - diff --git a/content/en/docs/tasks/federation/_index.md b/content/en/docs/tasks/federation/_index.md index fc7458f1d9..869c63fc6a 100755 --- a/content/en/docs/tasks/federation/_index.md +++ b/content/en/docs/tasks/federation/_index.md @@ -1,5 +1,5 @@ --- -title: "Federation - Run an App on Multiple Clusters" +title: "Federation" weight: 120 --- diff --git a/content/en/docs/tasks/federation/administer-federation/_index.md b/content/en/docs/tasks/federation/administer-federation/_index.md new file mode 100755 index 0000000000..555416fb9b --- /dev/null +++ b/content/en/docs/tasks/federation/administer-federation/_index.md @@ -0,0 +1,5 @@ +--- +title: "Administer Federation Control Plane" +weight: 160 +--- + diff --git a/content/en/docs/tasks/administer-federation/cluster.md b/content/en/docs/tasks/federation/administer-federation/cluster.md similarity index 97% rename from content/en/docs/tasks/administer-federation/cluster.md rename to content/en/docs/tasks/federation/administer-federation/cluster.md index 6e350f4b25..11afbbe159 100644 --- a/content/en/docs/tasks/administer-federation/cluster.md +++ b/content/en/docs/tasks/federation/administer-federation/cluster.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use Clusters API resource in a Federation control plane. diff --git a/content/en/docs/tasks/administer-federation/configmap.md b/content/en/docs/tasks/federation/administer-federation/configmap.md similarity index 95% rename from content/en/docs/tasks/administer-federation/configmap.md rename to content/en/docs/tasks/federation/administer-federation/configmap.md index 4123b4ab22..cf36e2e6ea 100644 --- a/content/en/docs/tasks/administer-federation/configmap.md +++ b/content/en/docs/tasks/federation/administer-federation/configmap.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use ConfigMaps in a Federation control plane. diff --git a/content/en/docs/tasks/administer-federation/daemonset.md b/content/en/docs/tasks/federation/administer-federation/daemonset.md similarity index 95% rename from content/en/docs/tasks/administer-federation/daemonset.md rename to content/en/docs/tasks/federation/administer-federation/daemonset.md index 54a04493f6..dd9ed4f93a 100644 --- a/content/en/docs/tasks/administer-federation/daemonset.md +++ b/content/en/docs/tasks/federation/administer-federation/daemonset.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use DaemonSets in a federation control plane. diff --git a/content/en/docs/tasks/administer-federation/deployment.md b/content/en/docs/tasks/federation/administer-federation/deployment.md similarity index 97% rename from content/en/docs/tasks/administer-federation/deployment.md rename to content/en/docs/tasks/federation/administer-federation/deployment.md index 624a527cfc..cf80b9610a 100644 --- a/content/en/docs/tasks/administer-federation/deployment.md +++ b/content/en/docs/tasks/federation/administer-federation/deployment.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use Deployments in the Federation control plane. diff --git a/content/en/docs/tasks/administer-federation/events.md b/content/en/docs/tasks/federation/administer-federation/events.md similarity index 92% rename from content/en/docs/tasks/administer-federation/events.md rename to content/en/docs/tasks/federation/administer-federation/events.md index e855afb3d1..2c8cfee4ff 100644 --- a/content/en/docs/tasks/administer-federation/events.md +++ b/content/en/docs/tasks/federation/administer-federation/events.md @@ -5,9 +5,9 @@ content_template: templates/concept {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use events in federation control plane to help in debugging. diff --git a/content/en/docs/tasks/administer-federation/hpa.md b/content/en/docs/tasks/federation/administer-federation/hpa.md similarity index 98% rename from content/en/docs/tasks/administer-federation/hpa.md rename to content/en/docs/tasks/federation/administer-federation/hpa.md index 496a7032a6..ee7c85482b 100644 --- a/content/en/docs/tasks/administer-federation/hpa.md +++ b/content/en/docs/tasks/federation/administer-federation/hpa.md @@ -7,9 +7,9 @@ content_template: templates/task {{< feature-state state="alpha" >}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use federated horizontal pod autoscalers (HPAs) in the federation control plane. diff --git a/content/en/docs/tasks/administer-federation/ingress.md b/content/en/docs/tasks/federation/administer-federation/ingress.md similarity index 99% rename from content/en/docs/tasks/administer-federation/ingress.md rename to content/en/docs/tasks/federation/administer-federation/ingress.md index 51bfce65d5..60b0d61845 100644 --- a/content/en/docs/tasks/administer-federation/ingress.md +++ b/content/en/docs/tasks/federation/administer-federation/ingress.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} 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 diff --git a/content/en/docs/tasks/administer-federation/job.md b/content/en/docs/tasks/federation/administer-federation/job.md similarity index 97% rename from content/en/docs/tasks/administer-federation/job.md rename to content/en/docs/tasks/federation/administer-federation/job.md index d495d1e42e..77f98836dd 100644 --- a/content/en/docs/tasks/administer-federation/job.md +++ b/content/en/docs/tasks/federation/administer-federation/job.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use jobs in the federation control plane. diff --git a/content/en/docs/tasks/administer-federation/namespaces.md b/content/en/docs/tasks/federation/administer-federation/namespaces.md similarity index 96% rename from content/en/docs/tasks/administer-federation/namespaces.md rename to content/en/docs/tasks/federation/administer-federation/namespaces.md index e2e58af005..71019d81f0 100644 --- a/content/en/docs/tasks/administer-federation/namespaces.md +++ b/content/en/docs/tasks/federation/administer-federation/namespaces.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use Namespaces in Federation control plane. diff --git a/content/en/docs/tasks/administer-federation/replicaset.md b/content/en/docs/tasks/federation/administer-federation/replicaset.md similarity index 97% rename from content/en/docs/tasks/administer-federation/replicaset.md rename to content/en/docs/tasks/federation/administer-federation/replicaset.md index 932abd7095..0ffef6a692 100644 --- a/content/en/docs/tasks/administer-federation/replicaset.md +++ b/content/en/docs/tasks/federation/administer-federation/replicaset.md @@ -5,9 +5,9 @@ content_template: templates/task {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use ReplicaSets in the Federation control plane. diff --git a/content/en/docs/tasks/administer-federation/secret.md b/content/en/docs/tasks/federation/administer-federation/secret.md similarity index 96% rename from content/en/docs/tasks/administer-federation/secret.md rename to content/en/docs/tasks/federation/administer-federation/secret.md index 2de0d059a8..e50fd13005 100644 --- a/content/en/docs/tasks/administer-federation/secret.md +++ b/content/en/docs/tasks/federation/administer-federation/secret.md @@ -5,9 +5,9 @@ content_template: templates/concept {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use secrets in Federation control plane. diff --git a/content/en/docs/tasks/federation/federation-service-discovery.md b/content/en/docs/tasks/federation/federation-service-discovery.md index 40eb05b55c..ea06eaa17f 100644 --- a/content/en/docs/tasks/federation/federation-service-discovery.md +++ b/content/en/docs/tasks/federation/federation-service-discovery.md @@ -1,16 +1,17 @@ --- +title: Cross-cluster Service Discovery using Federated Services reviewers: - bprashanth - quinton-hoole content_template: templates/task -title: Cross-cluster Service Discovery using Federated Services +weight: 140 --- {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This guide explains how to use Kubernetes Federated Services to deploy a common Service across multiple Kubernetes clusters. This makes it diff --git a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md index 654e756b1b..9a751661e8 100644 --- a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md +++ b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -1,14 +1,16 @@ --- +title: Set up Cluster Federation with Kubefed reviewers: - madhusudancs content_template: templates/task -title: Set up Cluster Federation with Kubefed +weight: 125 --- {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} + +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} Kubernetes version 1.5 and above includes a new command line tool called [`kubefed`](/docs/admin/kubefed/) to help you administrate your federated diff --git a/content/en/docs/tasks/federation/set-up-coredns-provider-federation.md b/content/en/docs/tasks/federation/set-up-coredns-provider-federation.md index b2379f79b9..572a348a82 100644 --- a/content/en/docs/tasks/federation/set-up-coredns-provider-federation.md +++ b/content/en/docs/tasks/federation/set-up-coredns-provider-federation.md @@ -1,13 +1,14 @@ --- title: Set up CoreDNS as DNS provider for Cluster Federation content_template: templates/tutorial +weight: 130 --- {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This page shows how to configure and deploy CoreDNS to be used as the DNS provider for Cluster Federation. diff --git a/content/en/docs/tasks/federation/set-up-placement-policies-federation.md b/content/en/docs/tasks/federation/set-up-placement-policies-federation.md index cb1e02d8cf..957702d02e 100644 --- a/content/en/docs/tasks/federation/set-up-placement-policies-federation.md +++ b/content/en/docs/tasks/federation/set-up-placement-policies-federation.md @@ -1,13 +1,14 @@ --- title: Set up placement policies in Federation content_template: templates/task +weight: 135 --- {{% capture overview %}} -{{< note >}} -{{< include "federation-current-state.md" >}} -{{< /note >}} +{{< deprecationfilewarning >}} +{{< include "federation-deprecation-warning-note.md" >}} +{{< /deprecationfilewarning >}} This page shows how to enforce policy-based placement decisions over Federated resources using an external policy engine. diff --git a/content/en/docs/test.md b/content/en/docs/test.md index e7faf57d12..1e682f538d 100644 --- a/content/en/docs/test.md +++ b/content/en/docs/test.md @@ -344,7 +344,7 @@ Warnings point out something that could cause harm if ignored. To add shortcodes to includes. {{< note >}} -{{< include "federation-current-state.md" >}} +{{< include "task-tutorial-prereqs.md" >}} {{< /note >}} ## Katacoda Embedded Live Environment diff --git a/content/en/includes/federated-task-tutorial-prereqs.md b/content/en/includes/federated-task-tutorial-prereqs.md index c5ec939c07..b254407a67 100644 --- a/content/en/includes/federated-task-tutorial-prereqs.md +++ b/content/en/includes/federated-task-tutorial-prereqs.md @@ -1,8 +1,5 @@ -This guide assumes that you have a running Kubernetes Cluster -Federation installation. If not, then head over to the -[federation admin guide](/docs/tutorials/federation/set-up-cluster-federation-kubefed/) to learn how to -bring up a cluster federation (or have your cluster administrator do -this for you). -Other tutorials, such as Kelsey Hightower's -[Federated Kubernetes Tutorial](https://github.com/kelseyhightower/kubernetes-cluster-federation), -might also help you create a Federated Kubernetes cluster. \ No newline at end of file +This guide assumes that you have a running Kubernetes Cluster Federation installation. +If not, then head over to the [federation admin guide](/docs/tutorials/federation/set-up-cluster-federation-kubefed/) to learn how to +bring up a cluster federation (or have your cluster administrator do this for you). +Other tutorials, such as Kelsey Hightower's [Federated Kubernetes Tutorial](https://github.com/kelseyhightower/kubernetes-cluster-federation), +might also help you create a Federated Kubernetes cluster. diff --git a/content/en/includes/federation-content-moved.md b/content/en/includes/federation-content-moved.md deleted file mode 100644 index 87a10e7199..0000000000 --- a/content/en/includes/federation-content-moved.md +++ /dev/null @@ -1,2 +0,0 @@ -The topics in the [Federation API](/docs/federation/api-reference/) section of the Kubernetes docs -are being moved to the [Reference](/docs/reference/) section. The content in this topic has moved to: diff --git a/content/en/includes/federation-current-state.md b/content/en/includes/federation-current-state.md deleted file mode 100644 index d04fda15e0..0000000000 --- a/content/en/includes/federation-current-state.md +++ /dev/null @@ -1 +0,0 @@ -`Federation V1`, the current Kubernetes federation API which reuses the Kubernetes API resources 'as is', is currently considered alpha for many of its features. 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 are available at [sig-multicluster community page](https://github.com/kubernetes/community/tree/master/sig-multicluster). diff --git a/content/en/includes/federation-deprecation-warning-note.md b/content/en/includes/federation-deprecation-warning-note.md new file mode 100644 index 0000000000..b7a05b1077 --- /dev/null +++ b/content/en/includes/federation-deprecation-warning-note.md @@ -0,0 +1,3 @@ +Use of `Federation v1` is strongly discouraged. `Federation V1` never achieved GA status and is no longer under active development. Documentation is for historical purposes only. + +For more information, see the intended replacement, [Kubernetes Federation v2](https://github.com/kubernetes-sigs/federation-v2). diff --git a/i18n/en.toml b/i18n/en.toml index 283eeb7262..e841e1952b 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -3,6 +3,9 @@ [deprecation_warning] other = " documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see " +[deprecation_file_warning] +other = "Deprecated" + [objectives_heading] other = "Objectives" diff --git a/layouts/shortcodes/deprecationfilewarning.html b/layouts/shortcodes/deprecationfilewarning.html new file mode 100644 index 0000000000..48e2f43c98 --- /dev/null +++ b/layouts/shortcodes/deprecationfilewarning.html @@ -0,0 +1,3 @@ +
+

{{ T "deprecation_file_warning" }}

{{ .Inner | markdownify }}
+
diff --git a/static/css/callouts.css b/static/css/callouts.css index 22f73d0802..ffc61ed4a5 100644 --- a/static/css/callouts.css +++ b/static/css/callouts.css @@ -49,3 +49,12 @@ color: #a94442; border-color: #ebccd1; } + +.deprecation_file_warning { + padding: 20px; + margin: 20px 0; + border: 1px solid #eee; + border-left-color: #d9534f; + border-left-width: 5px; + border-radius: 3px; +}