Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add federation job doc #5485

Merged
merged 3 commits into from
Sep 19, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update job.md
Edits for clarity and consistency
  • Loading branch information
zacharysarah authored Sep 19, 2017
commit cb684ddcd04fa25c4b67a7aa257410b54f0fb0ba
79 changes: 40 additions & 39 deletions docs/tasks/administer-federation/job.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Federated Jobs
---

{% capture overview %}
This guide explains how to use Jobs in the Federation control plane.
This guide explains how to use jobs in the Federation control plane.

Jobs in the federation control plane (referred to as "federated Jobs" in
this guide) are very similar to the traditional [Kubernetes
Jobs](/docs/concepts/workloads/controllers/job/), and provide the same functionality.
Creating them in the federation control plane ensures that the desired number of
Jobs in the federation control plane (referred to as "federated jobs" in
this guide) are similar to the traditional [Kubernetes
jobs](/docs/concepts/workloads/controllers/job/), and provide the same functionality.
Creating jobs in the federation control plane ensures that the desired number of
parallelism and completions exist across the registered clusters.
{% endcapture %}

Expand All @@ -17,15 +17,15 @@ parallelism and completions exist across the registered clusters.
* {% include federated-task-tutorial-prereqs.md %}
* You are also expected to have a basic
[working knowledge of Kubernetes](/docs/getting-started-guides/) in
general and [Jobs](/docs/concepts/workloads/controllers/jobs-run-to-completion/) in particular.
general and [jobs](/docs/concepts/workloads/controllers/jobs-run-to-completion/) in particular.
{% endcapture %}

{% capture steps %}

## Creating a Federated Jobs
## Creating a federated job

The API for Federated Job is 100% compatible with the
API for traditional Kubernetes Job. You can create a Job by sending
The API for federated jobs is fully compatible with the
API for traditional Kubernetes jobs. You can create a job by sending
a request to the federation apiserver.

You can do that using [kubectl](/docs/user-guide/kubectl/) by running:
Expand All @@ -35,66 +35,67 @@ kubectl --context=federation-cluster create -f myjob.yaml
```

The '--context=federation-cluster' flag tells kubectl to submit the
request to the Federation apiserver instead of sending it to a Kubernetes
request to the federation API server instead of sending it to a Kubernetes
cluster.

Once a federated Job is created, the federation control plane will create
a Job in all underlying Kubernetes clusters.
Once a federated job is created, the federation control plane creates
a job in all underlying Kubernetes clusters.
You can verify this by checking each of the underlying clusters, for example:

``` shell
kubectl --context=gce-asia-east1a get job myjob
```

The above assumes that you have a context named 'gce-asia-east1a'
The previous example assumes that you have a context named `gce-asia-east1a`
configured in your client for your cluster in that zone.

The Jobs in the underlying clusters will match the federation Job
except in the number of parallelism and completions. The federation control plane will ensure that the
sum of the parallelism and completions in each cluster match the desired number of parallelism and completions in the
federation Job.
The jobs in the underlying clusters match the federated job
except in the number of parallelism and completions. The federation control plane ensures that the
sum of the parallelism and completions in each cluster matches the desired number of parallelism and completions in the
federated job.

### Spreading Job tasks in Underlying Clusters
### Spreading job tasks in underlying clusters

By default, parallelism and completions are spread equally in all the underlying clusters. For example:
if you have 3 registered clusters and you create a federated Job with
`spec.parallelism = 9` and `spec.completions = 18`, then each Job in the 3 clusters will have
By default, parallelism and completions are spread equally in all underlying clusters. For example:
if you have 3 registered clusters and you create a federated job with
`spec.parallelism = 9` and `spec.completions = 18`, then each job in the 3 clusters has
`spec.parallelism = 3` and `spec.completions = 6`.
To modify the number of parallelism and completions in each cluster, you can specify
[ReplicaAllocationPreferences](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/federation/apis/federation/types.go)
as an annotation with key `federation.kubernetes.io/job-preferences`
on the federated Job.
on the federated job.


## Updating a Federated Job
## Updating a federated job

You can update a federated Job as you would update a Kubernetes
Job; however, for a federated Job, you must send the request to
the federation apiserver instead of sending it to a specific Kubernetes cluster.
The Federation control plane ensures that whenever the federated Job is
updated, it updates the corresponding Job in all underlying clusters to
You can update a federated job as you would update a Kubernetes
job; however, for a federated job, you must send the request to
the federation API server instead of sending it to a specific Kubernetes cluster.
The federation control plane ensures that whenever the federated job is
updated, it updates the corresponding job in all underlying clusters to
match it.

If your update includes a change in number of parallelism and completions, the federation
control plane will change the number of parallelism and completions in underlying clusters to
control plane changes the number of parallelism and completions in underlying clusters to
ensure that their sum remains equal to the number of desired parallelism and completions in
federated Job.
federated job.

## Deleting a Federated Job
## Deleting a federated job

You can delete a federated Job as you would delete a Kubernetes
Job; however, for a federated Job, you must send the request to
the federation apiserver instead of sending it to a specific Kubernetes cluster.
You can delete a federated job as you would delete a Kubernetes
job; however, for a federated job, you must send the request to
the federation API server instead of sending it to a specific Kubernetes cluster.

For example, you can do that using kubectl by running:
For example, with kubectl:

```shell
kubectl --context=federation-cluster delete job myjob
```

Note that at this point, deleting a federated Job will not delete the
corresponding Jobs from underlying clusters.
You must delete the underlying Jobs manually.
We intend to fix this in the future.
**Note:** Deleting a federated job will not delete the
corresponding jobs from underlying clusters.
You must delete the underlying jobs manually.
{: .note}

{% endcapture %}

Expand Down