From bb760d9ed233c7349cd53ee90266b92807d7db51 Mon Sep 17 00:00:00 2001 From: Will Sean Don Date: Sun, 16 Apr 2017 22:33:55 -0700 Subject: [PATCH] Migrate federated deployment task to new template (#3432) * Migrate to new task template * Add prereq template for tasks and tutorials regarding federated clusters --- _includes/federated-task-tutorial-prereqs.md | 8 ++++ .../tasks/administer-federation/deployment.md | 42 +++++++++---------- 2 files changed, 27 insertions(+), 23 deletions(-) create mode 100644 _includes/federated-task-tutorial-prereqs.md diff --git a/_includes/federated-task-tutorial-prereqs.md b/_includes/federated-task-tutorial-prereqs.md new file mode 100644 index 0000000000..c5ec939c07 --- /dev/null +++ b/_includes/federated-task-tutorial-prereqs.md @@ -0,0 +1,8 @@ +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 diff --git a/docs/tasks/administer-federation/deployment.md b/docs/tasks/administer-federation/deployment.md index 51b092971d..ff37bafc78 100644 --- a/docs/tasks/administer-federation/deployment.md +++ b/docs/tasks/administer-federation/deployment.md @@ -2,38 +2,30 @@ title: Federated Deployment --- +{% capture overview %} This guide explains how to use Deployments in the Federation control plane. -* TOC -{:toc} - -## Prerequisites - -This guide assumes that you have a running Kubernetes Cluster -Federation installation. If not, then head over to the -[federation admin guide](/docs/admin/federation/) 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. - -You should also have a basic -[working knowledge of Kubernetes](/docs/getting-started-guides/) in -general and [Deployment](/docs/user-guide/deployments) in particular. - -## Overview - -Deployments in federation control plane (referred to as "Federated Deployments" in +Deployments in the federation control plane (referred to as "Federated Deployments" in this guide) are very similar to the traditional [Kubernetes -Deployment](/docs/user-guide/deployments/), and provide the same functionality. +Deployment](/docs/concepts/workloads/controllers/deployment/) and provide the same functionality. Creating them in the federation control plane ensures that the desired number of replicas exist across the registered clusters. **As of Kubernetes version 1.5, Federated Deployment is an Alpha feature. The core functionality of Deployment is present, but some features (such as full rollout compatibility) are still in development.** +{% endcapture %} +{% capture prerequisites %} + +* {% include federated-task-tutorial-prereqs.md %} +* You should also have a basic +[working knowledge of Kubernetes](/docs/setup/pick-right-solution/) in +general and [Deployments](/docs/concepts/workloads/controllers/deployment/) in particular. + +{% endcapture %} + +{% capture steps %} ## Creating a Federated Deployment The API for Federated Deployment is compatible with the @@ -69,7 +61,7 @@ Federated Deployment. ### Spreading Replicas in Underlying Clusters -By default, replicas are spread equally in all the underlying clusters. For ex: +By default, replicas are spread equally in all the underlying clusters. For example: if you have 3 registered clusters and you create a Federated Deployment with `spec.replicas = 9`, then each Deployment in the 3 clusters will have `spec.replicas=3`. @@ -106,3 +98,7 @@ For example, you can do that using kubectl by running: ```shell kubectl --context=federation-cluster delete deployment mydep ``` + +{% endcapture %} + +{% include templates/task.md %} \ No newline at end of file