Skip to content

Commit af2976b

Browse files
committed
Address review comments.
1 parent 80f4dc4 commit af2976b

File tree

1 file changed

+56
-56
lines changed

1 file changed

+56
-56
lines changed

docs/admin/federation/index.md

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This guide explains how to set up cluster federation that lets us control multip
1313

1414
## Prerequisites
1515

16-
This guide assumes that we have a running Kubernetes cluster.
16+
This guide assumes that you have a running Kubernetes cluster.
1717
If not, then head over to the [getting started guides](/docs/getting-started-guides/) to bring up a cluster.
1818

19-
This guide also assumes that we have a Kubernetes release
19+
This guide also assumes that you have a Kubernetes release
2020
[downloaded from here](/docs/getting-started-guides/binary_release/),
2121
extracted into a directory and all the commands in this guide are run from
2222
that directory.
@@ -34,7 +34,7 @@ guide.
3434

3535
Setting up federation requires running the federation control plane which
3636
consists of etcd, federation-apiserver (via the hyperkube binary) and
37-
federation-controller-manager (also via the hyperkube binary). We can run
37+
federation-controller-manager (also via the hyperkube binary). You can run
3838
these binaries as pods on an existing Kubernetes cluster.
3939

4040
Note: This is a new mechanism to turn up Kubernetes Cluster Federation. If
@@ -61,7 +61,7 @@ Initialize the setup.
6161
$ federation/deploy/deploy.sh init
6262
```
6363

64-
Optionally we can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to
64+
Optionally, you can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to
6565
customize any value in
6666
[federation/federation/manifests/federation/values.yaml](https://github.com/madhusudancs/kubernetes-anywhere/blob/federation/federation/manifests/federation/values.yaml). Example:
6767

@@ -72,38 +72,38 @@ controllerManagerRegistry: "gcr.io/myrepository"
7272
controllerManagerVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b"
7373
```
7474
75-
Assuming we have built and pushed the `hyperkube` image to the repository
75+
Assuming you have built and pushed the `hyperkube` image to the repository
7676
with the given tag in the example above.
7777

7878
### Getting images
7979

80-
To run the federation control plane components as pods, we first need the
81-
images for all the components. We can either use the official release
82-
images or we can build them ourselves from HEAD.
80+
To run the federation control plane components as pods, you first need the
81+
images for all the components. You can either use the official release
82+
images or you can build them yourself from HEAD.
8383

8484
### Using official release images
8585

8686
As part of every Kubernetes release, official release images are pushed to
87-
`gcr.io/google_containers`. To use the images in this repository, we can
88-
just set the container image fields in the following configs to point
89-
to the images in this repository. `gcr.io/google_containers/hyperkube`
90-
image includes the federation-apiserver and federation-controller-manager
91-
binaries, so we can point the corresponding configs for those components
87+
`gcr.io/google_containers`. To use the images in this repository, you can
88+
set the container image fields in the following configs to point to the
89+
images in this repository. `gcr.io/google_containers/hyperkube` image
90+
includes the federation-apiserver and federation-controller-manager
91+
binaries, so you can point the corresponding configs for those components
9292
to the hyperkube image.
9393

9494
### Building and pushing images from HEAD
9595

96-
To run the code from HEAD, we need to build and push our own images.
97-
Assuming that we have checked out the
98-
[Kuberntes repository](https://github.com/kubernetes/kubernetes) and
99-
running these commands from the root of the source directory, we can
100-
build the binaries using the following command:
96+
To run the code from HEAD, you need to build and push your own images.
97+
Check out the
98+
[Kubernetes repository](https://github.com/kubernetes/kubernetes)
99+
and run the following commands from the root of the source directory.
100+
To build the binaries, run the following command:
101101

102102
```shell
103103
$ federation/develop/develop.sh build_binaries
104104
```
105105

106-
We can build the image and push it to the repository by running:
106+
To build the image and push it to the repository run:
107107

108108
```shell
109109
$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image
@@ -119,15 +119,15 @@ images from source.
119119

120120
### Running the federation control plane
121121

122-
Once we have the images, we can turn up the federation control plane by
122+
Once you have the images, you can turn up the federation control plane by
123123
running:
124124

125125
```shell
126126
$ federation/deploy/deploy.sh deploy_federation
127127
```
128128

129129
This spins up the federation control components as pods managed by
130-
[`Deployments`](http://kubernetes.io/docs/user-guide/deployments/) on our
130+
[`Deployments`](http://kubernetes.io/docs/user-guide/deployments/) on your
131131
existing Kubernetes cluster. It also starts a
132132
[`type: LoadBalancer`](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer)
133133
[`Service`](http://kubernetes.io/docs/user-guide/services/) for the
@@ -137,7 +137,7 @@ by a dynamically provisioned
137137
[`PV`](http://kubernetes.io/docs/user-guide/persistent-volumes/) for
138138
`etcd`. All these components are created in the `federation` namespace.
139139

140-
We can verify that the pods are available by running the following
140+
You can verify that the pods are available by running the following
141141
command:
142142

143143
```shell
@@ -147,8 +147,8 @@ federation-apiserver 1 1 1 1 1m
147147
federation-controller-manager 1 1 1 1 1m
148148
```
149149

150-
Running `deploy.sh` also creates a new record in our kubeconfig for us
151-
to be able to talk to federation apiserver. We can view this by running
150+
Running `deploy.sh` also creates a new record in your kubeconfig for us
151+
to be able to talk to federation apiserver. You can view this by running
152152
`kubectl config view`.
153153

154154
Note: Dynamic provisioning for persistent volume currently works only on
@@ -157,19 +157,19 @@ your needs, if required.
157157

158158
## Registering Kubernetes clusters with federation
159159

160-
Now that we have the federation control plane up and running, we can start registering Kubernetes clusters.
160+
Now that you have the federation control plane up and running, you can start registering Kubernetes clusters.
161161

162-
First of all, we need to create a secret containing kubeconfig for that Kubernetes cluster, which federation control plane will use to talk to that Kubernetes cluster.
163-
For now, we create this secret in the host Kubernetes cluster (that hosts federation control plane). When we start supporting secrets in federation control plane, we will create this secret there.
164-
Suppose that our kubeconfig for Kubernetes cluster is at `/cluster1/kubeconfig`, we can run the following command to create the secret:
162+
First of all, you need to create a secret containing kubeconfig for that Kubernetes cluster, which federation control plane will use to talk to that Kubernetes cluster.
163+
For now, you can create this secret in the host Kubernetes cluster (that hosts federation control plane). When federation starts supporting secrets, you will be able to create this secret there.
164+
Suppose that your kubeconfig for Kubernetes cluster is at `/cluster1/kubeconfig`, you can run the following command to create the secret:
165165

166166
```shell
167167
$ kubectl create secret generic cluster1 --namespace=federation --from-file=/cluster1/kubeconfig
168168
```
169169

170170
Note that the file name should be `kubeconfig` since file name determines the name of the key in the secret.
171171

172-
Now that the secret is created, we are ready to register the cluster. The YAML file for cluster will look like:
172+
Now that the secret is created, you are ready to register the cluster. The YAML file for cluster will look like:
173173

174174
```yaml
175175
apiVersion: federation/v1beta1
@@ -184,25 +184,25 @@ spec:
184184
name: <secret-name>
185185
```
186186

187-
We need to insert the appropriate values for `<client-cidr>`, `<apiserver-address>` and `<secret-name>`.
188-
`<secret-name>` here is name of the secret that we just created.
187+
You need to insert the appropriate values for `<client-cidr>`, `<apiserver-address>` and `<secret-name>`.
188+
`<secret-name>` here is name of the secret that you just created.
189189
serverAddressByClientCIDRs contains the various server addresses that clients
190-
can use as per their CIDR. We can set the server's public IP address with CIDR
191-
`"0.0.0.0/0"` which all clients will match. In addition, if we want internal
192-
clients to use server's clusterIP, we can set that as serverAddress. The client
190+
can use as per their CIDR. You can set the server's public IP address with CIDR
191+
`"0.0.0.0/0"` which all clients will match. In addition, if you want internal
192+
clients to use server's clusterIP, you can set that as serverAddress. The client
193193
CIDR in that case will be a CIDR that only matches IPs of pods running in that
194194
cluster.
195195

196-
Assuming our YAML file is located at `/cluster1/cluster.yaml`, we can run the following command to register this cluster:
196+
Assuming your YAML file is located at `/cluster1/cluster.yaml`, you can run the following command to register this cluster:
197197

198198
<!-- TODO(madhusudancs): Make the kubeconfig context configurable with default set to `federation` -->
199199
```shell
200200
$ kubectl create -f /cluster1/cluster.yaml --context=federation-cluster
201201
202202
```
203203

204-
By specifying `--context=federation-cluster`, we direct the request to
205-
federation apiserver. We can ensure that the cluster registration was
204+
By specifying `--context=federation-cluster`, you direct the request to
205+
federation apiserver. You can ensure that the cluster registration was
206206
successful by running:
207207

208208
```shell
@@ -213,16 +213,16 @@ cluster1 Ready 3m
213213

214214
## Updating KubeDNS
215215

216-
Once the cluster is registered with the federation, we are all ready to use it.
217-
But for the cluster to be able to route federation service requests, we need to restart
216+
Once the cluster is registered with the federation, you are all set to use it.
217+
But for the cluster to be able to route federation service requests, you need to restart
218218
KubeDNS and pass it a `--federations` flag which tells it about valid federation DNS hostnames.
219219
Format of the flag is like this:
220220

221221
```
222222
--federations=${FEDERATION_NAME}=${DNS_DOMAIN_NAME}
223223
```
224224

225-
To update KubeDNS with federations flag, we can edit the existing kubedns replication controller to
225+
To update KubeDNS with federations flag, you can edit the existing kubedns replication controller to
226226
include that flag in pod template spec and then delete the existing pod. Replication controller will
227227
recreate the pod with updated template.
228228

@@ -253,7 +253,7 @@ And then delete it by running:
253253
$ kubectl delete pods <pod-name> --namespace=kube-system
254254
```
255255

256-
We are now all set to start using federation.
256+
You are now all set to start using federation.
257257

258258
## Turn down
259259

@@ -274,29 +274,29 @@ why the new mechanism doesn't work for your case by filing an issue here -
274274

275275
### Getting images
276276

277-
To run these as pods, we first need images for all the components. We can use
278-
official release images or we can build from HEAD.
277+
To run these as pods, you first need images for all the components. You can use
278+
official release images or you can build from HEAD.
279279

280280
#### Using official release images
281281

282282
As part of every release, images are pushed to `gcr.io/google_containers`. To use
283-
these images, we set env var `FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers`
283+
these images, set env var `FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers`
284284
This will always use the latest image.
285285
To use the hyperkube image which includes federation-apiserver and
286-
federation-controller-manager from a specific release, we can set
287-
`FEDERATION_IMAGE_TAG`.
286+
federation-controller-manager from a specific release, set the
287+
`FEDERATION_IMAGE_TAG` environment variable.
288288

289289
#### Building and pushing images from HEAD
290290

291-
To run the code from HEAD, we need to build and push our own images.
292-
We can build the images using the following command:
291+
To run the code from HEAD, you need to build and push your own images.
292+
You can build the images using the following command:
293293

294294
```shell
295295
$ FEDERATION=true KUBE_RELEASE_RUN_TESTS=n make quick-release
296296
```
297297

298-
Next, we need to push these images to a registry such as Google Container Registry or Docker Hub, so that our cluster can pull them.
299-
If Kubernetes cluster is running on Google Compute Engine (GCE), then we can push the images to `gcr.io/<gce-project-name>`.
298+
Next, you need to push these images to a registry such as Google Container Registry or Docker Hub, so that your cluster can pull them.
299+
If Kubernetes cluster is running on Google Compute Engine (GCE), then you can push the images to `gcr.io/<gce-project-name>`.
300300
The command to push the images will look like:
301301

302302
```shell
@@ -305,7 +305,7 @@ $ FEDERATION=true FEDERATION_PUSH_REPO_BASE=gcr.io/<gce-project-name> ./build/pu
305305

306306
### Running the federation control plane
307307

308-
Once we have the images, we can run these as pods on our existing kubernetes cluster.
308+
Once you have the images, you can run these as pods on your existing kubernetes cluster.
309309
The command to run these pods on an existing GCE cluster will look like:
310310

311311
```shell
@@ -320,14 +320,14 @@ This is used to resolve DNS requests for federation services. The service
320320
controller keeps DNS records with the provider updated as services/pods are
321321
updated in underlying kubernetes clusters.
322322

323-
`FEDERATION_NAME` is a name we can choose for our federation. This is the name that will appear in DNS routes.
323+
`FEDERATION_NAME` is a name you can choose for your federation. This is the name that will appear in DNS routes.
324324

325-
`DNS_ZONE_NAME` is the domain to be used for DNS records. This is a domain that we
325+
`DNS_ZONE_NAME` is the domain to be used for DNS records. This is a domain that you
326326
need to buy and then configure it such that DNS queries for that domain are
327327
routed to the appropriate provider as per `FEDERATION_DNS_PROVIDER`.
328328

329329
Running that command creates a namespace `federation` and creates 2 deployments: `federation-apiserver` and `federation-controller-manager`.
330-
We can verify that the pods are available by running the following command:
330+
You can verify that the pods are available by running the following command:
331331

332332
```shell
333333
$ kubectl get deployments --namespace=federation
@@ -336,8 +336,8 @@ federation-apiserver 1 1 1 1 1m
336336
federation-controller-manager 1 1 1 1 1m
337337
```
338338

339-
Running `federation-up.sh` also creates a new record in our kubeconfig for us
340-
to be able to talk to federation apiserver. We can view this by running
339+
Running `federation-up.sh` also creates a new record in your kubeconfig for us
340+
to be able to talk to federation apiserver. You can view this by running
341341
`kubectl config view`.
342342

343343
Note: `federation-up.sh` creates the federation-apiserver pod with an etcd

0 commit comments

Comments
 (0)