Replacing a TFJob
Function
This API is used to replace a specified TFJob. The following fields can be replaced:
- metadata.labels
- metadata.annotations
- spec.activeDeadlineSeconds
- spec.ttlSecondsAfterFinished
- spec.cleanPodPolicy
URI
PUT /apis/kubeflow.org/v1/namespaces/{namespace}/tfjobs/{name}
| Parameter | Mandatory | Description |
|---|---|---|
| name | Yes | Name of the TFJob. |
| namespace | Yes | Object name and auth scope, such as for teams and projects. |
| Parameter | Mandatory | Description |
|---|---|---|
| pretty | No | If 'true', then the output is pretty printed. |
Request
For the description about request parameters, see Table 154.
Example request
Change the ttlSecondsAfterFinished value of TFJob.
{
"apiVersion": "kubeflow.org/v1",
"kind": "TFJob",
"metadata": {
"creationTimestamp": "2019-07-24T07:17:01Z",
"generation": 2,
"labels": {
"app": "test"
},
"name": "tfjob-test",
"namespace": "kube-test",
"resourceVersion": "72447176",
"selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/tfjobs/tfjob-test",
"uid": "083cc6df-ade3-11e9-aaa4-340a9837e413"
},
"spec": {
"backoffLimit": 6,
"tfReplicaSpecs": {
"Ps": {
"replicas": 1,
"template": {
"spec": {
"containers": [
{
"args": [
"python",
"/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
"--batch_size=1",
"--model=resnet50",
"--variable_update=parameter_server",
"--flush_stdout=true",
"--num_gpus=1",
"--local_parameter_device=cpu",
"--device=cpu",
"--data_format=NHWC"
],
"image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
"name": "tensorflow",
"ports": [
{
"containerPort": 2222,
"name": "tfjob-port"
}
],
"resources": {
"limits": {
"cpu": "2",
"memory": "4Gi"
},
"requests": {
"cpu": "2",
"memory": "4Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
],
"restartPolicy": "OnFailure"
}
}
},
"Worker": {
"replicas": 1,
"template": {
"spec": {
"containers": [
{
"args": [
"python",
"/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
"--batch_size=1",
"--model=resnet50",
"--variable_update=parameter_server",
"--flush_stdout=true",
"--local_parameter_device=cpu",
"--device=cpu",
"--data_format=NHWC"
],
"image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
"name": "tensorflow",
"ports": [
{
"containerPort": 2222,
"name": "tfjob-port"
}
],
"resources": {
"limits": {
"cpu": "2",
"memory": "4Gi"
},
"requests": {
"cpu": "2",
"memory": "4Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
],
"restartPolicy": "OnFailure"
}
}
}
},
"ttlSecondsAfterFinished": 1000
},
"status": {
"conditions": [
{
"lastTransitionTime": "2019-07-24T07:16:13Z",
"lastUpdateTime": "2019-07-24T07:16:13Z",
"message": "TFJob tfjob-test is created.",
"reason": "TFJobCreated",
"status": "True",
"type": "Created"
},
{
"lastTransitionTime": "2019-07-24T07:16:18Z",
"lastUpdateTime": "2019-07-24T07:16:18Z",
"message": "TFJob tfjob-test is running.",
"reason": "TFJobRunning",
"status": "True",
"type": "Running"
}
],
"replicaStatuses": {
"PS": {
"active": 1
},
"Worker": {
"active": 1
}
},
"startTime": "2019-07-24T07:16:13Z"
}
} Response
Response parameters
For the description about response parameters, see Table 154.
Example response
{
"apiVersion": "kubeflow.org/v1",
"kind": "TFJob",
"metadata": {
"creationTimestamp": "2019-07-24T07:17:01Z",
"generation": 2,
"labels": {
"app": "test"
},
"name": "tfjob-test",
"namespace": "kube-test",
"resourceVersion": "72447176",
"selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/tfjobs/tfjob-test",
"uid": "083cc6df-ade3-11e9-aaa4-340a9837e413"
},
"spec": {
"backoffLimit": 6,
"tfReplicaSpecs": {
"Ps": {
"replicas": 1,
"template": {
"spec": {
"containers": [
{
"args": [
"python",
"/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
"--batch_size=1",
"--model=resnet50",
"--variable_update=parameter_server",
"--flush_stdout=true",
"--num_gpus=1",
"--local_parameter_device=cpu",
"--device=cpu",
"--data_format=NHWC"
],
"image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
"name": "tensorflow",
"ports": [
{
"containerPort": 2222,
"name": "tfjob-port"
}
],
"resources": {
"limits": {
"cpu": "2",
"memory": "4Gi"
},
"requests": {
"cpu": "2",
"memory": "4Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
],
"restartPolicy": "OnFailure"
}
}
},
"Worker": {
"replicas": 1,
"template": {
"spec": {
"containers": [
{
"args": [
"python",
"/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
"--batch_size=1",
"--model=resnet50",
"--variable_update=parameter_server",
"--flush_stdout=true",
"--local_parameter_device=cpu",
"--device=cpu",
"--data_format=NHWC"
],
"image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
"name": "tensorflow",
"ports": [
{
"containerPort": 2222,
"name": "tfjob-port"
}
],
"resources": {
"limits": {
"cpu": "2",
"memory": "4Gi"
},
"requests": {
"cpu": "2",
"memory": "4Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
],
"restartPolicy": "OnFailure"
}
}
}
},
"ttlSecondsAfterFinished": 1000
},
"status": {
"conditions": [
{
"lastTransitionTime": "2019-07-24T07:16:13Z",
"lastUpdateTime": "2019-07-24T07:16:13Z",
"message": "TFJob tfjob-test is created.",
"reason": "TFJobCreated",
"status": "True",
"type": "Created"
},
{
"lastTransitionTime": "2019-07-24T07:16:18Z",
"lastUpdateTime": "2019-07-24T07:16:18Z",
"message": "TFJob tfjob-test is running.",
"reason": "TFJobRunning",
"status": "True",
"type": "Running"
}
],
"replicaStatuses": {
"PS": {
"active": 1
},
"Worker": {
"active": 1
}
},
"startTime": "2019-07-24T07:16:13Z"
}
} Status Code
| Status Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 400 | BadRequest |
| 500 | Internal Error |
| 403 | Forbidden |
Last Article: Updating a TFJob
Next Article: MXJob
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.