Skip to content

K
k3s
Commit 4a68dda8 authored by Kubernetes Submit Queue's avatar Kubernetes Submit Queue Committed by GitHub
Browse files
Options

Merge pull request #44038 from soltysh/batch_docs

Automatic merge from submit-queue (batch tested with PRs 44440, 44038, 44302, 44316, 43876) Update batch types.go docs @bgrant0607 you asked about it in https://github.com/kubernetes/kubernetes/pull/42663#discussion_r109065758
parents 7ef8ad04 a307c47d
Hide whitespace changes
Inline Side-by-side
Showing with 321 additions and 333 deletions
api/openapi-spec/swagger.json
View file @ 4a68dda8
...@@ -43087,11 +43087,11 @@ ...@@ -43087,11 +43087,11 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
}, },
"spec": { "spec": {
"description": "Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "description": "Specification of the desired behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobSpec" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobSpec"
}, },
"status": { "status": {
"description": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "description": "Current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobStatus" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobStatus"
} }
}, },
...@@ -43147,7 +43147,7 @@ ...@@ -43147,7 +43147,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of Job.", "description": "items is the list of Jobs.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.Job" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.Job"
...@@ -43158,7 +43158,7 @@ ...@@ -43158,7 +43158,7 @@
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"description": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "description": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
} }
}, },
...@@ -43182,25 +43182,25 @@ ...@@ -43182,25 +43182,25 @@
"format": "int64" "format": "int64"
}, },
"completions": { "completions": {
"description": "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs", "description": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"manualSelector": { "manualSelector": {
"description": "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md", "description": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md",
"type": "boolean" "type": "boolean"
}, },
"parallelism": { "parallelism": {
"description": "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs", "description": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"selector": { "selector": {
"description": "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors", "description": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
}, },
"template": { "template": {
"description": "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs", "description": "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.api.v1.PodTemplateSpec" "$ref": "#/definitions/io.k8s.kubernetes.pkg.api.v1.PodTemplateSpec"
} }
} }
...@@ -43209,16 +43209,16 @@ ...@@ -43209,16 +43209,16 @@
"description": "JobStatus represents the current state of a Job.", "description": "JobStatus represents the current state of a Job.",
"properties": { "properties": {
"active": { "active": {
"description": "Active is the number of actively running pods.", "description": "The number of actively running pods.",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"completionTime": { "completionTime": {
"description": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "description": "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}, },
"conditions": { "conditions": {
"description": "Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs", "description": "The latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobCondition" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v1.JobCondition"
...@@ -43227,16 +43227,16 @@ ...@@ -43227,16 +43227,16 @@
"x-kubernetes-patch-strategy": "merge" "x-kubernetes-patch-strategy": "merge"
}, },
"failed": { "failed": {
"description": "Failed is the number of pods which reached Phase Failed.", "description": "The number of pods which reached phase Failed.",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"startTime": { "startTime": {
"description": "StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "description": "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}, },
"succeeded": { "succeeded": {
"description": "Succeeded is the number of pods which reached Phase Succeeded.", "description": "The number of pods which reached phase Succeeded.",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
} }
...@@ -43258,11 +43258,11 @@ ...@@ -43258,11 +43258,11 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
}, },
"spec": { "spec": {
"description": "Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "description": "Specification of the desired behavior of a cron job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJobSpec" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJobSpec"
}, },
"status": { "status": {
"description": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "description": "Current status of a cron job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJobStatus" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJobStatus"
} }
}, },
...@@ -43290,7 +43290,7 @@ ...@@ -43290,7 +43290,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of CronJob.", "description": "items is the list of CronJobs.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJob" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.CronJob"
...@@ -43301,7 +43301,7 @@ ...@@ -43301,7 +43301,7 @@
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"description": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "description": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
} }
}, },
...@@ -43326,7 +43326,7 @@ ...@@ -43326,7 +43326,7 @@
], ],
"properties": { "properties": {
"concurrencyPolicy": { "concurrencyPolicy": {
"description": "ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow.", "description": "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
"type": "string" "type": "string"
}, },
"failedJobsHistoryLimit": { "failedJobsHistoryLimit": {
...@@ -43335,11 +43335,11 @@ ...@@ -43335,11 +43335,11 @@
"format": "int32" "format": "int32"
}, },
"jobTemplate": { "jobTemplate": {
"description": "JobTemplate is the object that describes the job that will be created when executing a CronJob.", "description": "Specifies the job that will be created when executing a CronJob.",
"$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.JobTemplateSpec" "$ref": "#/definitions/io.k8s.kubernetes.pkg.apis.batch.v2alpha1.JobTemplateSpec"
}, },
"schedule": { "schedule": {
"description": "Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", "description": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
"type": "string" "type": "string"
}, },
"startingDeadlineSeconds": { "startingDeadlineSeconds": {
...@@ -43353,7 +43353,7 @@ ...@@ -43353,7 +43353,7 @@
"format": "int32" "format": "int32"
}, },
"suspend": { "suspend": {
"description": "Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.", "description": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
"type": "boolean" "type": "boolean"
} }
} }
...@@ -43362,14 +43362,14 @@ ...@@ -43362,14 +43362,14 @@
"description": "CronJobStatus represents the current state of a cron job.", "description": "CronJobStatus represents the current state of a cron job.",
"properties": { "properties": {
"active": { "active": {
"description": "Active holds pointers to currently running jobs.", "description": "A list of pointers to currently running jobs.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/io.k8s.kubernetes.pkg.api.v1.ObjectReference" "$ref": "#/definitions/io.k8s.kubernetes.pkg.api.v1.ObjectReference"
} }
}, },
"lastScheduleTime": { "lastScheduleTime": {
"description": "LastScheduleTime keeps information of when was the last time the job was successfully scheduled.", "description": "Information when was the last time the job was successfully scheduled.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
} }
} }
api/swagger-spec/batch_v1.json
View file @ 4a68dda8
...@@ -1028,14 +1028,14 @@ ...@@ -1028,14 +1028,14 @@
}, },
"metadata": { "metadata": {
"$ref": "v1.ListMeta", "$ref": "v1.ListMeta",
"description": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata" "description": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata"
}, },
"items": { "items": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "v1.Job" "$ref": "v1.Job"
}, },
"description": "Items is the list of Job." "description": "items is the list of Jobs."
} }
} }
}, },
...@@ -1071,11 +1071,11 @@ ...@@ -1071,11 +1071,11 @@
}, },
"spec": { "spec": {
"$ref": "v1.JobSpec", "$ref": "v1.JobSpec",
"description": "Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status" "description": "Specification of the desired behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status"
}, },
"status": { "status": {
"$ref": "v1.JobStatus", "$ref": "v1.JobStatus",
"description": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status" "description": "Current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status"
} }
} }
}, },
...@@ -1199,12 +1199,12 @@ ...@@ -1199,12 +1199,12 @@
"parallelism": { "parallelism": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs"
}, },
"completions": { "completions": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs"
}, },
"activeDeadlineSeconds": { "activeDeadlineSeconds": {
"type": "integer", "type": "integer",
...@@ -1213,15 +1213,15 @@ ...@@ -1213,15 +1213,15 @@
}, },
"selector": { "selector": {
"$ref": "v1.LabelSelector", "$ref": "v1.LabelSelector",
"description": "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors" "description": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors"
}, },
"manualSelector": { "manualSelector": {
"type": "boolean", "type": "boolean",
"description": "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md" "description": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md"
}, },
"template": { "template": {
"$ref": "v1.PodTemplateSpec", "$ref": "v1.PodTemplateSpec",
"description": "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs"
} }
} }
}, },
...@@ -3151,30 +3151,30 @@ ...@@ -3151,30 +3151,30 @@
"items": { "items": {
"$ref": "v1.JobCondition" "$ref": "v1.JobCondition"
}, },
"description": "Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "The latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs"
}, },
"startTime": { "startTime": {
"type": "string", "type": "string",
"description": "StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC." "description": "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC."
}, },
"completionTime": { "completionTime": {
"type": "string", "type": "string",
"description": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC." "description": "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC."
}, },
"active": { "active": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Active is the number of actively running pods." "description": "The number of actively running pods."
}, },
"succeeded": { "succeeded": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Succeeded is the number of pods which reached Phase Succeeded." "description": "The number of pods which reached phase Succeeded."
}, },
"failed": { "failed": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Failed is the number of pods which reached Phase Failed." "description": "The number of pods which reached phase Failed."
} }
} }
}, },
......
api/swagger-spec/batch_v2alpha1.json
View file @ 4a68dda8
...@@ -2006,14 +2006,14 @@ ...@@ -2006,14 +2006,14 @@
}, },
"metadata": { "metadata": {
"$ref": "v1.ListMeta", "$ref": "v1.ListMeta",
"description": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata" "description": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata"
}, },
"items": { "items": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "v2alpha1.CronJob" "$ref": "v2alpha1.CronJob"
}, },
"description": "Items is the list of CronJob." "description": "items is the list of CronJobs."
} }
} }
}, },
...@@ -2049,11 +2049,11 @@ ...@@ -2049,11 +2049,11 @@
}, },
"spec": { "spec": {
"$ref": "v2alpha1.CronJobSpec", "$ref": "v2alpha1.CronJobSpec",
"description": "Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status" "description": "Specification of the desired behavior of a cron job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status"
}, },
"status": { "status": {
"$ref": "v2alpha1.CronJobStatus", "$ref": "v2alpha1.CronJobStatus",
"description": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status" "description": "Current status of a cron job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status"
} }
} }
}, },
...@@ -2177,7 +2177,7 @@ ...@@ -2177,7 +2177,7 @@
"properties": { "properties": {
"schedule": { "schedule": {
"type": "string", "type": "string",
"description": "Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron." "description": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron."
}, },
"startingDeadlineSeconds": { "startingDeadlineSeconds": {
"type": "integer", "type": "integer",
...@@ -2186,15 +2186,15 @@ ...@@ -2186,15 +2186,15 @@
}, },
"concurrencyPolicy": { "concurrencyPolicy": {
"type": "string", "type": "string",
"description": "ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow." "description": "Specifies how to treat concurrent executions of a Job. Defaults to Allow."
}, },
"suspend": { "suspend": {
"type": "boolean", "type": "boolean",
"description": "Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false." "description": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false."
}, },
"jobTemplate": { "jobTemplate": {
"$ref": "v2alpha1.JobTemplateSpec", "$ref": "v2alpha1.JobTemplateSpec",
"description": "JobTemplate is the object that describes the job that will be created when executing a CronJob." "description": "Specifies the job that will be created when executing a CronJob."
}, },
"successfulJobsHistoryLimit": { "successfulJobsHistoryLimit": {
"type": "integer", "type": "integer",
...@@ -2232,12 +2232,12 @@ ...@@ -2232,12 +2232,12 @@
"parallelism": { "parallelism": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs"
}, },
"completions": { "completions": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"description": "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs"
}, },
"activeDeadlineSeconds": { "activeDeadlineSeconds": {
"type": "integer", "type": "integer",
...@@ -2246,15 +2246,15 @@ ...@@ -2246,15 +2246,15 @@
}, },
"selector": { "selector": {
"$ref": "v1.LabelSelector", "$ref": "v1.LabelSelector",
"description": "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors" "description": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors"
}, },
"manualSelector": { "manualSelector": {
"type": "boolean", "type": "boolean",
"description": "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md" "description": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md"
}, },
"template": { "template": {
"$ref": "v1.PodTemplateSpec", "$ref": "v1.PodTemplateSpec",
"description": "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs" "description": "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs"
} }
} }
}, },
...@@ -4184,11 +4184,11 @@ ...@@ -4184,11 +4184,11 @@
"items": { "items": {
"$ref": "v1.ObjectReference" "$ref": "v1.ObjectReference"
}, },
"description": "Active holds pointers to currently running jobs." "description": "A list of pointers to currently running jobs."
}, },
"lastScheduleTime": { "lastScheduleTime": {
"type": "string", "type": "string",
"description": "LastScheduleTime keeps information of when was the last time the job was successfully scheduled." "description": "Information when was the last time the job was successfully scheduled."
} }
} }
}, },
......
docs/api-reference/batch/v1/definitions.html
View file @ 4a68dda8
...@@ -2177,42 +2177,42 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } ...@@ -2177,42 +2177,42 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
<tbody> <tbody>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">conditions</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">conditions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Conditions represent the latest available observations of an object&#8217;s current state. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The latest available observations of an object&#8217;s current state. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobcondition">v1.JobCondition</a> array</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobcondition">v1.JobCondition</a> array</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">startTime</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">startTime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">completionTime</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">completionTime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">active</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">active</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Active is the number of actively running pods.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The number of actively running pods.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">succeeded</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">succeeded</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Succeeded is the number of pods which reached Phase Succeeded.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The number of pods which reached phase Succeeded.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">failed</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">failed</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Failed is the number of pods which reached Phase Failed.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The number of pods which reached phase Failed.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -3364,14 +3364,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -3364,14 +3364,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Spec is a structure defining the expected behavior of a job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specification of the desired behavior of a job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobspec">v1.JobSpec</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobspec">v1.JobSpec</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Status is a structure describing current status of a job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Current status of a job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobstatus">v1.JobStatus</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_jobstatus">v1.JobStatus</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -3526,14 +3526,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -3526,14 +3526,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Items is the list of Job.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">items is the list of Jobs.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_job">v1.Job</a> array</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_job">v1.Job</a> array</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -4105,14 +4105,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -4105,14 +4105,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
<tbody> <tbody>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parallelism</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">parallelism</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) &lt; .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) &lt; .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">completions</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">completions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -4126,21 +4126,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -4126,21 +4126,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">selector</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">selector</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: <a href="http://kubernetes.io/docs/user-guide/labels#label-selectors">http://kubernetes.io/docs/user-guide/labels#label-selectors</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: <a href="http://kubernetes.io/docs/user-guide/labels#label-selectors">http://kubernetes.io/docs/user-guide/labels#label-selectors</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_labelselector">v1.LabelSelector</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_labelselector">v1.LabelSelector</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ManualSelector controls generation of pod labels and pod selectors. Leave <code>manualSelector</code> unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see <code>manualSelector=true</code> in jobs that were created with the old <code>extensions/v1beta1</code> API. More info: <a href="http://releases.k8s.io/HEAD/docs/design/selector-generation.md">http://releases.k8s.io/HEAD/docs/design/selector-generation.md</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector controls generation of pod labels and pod selectors. Leave <code>manualSelector</code> unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see <code>manualSelector=true</code> in jobs that were created with the old <code>extensions/v1beta1</code> API. More info: <a href="http://releases.k8s.io/HEAD/docs/design/selector-generation.md">http://releases.k8s.io/HEAD/docs/design/selector-generation.md</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">template</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">template</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Template is the object that describes the pod that will be created when executing a job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Describes the pod that will be created when executing a job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_podtemplatespec">v1.PodTemplateSpec</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_podtemplatespec">v1.PodTemplateSpec</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -5533,7 +5533,7 @@ Examples:<br> ...@@ -5533,7 +5533,7 @@ Examples:<br>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2017-04-05 12:45:07 UTC Last updated 2017-04-10 12:25:40 UTC
</div> </div>
</div> </div>
</body> </body>
......
docs/api-reference/batch/v2alpha1/definitions.html
View file @ 4a68dda8
...@@ -3353,14 +3353,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -3353,14 +3353,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
<tbody> <tbody>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">active</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">active</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Active holds pointers to currently running jobs.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A list of pointers to currently running jobs.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectreference">v1.ObjectReference</a> array</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectreference">v1.ObjectReference</a> array</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">lastScheduleTime</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">lastScheduleTime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">LastScheduleTime keeps information of when was the last time the job was successfully scheduled.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Information when was the last time the job was successfully scheduled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -3706,7 +3706,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -3706,7 +3706,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
<tbody> <tbody>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">schedule</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">schedule</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Schedule contains the schedule in Cron format, see <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The schedule in Cron format, see <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -3720,21 +3720,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -3720,21 +3720,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">concurrencyPolicy</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">concurrencyPolicy</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies how to treat concurrent executions of a Job. Defaults to Allow.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">suspend</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">suspend</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">jobTemplate</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">jobTemplate</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">JobTemplate is the object that describes the job that will be created when executing a CronJob.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the job that will be created when executing a CronJob.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_jobtemplatespec">v2alpha1.JobTemplateSpec</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_jobtemplatespec">v2alpha1.JobTemplateSpec</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -4008,14 +4008,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -4008,14 +4008,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
<tbody> <tbody>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">parallelism</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">parallelism</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) &lt; .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) &lt; .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">completions</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">completions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -4029,21 +4029,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -4029,21 +4029,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">selector</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">selector</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: <a href="http://kubernetes.io/docs/user-guide/labels#label-selectors">http://kubernetes.io/docs/user-guide/labels#label-selectors</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: <a href="http://kubernetes.io/docs/user-guide/labels#label-selectors">http://kubernetes.io/docs/user-guide/labels#label-selectors</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_labelselector">v1.LabelSelector</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_labelselector">v1.LabelSelector</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ManualSelector controls generation of pod labels and pod selectors. Leave <code>manualSelector</code> unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see <code>manualSelector=true</code> in jobs that were created with the old <code>extensions/v1beta1</code> API. More info: <a href="http://releases.k8s.io/HEAD/docs/design/selector-generation.md">http://releases.k8s.io/HEAD/docs/design/selector-generation.md</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">manualSelector controls generation of pod labels and pod selectors. Leave <code>manualSelector</code> unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see <code>manualSelector=true</code> in jobs that were created with the old <code>extensions/v1beta1</code> API. More info: <a href="http://releases.k8s.io/HEAD/docs/design/selector-generation.md">http://releases.k8s.io/HEAD/docs/design/selector-generation.md</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">template</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">template</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Template is the object that describes the pod that will be created when executing a job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Describes the pod that will be created when executing a job. More info: <a href="http://kubernetes.io/docs/user-guide/jobs">http://kubernetes.io/docs/user-guide/jobs</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_podtemplatespec">v1.PodTemplateSpec</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_podtemplatespec">v1.PodTemplateSpec</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -5243,14 +5243,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i ...@@ -5243,14 +5243,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Items is the list of CronJob.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">items is the list of CronJobs.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjob">v2alpha1.CronJob</a> array</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjob">v2alpha1.CronJob</a> array</p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -5515,14 +5515,14 @@ Examples:<br> ...@@ -5515,14 +5515,14 @@ Examples:<br>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Spec is a structure defining the expected behavior of a job, including the schedule. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Specification of the desired behavior of a cron job, including the schedule. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjobspec">v2alpha1.CronJobSpec</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjobspec">v2alpha1.CronJobSpec</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
</tr> </tr>
<tr> <tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Status is a structure describing current status of a job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Current status of a cron job. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjobstatus">v2alpha1.CronJobStatus</a></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v2alpha1_cronjobstatus">v2alpha1.CronJobStatus</a></p></td>
<td class="tableblock halign-left valign-top"></td> <td class="tableblock halign-left valign-top"></td>
...@@ -5629,7 +5629,7 @@ Examples:<br> ...@@ -5629,7 +5629,7 @@ Examples:<br>
</div> </div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2017-04-10 11:51:28 UTC Last updated 2017-04-13 12:05:18 UTC
</div> </div>
</div> </div>
</body> </body>
......
pkg/apis/batch/types.go
View file @ 4a68dda8
...@@ -31,12 +31,12 @@ type Job struct { ...@@ -31,12 +31,12 @@ type Job struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec JobSpec Spec JobSpec
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status JobStatus Status JobStatus
...@@ -45,12 +45,12 @@ type Job struct { ...@@ -45,12 +45,12 @@ type Job struct {
// JobList is a collection of jobs. // JobList is a collection of jobs.
type JobList struct { type JobList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of Job. // items is the list of Jobs.
Items []Job Items []Job
} }
...@@ -62,7 +62,7 @@ type JobTemplate struct { ...@@ -62,7 +62,7 @@ type JobTemplate struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Template JobTemplateSpec Template JobTemplateSpec
...@@ -84,14 +84,14 @@ type JobTemplateSpec struct { ...@@ -84,14 +84,14 @@ type JobTemplateSpec struct {
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
type JobSpec struct { type JobSpec struct {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
// +optional // +optional
Parallelism *int32 Parallelism *int32
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -104,12 +104,12 @@ type JobSpec struct { ...@@ -104,12 +104,12 @@ type JobSpec struct {
// +optional // +optional
ActiveDeadlineSeconds *int64 ActiveDeadlineSeconds *int64
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// +optional // +optional
Selector *metav1.LabelSelector Selector *metav1.LabelSelector
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -121,39 +121,38 @@ type JobSpec struct { ...@@ -121,39 +121,38 @@ type JobSpec struct {
// +optional // +optional
ManualSelector *bool ManualSelector *bool
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
Template api.PodTemplateSpec Template api.PodTemplateSpec
} }
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
type JobStatus struct { type JobStatus struct {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// +optional // +optional
Conditions []JobCondition Conditions []JobCondition
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
StartTime *metav1.Time StartTime *metav1.Time
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
CompletionTime *metav1.Time CompletionTime *metav1.Time
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
Active int32 Active int32
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
Succeeded int32 Succeeded int32
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
Failed int32 Failed int32
} }
...@@ -198,12 +197,12 @@ type CronJob struct { ...@@ -198,12 +197,12 @@ type CronJob struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec CronJobSpec Spec CronJobSpec
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status CronJobStatus Status CronJobStatus
...@@ -212,19 +211,19 @@ type CronJob struct { ...@@ -212,19 +211,19 @@ type CronJob struct {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
type CronJobList struct { type CronJobList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of CronJob. // items is the list of CronJobs.
Items []CronJob Items []CronJob
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
type CronJobSpec struct { type CronJobSpec struct {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string Schedule string
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -232,18 +231,17 @@ type CronJobSpec struct { ...@@ -232,18 +231,17 @@ type CronJobSpec struct {
// +optional // +optional
StartingDeadlineSeconds *int64 StartingDeadlineSeconds *int64
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
ConcurrencyPolicy ConcurrencyPolicy ConcurrencyPolicy ConcurrencyPolicy
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
Suspend *bool Suspend *bool
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
JobTemplate JobTemplateSpec JobTemplate JobTemplateSpec
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -277,11 +275,11 @@ const ( ...@@ -277,11 +275,11 @@ const (
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
type CronJobStatus struct { type CronJobStatus struct {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
Active []api.ObjectReference Active []api.ObjectReference
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
LastScheduleTime *metav1.Time LastScheduleTime *metav1.Time
} }
pkg/apis/batch/v1/generated.proto
View file @ 4a68dda8
...@@ -38,12 +38,12 @@ message Job { ...@@ -38,12 +38,12 @@ message Job {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobSpec spec = 2; optional JobSpec spec = 2;
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobStatus status = 3; optional JobStatus status = 3;
...@@ -76,18 +76,18 @@ message JobCondition { ...@@ -76,18 +76,18 @@ message JobCondition {
// JobList is a collection of jobs. // JobList is a collection of jobs.
message JobList { message JobList {
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of Job. // items is the list of Jobs.
repeated Job items = 2; repeated Job items = 2;
} }
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
message JobSpec { message JobSpec {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
...@@ -95,7 +95,7 @@ message JobSpec { ...@@ -95,7 +95,7 @@ message JobSpec {
// +optional // +optional
optional int32 parallelism = 1; optional int32 parallelism = 1;
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -109,13 +109,13 @@ message JobSpec { ...@@ -109,13 +109,13 @@ message JobSpec {
// +optional // +optional
optional int64 activeDeadlineSeconds = 3; optional int64 activeDeadlineSeconds = 3;
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// More info: http://kubernetes.io/docs/user-guide/labels#label-selectors // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4; optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -128,42 +128,41 @@ message JobSpec { ...@@ -128,42 +128,41 @@ message JobSpec {
// +optional // +optional
optional bool manualSelector = 5; optional bool manualSelector = 5;
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
optional k8s.io.kubernetes.pkg.api.v1.PodTemplateSpec template = 6; optional k8s.io.kubernetes.pkg.api.v1.PodTemplateSpec template = 6;
} }
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
message JobStatus { message JobStatus {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
// +patchStrategy=merge // +patchStrategy=merge
repeated JobCondition conditions = 1; repeated JobCondition conditions = 1;
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2;
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
optional int32 active = 4; optional int32 active = 4;
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
optional int32 succeeded = 5; optional int32 succeeded = 5;
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
optional int32 failed = 6; optional int32 failed = 6;
} }
......
pkg/apis/batch/v1/types.go
View file @ 4a68dda8
...@@ -31,12 +31,12 @@ type Job struct { ...@@ -31,12 +31,12 @@ type Job struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
...@@ -45,19 +45,19 @@ type Job struct { ...@@ -45,19 +45,19 @@ type Job struct {
// JobList is a collection of jobs. // JobList is a collection of jobs.
type JobList struct { type JobList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of Job. // items is the list of Jobs.
Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
type JobSpec struct { type JobSpec struct {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
...@@ -65,7 +65,7 @@ type JobSpec struct { ...@@ -65,7 +65,7 @@ type JobSpec struct {
// +optional // +optional
Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"` Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"`
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -79,13 +79,13 @@ type JobSpec struct { ...@@ -79,13 +79,13 @@ type JobSpec struct {
// +optional // +optional
ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"` ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"`
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// More info: http://kubernetes.io/docs/user-guide/labels#label-selectors // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
// +optional // +optional
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"` Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"`
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -98,8 +98,7 @@ type JobSpec struct { ...@@ -98,8 +98,7 @@ type JobSpec struct {
// +optional // +optional
ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"` ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"`
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"` Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"`
} }
...@@ -107,34 +106,34 @@ type JobSpec struct { ...@@ -107,34 +106,34 @@ type JobSpec struct {
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
type JobStatus struct { type JobStatus struct {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
// +patchStrategy=merge // +patchStrategy=merge
Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"` StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"`
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"` CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"` Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"` Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"`
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"` Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"`
} }
......
pkg/apis/batch/v1/types_swagger_doc_generated.go
View file @ 4a68dda8
...@@ -30,8 +30,8 @@ package v1 ...@@ -30,8 +30,8 @@ package v1
var map_Job = map[string]string{ var map_Job = map[string]string{
"": "Job represents the configuration of a single job.", "": "Job represents the configuration of a single job.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"spec": "Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "spec": "Specification of the desired behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"status": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "status": "Current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (Job) SwaggerDoc() map[string]string { func (Job) SwaggerDoc() map[string]string {
...@@ -54,8 +54,8 @@ func (JobCondition) SwaggerDoc() map[string]string { ...@@ -54,8 +54,8 @@ func (JobCondition) SwaggerDoc() map[string]string {
var map_JobList = map[string]string{ var map_JobList = map[string]string{
"": "JobList is a collection of jobs.", "": "JobList is a collection of jobs.",
"metadata": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"items": "Items is the list of Job.", "items": "items is the list of Jobs.",
} }
func (JobList) SwaggerDoc() map[string]string { func (JobList) SwaggerDoc() map[string]string {
...@@ -64,12 +64,12 @@ func (JobList) SwaggerDoc() map[string]string { ...@@ -64,12 +64,12 @@ func (JobList) SwaggerDoc() map[string]string {
var map_JobSpec = map[string]string{ var map_JobSpec = map[string]string{
"": "JobSpec describes how the job execution will look like.", "": "JobSpec describes how the job execution will look like.",
"parallelism": "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs", "parallelism": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs",
"completions": "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs", "completions": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs",
"activeDeadlineSeconds": "Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer", "activeDeadlineSeconds": "Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer",
"selector": "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors", "selector": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors",
"manualSelector": "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md", "manualSelector": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md",
"template": "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs", "template": "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs",
} }
func (JobSpec) SwaggerDoc() map[string]string { func (JobSpec) SwaggerDoc() map[string]string {
...@@ -78,12 +78,12 @@ func (JobSpec) SwaggerDoc() map[string]string { ...@@ -78,12 +78,12 @@ func (JobSpec) SwaggerDoc() map[string]string {
var map_JobStatus = map[string]string{ var map_JobStatus = map[string]string{
"": "JobStatus represents the current state of a Job.", "": "JobStatus represents the current state of a Job.",
"conditions": "Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs", "conditions": "The latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs",
"startTime": "StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "startTime": "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"completionTime": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "completionTime": "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"active": "Active is the number of actively running pods.", "active": "The number of actively running pods.",
"succeeded": "Succeeded is the number of pods which reached Phase Succeeded.", "succeeded": "The number of pods which reached phase Succeeded.",
"failed": "Failed is the number of pods which reached Phase Failed.", "failed": "The number of pods which reached phase Failed.",
} }
func (JobStatus) SwaggerDoc() map[string]string { func (JobStatus) SwaggerDoc() map[string]string {
......
pkg/apis/batch/v2alpha1/generated.proto
View file @ 4a68dda8
...@@ -39,12 +39,12 @@ message CronJob { ...@@ -39,12 +39,12 @@ message CronJob {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional CronJobSpec spec = 2; optional CronJobSpec spec = 2;
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional CronJobStatus status = 3; optional CronJobStatus status = 3;
...@@ -52,18 +52,18 @@ message CronJob { ...@@ -52,18 +52,18 @@ message CronJob {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
message CronJobList { message CronJobList {
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of CronJob. // items is the list of CronJobs.
repeated CronJob items = 2; repeated CronJob items = 2;
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
message CronJobSpec { message CronJobSpec {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
optional string schedule = 1; optional string schedule = 1;
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -71,18 +71,17 @@ message CronJobSpec { ...@@ -71,18 +71,17 @@ message CronJobSpec {
// +optional // +optional
optional int64 startingDeadlineSeconds = 2; optional int64 startingDeadlineSeconds = 2;
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
optional string concurrencyPolicy = 3; optional string concurrencyPolicy = 3;
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
optional bool suspend = 4; optional bool suspend = 4;
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
optional JobTemplateSpec jobTemplate = 5; optional JobTemplateSpec jobTemplate = 5;
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -98,11 +97,11 @@ message CronJobSpec { ...@@ -98,11 +97,11 @@ message CronJobSpec {
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
message CronJobStatus { message CronJobStatus {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
repeated k8s.io.kubernetes.pkg.api.v1.ObjectReference active = 1; repeated k8s.io.kubernetes.pkg.api.v1.ObjectReference active = 1;
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastScheduleTime = 4; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastScheduleTime = 4;
} }
...@@ -114,7 +113,7 @@ message JobTemplate { ...@@ -114,7 +113,7 @@ message JobTemplate {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobTemplateSpec template = 2; optional JobTemplateSpec template = 2;
......
pkg/apis/batch/v2alpha1/types.go
View file @ 4a68dda8
...@@ -30,7 +30,7 @@ type JobTemplate struct { ...@@ -30,7 +30,7 @@ type JobTemplate struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Template JobTemplateSpec `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"` Template JobTemplateSpec `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"`
...@@ -59,12 +59,12 @@ type CronJob struct { ...@@ -59,12 +59,12 @@ type CronJob struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
...@@ -73,19 +73,19 @@ type CronJob struct { ...@@ -73,19 +73,19 @@ type CronJob struct {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
type CronJobList struct { type CronJobList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of CronJob. // items is the list of CronJobs.
Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"` Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
type CronJobSpec struct { type CronJobSpec struct {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"` Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"`
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -93,18 +93,17 @@ type CronJobSpec struct { ...@@ -93,18 +93,17 @@ type CronJobSpec struct {
// +optional // +optional
StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"` StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"` ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
Suspend *bool `json:"suspend,omitempty" protobuf:"varint,4,opt,name=suspend"` Suspend *bool `json:"suspend,omitempty" protobuf:"varint,4,opt,name=suspend"`
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"` JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"`
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -138,11 +137,11 @@ const ( ...@@ -138,11 +137,11 @@ const (
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
type CronJobStatus struct { type CronJobStatus struct {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"` Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"`
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"` LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"`
} }
pkg/apis/batch/v2alpha1/types_swagger_doc_generated.go
View file @ 4a68dda8
...@@ -30,8 +30,8 @@ package v2alpha1 ...@@ -30,8 +30,8 @@ package v2alpha1
var map_CronJob = map[string]string{ var map_CronJob = map[string]string{
"": "CronJob represents the configuration of a single cron job.", "": "CronJob represents the configuration of a single cron job.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"spec": "Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "spec": "Specification of the desired behavior of a cron job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"status": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "status": "Current status of a cron job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (CronJob) SwaggerDoc() map[string]string { func (CronJob) SwaggerDoc() map[string]string {
...@@ -40,8 +40,8 @@ func (CronJob) SwaggerDoc() map[string]string { ...@@ -40,8 +40,8 @@ func (CronJob) SwaggerDoc() map[string]string {
var map_CronJobList = map[string]string{ var map_CronJobList = map[string]string{
"": "CronJobList is a collection of cron jobs.", "": "CronJobList is a collection of cron jobs.",
"metadata": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"items": "Items is the list of CronJob.", "items": "items is the list of CronJobs.",
} }
func (CronJobList) SwaggerDoc() map[string]string { func (CronJobList) SwaggerDoc() map[string]string {
...@@ -50,11 +50,11 @@ func (CronJobList) SwaggerDoc() map[string]string { ...@@ -50,11 +50,11 @@ func (CronJobList) SwaggerDoc() map[string]string {
var map_CronJobSpec = map[string]string{ var map_CronJobSpec = map[string]string{
"": "CronJobSpec describes how the job execution will look like and when it will actually run.", "": "CronJobSpec describes how the job execution will look like and when it will actually run.",
"schedule": "Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", "schedule": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
"startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.", "startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.",
"concurrencyPolicy": "ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow.", "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
"suspend": "Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.", "suspend": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
"jobTemplate": "JobTemplate is the object that describes the job that will be created when executing a CronJob.", "jobTemplate": "Specifies the job that will be created when executing a CronJob.",
"successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.", "successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.",
"failedJobsHistoryLimit": "The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.", "failedJobsHistoryLimit": "The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.",
} }
...@@ -65,8 +65,8 @@ func (CronJobSpec) SwaggerDoc() map[string]string { ...@@ -65,8 +65,8 @@ func (CronJobSpec) SwaggerDoc() map[string]string {
var map_CronJobStatus = map[string]string{ var map_CronJobStatus = map[string]string{
"": "CronJobStatus represents the current state of a cron job.", "": "CronJobStatus represents the current state of a cron job.",
"active": "Active holds pointers to currently running jobs.", "active": "A list of pointers to currently running jobs.",
"lastScheduleTime": "LastScheduleTime keeps information of when was the last time the job was successfully scheduled.", "lastScheduleTime": "Information when was the last time the job was successfully scheduled.",
} }
func (CronJobStatus) SwaggerDoc() map[string]string { func (CronJobStatus) SwaggerDoc() map[string]string {
...@@ -76,7 +76,7 @@ func (CronJobStatus) SwaggerDoc() map[string]string { ...@@ -76,7 +76,7 @@ func (CronJobStatus) SwaggerDoc() map[string]string {
var map_JobTemplate = map[string]string{ var map_JobTemplate = map[string]string{
"": "JobTemplate describes a template for creating copies of a predefined pod.", "": "JobTemplate describes a template for creating copies of a predefined pod.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"template": "Template defines jobs that will be created from this template http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "template": "Defines jobs that will be created from this template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (JobTemplate) SwaggerDoc() map[string]string { func (JobTemplate) SwaggerDoc() map[string]string {
......
pkg/generated/openapi/zz_generated.openapi.go
View file @ 4a68dda8
...@@ -12062,13 +12062,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12062,13 +12062,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", Description: "Specification of the desired behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v1.JobSpec"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v1.JobSpec"),
}, },
}, },
"status": { "status": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", Description: "Current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v1.JobStatus"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v1.JobStatus"),
}, },
}, },
...@@ -12151,13 +12151,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12151,13 +12151,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"metadata": { "metadata": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", Description: "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ListMeta"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ListMeta"),
}, },
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of Job.", Description: "items is the list of Jobs.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
...@@ -12182,14 +12182,14 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12182,14 +12182,14 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"parallelism": { "parallelism": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs", Description: "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
}, },
"completions": { "completions": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs", Description: "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
...@@ -12203,20 +12203,20 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12203,20 +12203,20 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"selector": { "selector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors", Description: "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
}, },
}, },
"manualSelector": { "manualSelector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md", Description: "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md",
Type: []string{"boolean"}, Type: []string{"boolean"},
Format: "", Format: "",
}, },
}, },
"template": { "template": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs", Description: "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs",
Ref: ref("k8s.io/kubernetes/pkg/api/v1.PodTemplateSpec"), Ref: ref("k8s.io/kubernetes/pkg/api/v1.PodTemplateSpec"),
}, },
}, },
...@@ -12240,7 +12240,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12240,7 +12240,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs", Description: "The latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
...@@ -12253,33 +12253,33 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12253,33 +12253,33 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"startTime": { "startTime": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", Description: "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"),
}, },
}, },
"completionTime": { "completionTime": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", Description: "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"),
}, },
}, },
"active": { "active": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Active is the number of actively running pods.", Description: "The number of actively running pods.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
}, },
"succeeded": { "succeeded": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Succeeded is the number of pods which reached Phase Succeeded.", Description: "The number of pods which reached phase Succeeded.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
}, },
"failed": { "failed": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Failed is the number of pods which reached Phase Failed.", Description: "The number of pods which reached phase Failed.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
...@@ -12317,13 +12317,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12317,13 +12317,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", Description: "Specification of the desired behavior of a cron job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.CronJobSpec"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.CronJobSpec"),
}, },
}, },
"status": { "status": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", Description: "Current status of a cron job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.CronJobStatus"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.CronJobStatus"),
}, },
}, },
...@@ -12354,13 +12354,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12354,13 +12354,13 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"metadata": { "metadata": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", Description: "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ListMeta"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ListMeta"),
}, },
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of CronJob.", Description: "items is the list of CronJobs.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
...@@ -12385,7 +12385,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12385,7 +12385,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"schedule": { "schedule": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", Description: "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
...@@ -12399,21 +12399,21 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12399,21 +12399,21 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"concurrencyPolicy": { "concurrencyPolicy": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow.", Description: "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"suspend": { "suspend": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.", Description: "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
Type: []string{"boolean"}, Type: []string{"boolean"},
Format: "", Format: "",
}, },
}, },
"jobTemplate": { "jobTemplate": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "JobTemplate is the object that describes the job that will be created when executing a CronJob.", Description: "Specifies the job that will be created when executing a CronJob.",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.JobTemplateSpec"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.JobTemplateSpec"),
}, },
}, },
...@@ -12445,7 +12445,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12445,7 +12445,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"active": { "active": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Active holds pointers to currently running jobs.", Description: "A list of pointers to currently running jobs.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
...@@ -12458,7 +12458,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12458,7 +12458,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"lastScheduleTime": { "lastScheduleTime": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "LastScheduleTime keeps information of when was the last time the job was successfully scheduled.", Description: "Information when was the last time the job was successfully scheduled.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"),
}, },
}, },
...@@ -12495,7 +12495,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope ...@@ -12495,7 +12495,7 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
}, },
"template": { "template": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Template defines jobs that will be created from this template http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", Description: "Defines jobs that will be created from this template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.JobTemplateSpec"), Ref: ref("k8s.io/kubernetes/pkg/apis/batch/v2alpha1.JobTemplateSpec"),
}, },
}, },
......
staging/src/k8s.io/client-go/pkg/apis/batch/types.go
View file @ 4a68dda8
...@@ -31,12 +31,12 @@ type Job struct { ...@@ -31,12 +31,12 @@ type Job struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec JobSpec Spec JobSpec
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status JobStatus Status JobStatus
...@@ -45,12 +45,12 @@ type Job struct { ...@@ -45,12 +45,12 @@ type Job struct {
// JobList is a collection of jobs. // JobList is a collection of jobs.
type JobList struct { type JobList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of Job. // items is the list of Jobs.
Items []Job Items []Job
} }
...@@ -62,7 +62,7 @@ type JobTemplate struct { ...@@ -62,7 +62,7 @@ type JobTemplate struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Template JobTemplateSpec Template JobTemplateSpec
...@@ -84,14 +84,14 @@ type JobTemplateSpec struct { ...@@ -84,14 +84,14 @@ type JobTemplateSpec struct {
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
type JobSpec struct { type JobSpec struct {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
// +optional // +optional
Parallelism *int32 Parallelism *int32
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -104,12 +104,12 @@ type JobSpec struct { ...@@ -104,12 +104,12 @@ type JobSpec struct {
// +optional // +optional
ActiveDeadlineSeconds *int64 ActiveDeadlineSeconds *int64
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// +optional // +optional
Selector *metav1.LabelSelector Selector *metav1.LabelSelector
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -121,39 +121,38 @@ type JobSpec struct { ...@@ -121,39 +121,38 @@ type JobSpec struct {
// +optional // +optional
ManualSelector *bool ManualSelector *bool
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
Template api.PodTemplateSpec Template api.PodTemplateSpec
} }
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
type JobStatus struct { type JobStatus struct {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// +optional // +optional
Conditions []JobCondition Conditions []JobCondition
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
StartTime *metav1.Time StartTime *metav1.Time
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
CompletionTime *metav1.Time CompletionTime *metav1.Time
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
Active int32 Active int32
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
Succeeded int32 Succeeded int32
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
Failed int32 Failed int32
} }
...@@ -198,12 +197,12 @@ type CronJob struct { ...@@ -198,12 +197,12 @@ type CronJob struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec CronJobSpec Spec CronJobSpec
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status CronJobStatus Status CronJobStatus
...@@ -212,19 +211,19 @@ type CronJob struct { ...@@ -212,19 +211,19 @@ type CronJob struct {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
type CronJobList struct { type CronJobList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of CronJob. // items is the list of CronJobs.
Items []CronJob Items []CronJob
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
type CronJobSpec struct { type CronJobSpec struct {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string Schedule string
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -232,18 +231,17 @@ type CronJobSpec struct { ...@@ -232,18 +231,17 @@ type CronJobSpec struct {
// +optional // +optional
StartingDeadlineSeconds *int64 StartingDeadlineSeconds *int64
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
ConcurrencyPolicy ConcurrencyPolicy ConcurrencyPolicy ConcurrencyPolicy
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
Suspend *bool Suspend *bool
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
JobTemplate JobTemplateSpec JobTemplate JobTemplateSpec
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -277,11 +275,11 @@ const ( ...@@ -277,11 +275,11 @@ const (
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
type CronJobStatus struct { type CronJobStatus struct {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
Active []api.ObjectReference Active []api.ObjectReference
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
LastScheduleTime *metav1.Time LastScheduleTime *metav1.Time
} }
staging/src/k8s.io/client-go/pkg/apis/batch/v1/generated.proto
View file @ 4a68dda8
...@@ -38,12 +38,12 @@ message Job { ...@@ -38,12 +38,12 @@ message Job {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobSpec spec = 2; optional JobSpec spec = 2;
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobStatus status = 3; optional JobStatus status = 3;
...@@ -76,18 +76,18 @@ message JobCondition { ...@@ -76,18 +76,18 @@ message JobCondition {
// JobList is a collection of jobs. // JobList is a collection of jobs.
message JobList { message JobList {
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of Job. // items is the list of Jobs.
repeated Job items = 2; repeated Job items = 2;
} }
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
message JobSpec { message JobSpec {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
...@@ -95,7 +95,7 @@ message JobSpec { ...@@ -95,7 +95,7 @@ message JobSpec {
// +optional // +optional
optional int32 parallelism = 1; optional int32 parallelism = 1;
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -109,13 +109,13 @@ message JobSpec { ...@@ -109,13 +109,13 @@ message JobSpec {
// +optional // +optional
optional int64 activeDeadlineSeconds = 3; optional int64 activeDeadlineSeconds = 3;
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// More info: http://kubernetes.io/docs/user-guide/labels#label-selectors // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4; optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -128,42 +128,41 @@ message JobSpec { ...@@ -128,42 +128,41 @@ message JobSpec {
// +optional // +optional
optional bool manualSelector = 5; optional bool manualSelector = 5;
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
optional k8s.io.kubernetes.pkg.api.v1.PodTemplateSpec template = 6; optional k8s.io.kubernetes.pkg.api.v1.PodTemplateSpec template = 6;
} }
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
message JobStatus { message JobStatus {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
// +patchStrategy=merge // +patchStrategy=merge
repeated JobCondition conditions = 1; repeated JobCondition conditions = 1;
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2;
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
optional int32 active = 4; optional int32 active = 4;
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
optional int32 succeeded = 5; optional int32 succeeded = 5;
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
optional int32 failed = 6; optional int32 failed = 6;
} }
......
staging/src/k8s.io/client-go/pkg/apis/batch/v1/types.go
View file @ 4a68dda8
...@@ -31,12 +31,12 @@ type Job struct { ...@@ -31,12 +31,12 @@ type Job struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is a structure defining the expected behavior of a job. // Specification of the desired behavior of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is a structure describing current status of a job. // Current status of a job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
...@@ -45,19 +45,19 @@ type Job struct { ...@@ -45,19 +45,19 @@ type Job struct {
// JobList is a collection of jobs. // JobList is a collection of jobs.
type JobList struct { type JobList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of Job. // items is the list of Jobs.
Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// JobSpec describes how the job execution will look like. // JobSpec describes how the job execution will look like.
type JobSpec struct { type JobSpec struct {
// Parallelism specifies the maximum desired number of pods the job should // Specifies the maximum desired number of pods the job should
// run at any given time. The actual number of pods running in steady state will // run at any given time. The actual number of pods running in steady state will
// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
// i.e. when the work left to do is less than max parallelism. // i.e. when the work left to do is less than max parallelism.
...@@ -65,7 +65,7 @@ type JobSpec struct { ...@@ -65,7 +65,7 @@ type JobSpec struct {
// +optional // +optional
Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"` Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"`
// Completions specifies the desired number of successfully finished pods the // Specifies the desired number of successfully finished pods the
// job should be run with. Setting to nil means that the success of any // job should be run with. Setting to nil means that the success of any
// pod signals the success of all pods, and allows parallelism to have any positive // pod signals the success of all pods, and allows parallelism to have any positive
// value. Setting to 1 means that parallelism is limited to 1 and the success of that // value. Setting to 1 means that parallelism is limited to 1 and the success of that
...@@ -79,13 +79,13 @@ type JobSpec struct { ...@@ -79,13 +79,13 @@ type JobSpec struct {
// +optional // +optional
ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"` ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"`
// Selector is a label query over pods that should match the pod count. // A label query over pods that should match the pod count.
// Normally, the system sets this field for you. // Normally, the system sets this field for you.
// More info: http://kubernetes.io/docs/user-guide/labels#label-selectors // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
// +optional // +optional
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"` Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"`
// ManualSelector controls generation of pod labels and pod selectors. // manualSelector controls generation of pod labels and pod selectors.
// Leave `manualSelector` unset unless you are certain what you are doing. // Leave `manualSelector` unset unless you are certain what you are doing.
// When false or unset, the system pick labels unique to this job // When false or unset, the system pick labels unique to this job
// and appends those labels to the pod template. When true, // and appends those labels to the pod template. When true,
...@@ -98,8 +98,7 @@ type JobSpec struct { ...@@ -98,8 +98,7 @@ type JobSpec struct {
// +optional // +optional
ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"` ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"`
// Template is the object that describes the pod that will be created when // Describes the pod that will be created when executing a job.
// executing a job.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"` Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"`
} }
...@@ -107,34 +106,34 @@ type JobSpec struct { ...@@ -107,34 +106,34 @@ type JobSpec struct {
// JobStatus represents the current state of a Job. // JobStatus represents the current state of a Job.
type JobStatus struct { type JobStatus struct {
// Conditions represent the latest available observations of an object's current state. // The latest available observations of an object's current state.
// More info: http://kubernetes.io/docs/user-guide/jobs // More info: http://kubernetes.io/docs/user-guide/jobs
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
// +patchStrategy=merge // +patchStrategy=merge
Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
// StartTime represents time when the job was acknowledged by the Job Manager. // Represents time when the job was acknowledged by the job controller.
// It is not guaranteed to be set in happens-before order across separate operations. // It is not guaranteed to be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"` StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"`
// CompletionTime represents time when the job was completed. It is not guaranteed to // Represents time when the job was completed. It is not guaranteed to
// be set in happens-before order across separate operations. // be set in happens-before order across separate operations.
// It is represented in RFC3339 form and is in UTC. // It is represented in RFC3339 form and is in UTC.
// +optional // +optional
CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"` CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`
// Active is the number of actively running pods. // The number of actively running pods.
// +optional // +optional
Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"` Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`
// Succeeded is the number of pods which reached Phase Succeeded. // The number of pods which reached phase Succeeded.
// +optional // +optional
Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"` Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"`
// Failed is the number of pods which reached Phase Failed. // The number of pods which reached phase Failed.
// +optional // +optional
Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"` Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"`
} }
......
staging/src/k8s.io/client-go/pkg/apis/batch/v1/types_swagger_doc_generated.go
View file @ 4a68dda8
...@@ -30,8 +30,8 @@ package v1 ...@@ -30,8 +30,8 @@ package v1
var map_Job = map[string]string{ var map_Job = map[string]string{
"": "Job represents the configuration of a single job.", "": "Job represents the configuration of a single job.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"spec": "Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "spec": "Specification of the desired behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"status": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "status": "Current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (Job) SwaggerDoc() map[string]string { func (Job) SwaggerDoc() map[string]string {
...@@ -54,8 +54,8 @@ func (JobCondition) SwaggerDoc() map[string]string { ...@@ -54,8 +54,8 @@ func (JobCondition) SwaggerDoc() map[string]string {
var map_JobList = map[string]string{ var map_JobList = map[string]string{
"": "JobList is a collection of jobs.", "": "JobList is a collection of jobs.",
"metadata": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"items": "Items is the list of Job.", "items": "items is the list of Jobs.",
} }
func (JobList) SwaggerDoc() map[string]string { func (JobList) SwaggerDoc() map[string]string {
...@@ -64,12 +64,12 @@ func (JobList) SwaggerDoc() map[string]string { ...@@ -64,12 +64,12 @@ func (JobList) SwaggerDoc() map[string]string {
var map_JobSpec = map[string]string{ var map_JobSpec = map[string]string{
"": "JobSpec describes how the job execution will look like.", "": "JobSpec describes how the job execution will look like.",
"parallelism": "Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs", "parallelism": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs",
"completions": "Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs", "completions": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs",
"activeDeadlineSeconds": "Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer", "activeDeadlineSeconds": "Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer",
"selector": "Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors", "selector": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors",
"manualSelector": "ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md", "manualSelector": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md",
"template": "Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs", "template": "Describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs",
} }
func (JobSpec) SwaggerDoc() map[string]string { func (JobSpec) SwaggerDoc() map[string]string {
...@@ -78,12 +78,12 @@ func (JobSpec) SwaggerDoc() map[string]string { ...@@ -78,12 +78,12 @@ func (JobSpec) SwaggerDoc() map[string]string {
var map_JobStatus = map[string]string{ var map_JobStatus = map[string]string{
"": "JobStatus represents the current state of a Job.", "": "JobStatus represents the current state of a Job.",
"conditions": "Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs", "conditions": "The latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs",
"startTime": "StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "startTime": "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"completionTime": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "completionTime": "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"active": "Active is the number of actively running pods.", "active": "The number of actively running pods.",
"succeeded": "Succeeded is the number of pods which reached Phase Succeeded.", "succeeded": "The number of pods which reached phase Succeeded.",
"failed": "Failed is the number of pods which reached Phase Failed.", "failed": "The number of pods which reached phase Failed.",
} }
func (JobStatus) SwaggerDoc() map[string]string { func (JobStatus) SwaggerDoc() map[string]string {
......
staging/src/k8s.io/client-go/pkg/apis/batch/v2alpha1/generated.proto
View file @ 4a68dda8
...@@ -39,12 +39,12 @@ message CronJob { ...@@ -39,12 +39,12 @@ message CronJob {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional CronJobSpec spec = 2; optional CronJobSpec spec = 2;
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional CronJobStatus status = 3; optional CronJobStatus status = 3;
...@@ -52,18 +52,18 @@ message CronJob { ...@@ -52,18 +52,18 @@ message CronJob {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
message CronJobList { message CronJobList {
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of CronJob. // items is the list of CronJobs.
repeated CronJob items = 2; repeated CronJob items = 2;
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
message CronJobSpec { message CronJobSpec {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
optional string schedule = 1; optional string schedule = 1;
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -71,18 +71,17 @@ message CronJobSpec { ...@@ -71,18 +71,17 @@ message CronJobSpec {
// +optional // +optional
optional int64 startingDeadlineSeconds = 2; optional int64 startingDeadlineSeconds = 2;
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
optional string concurrencyPolicy = 3; optional string concurrencyPolicy = 3;
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
optional bool suspend = 4; optional bool suspend = 4;
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
optional JobTemplateSpec jobTemplate = 5; optional JobTemplateSpec jobTemplate = 5;
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -98,11 +97,11 @@ message CronJobSpec { ...@@ -98,11 +97,11 @@ message CronJobSpec {
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
message CronJobStatus { message CronJobStatus {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
repeated k8s.io.kubernetes.pkg.api.v1.ObjectReference active = 1; repeated k8s.io.kubernetes.pkg.api.v1.ObjectReference active = 1;
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastScheduleTime = 4; optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastScheduleTime = 4;
} }
...@@ -114,7 +113,7 @@ message JobTemplate { ...@@ -114,7 +113,7 @@ message JobTemplate {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
optional JobTemplateSpec template = 2; optional JobTemplateSpec template = 2;
......
staging/src/k8s.io/client-go/pkg/apis/batch/v2alpha1/types.go
View file @ 4a68dda8
...@@ -30,7 +30,7 @@ type JobTemplate struct { ...@@ -30,7 +30,7 @@ type JobTemplate struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Template defines jobs that will be created from this template // Defines jobs that will be created from this template.
// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Template JobTemplateSpec `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"` Template JobTemplateSpec `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"`
...@@ -59,12 +59,12 @@ type CronJob struct { ...@@ -59,12 +59,12 @@ type CronJob struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is a structure defining the expected behavior of a job, including the schedule. // Specification of the desired behavior of a cron job, including the schedule.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is a structure describing current status of a job. // Current status of a cron job.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
// +optional // +optional
Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
...@@ -73,19 +73,19 @@ type CronJob struct { ...@@ -73,19 +73,19 @@ type CronJob struct {
// CronJobList is a collection of cron jobs. // CronJobList is a collection of cron jobs.
type CronJobList struct { type CronJobList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata // Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of CronJob. // items is the list of CronJobs.
Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"` Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// CronJobSpec describes how the job execution will look like and when it will actually run. // CronJobSpec describes how the job execution will look like and when it will actually run.
type CronJobSpec struct { type CronJobSpec struct {
// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"` Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"`
// Optional deadline in seconds for starting the job if it misses scheduled // Optional deadline in seconds for starting the job if it misses scheduled
...@@ -93,18 +93,17 @@ type CronJobSpec struct { ...@@ -93,18 +93,17 @@ type CronJobSpec struct {
// +optional // +optional
StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"` StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`
// ConcurrencyPolicy specifies how to treat concurrent executions of a Job. // Specifies how to treat concurrent executions of a Job.
// Defaults to Allow. // Defaults to Allow.
// +optional // +optional
ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"` ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`
// Suspend flag tells the controller to suspend subsequent executions, it does // This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false. // not apply to already started executions. Defaults to false.
// +optional // +optional
Suspend *bool `json:"suspend,omitempty" protobuf:"varint,4,opt,name=suspend"` Suspend *bool `json:"suspend,omitempty" protobuf:"varint,4,opt,name=suspend"`
// JobTemplate is the object that describes the job that will be created when // Specifies the job that will be created when executing a CronJob.
// executing a CronJob.
JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"` JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"`
// The number of successful finished jobs to retain. // The number of successful finished jobs to retain.
...@@ -138,11 +137,11 @@ const ( ...@@ -138,11 +137,11 @@ const (
// CronJobStatus represents the current state of a cron job. // CronJobStatus represents the current state of a cron job.
type CronJobStatus struct { type CronJobStatus struct {
// Active holds pointers to currently running jobs. // A list of pointers to currently running jobs.
// +optional // +optional
Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"` Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"`
// LastScheduleTime keeps information of when was the last time the job was successfully scheduled. // Information when was the last time the job was successfully scheduled.
// +optional // +optional
LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"` LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"`
} }
staging/src/k8s.io/client-go/pkg/apis/batch/v2alpha1/types_swagger_doc_generated.go
View file @ 4a68dda8
...@@ -30,8 +30,8 @@ package v2alpha1 ...@@ -30,8 +30,8 @@ package v2alpha1
var map_CronJob = map[string]string{ var map_CronJob = map[string]string{
"": "CronJob represents the configuration of a single cron job.", "": "CronJob represents the configuration of a single cron job.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"spec": "Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "spec": "Specification of the desired behavior of a cron job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
"status": "Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "status": "Current status of a cron job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (CronJob) SwaggerDoc() map[string]string { func (CronJob) SwaggerDoc() map[string]string {
...@@ -40,8 +40,8 @@ func (CronJob) SwaggerDoc() map[string]string { ...@@ -40,8 +40,8 @@ func (CronJob) SwaggerDoc() map[string]string {
var map_CronJobList = map[string]string{ var map_CronJobList = map[string]string{
"": "CronJobList is a collection of cron jobs.", "": "CronJobList is a collection of cron jobs.",
"metadata": "Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"items": "Items is the list of CronJob.", "items": "items is the list of CronJobs.",
} }
func (CronJobList) SwaggerDoc() map[string]string { func (CronJobList) SwaggerDoc() map[string]string {
...@@ -50,11 +50,11 @@ func (CronJobList) SwaggerDoc() map[string]string { ...@@ -50,11 +50,11 @@ func (CronJobList) SwaggerDoc() map[string]string {
var map_CronJobSpec = map[string]string{ var map_CronJobSpec = map[string]string{
"": "CronJobSpec describes how the job execution will look like and when it will actually run.", "": "CronJobSpec describes how the job execution will look like and when it will actually run.",
"schedule": "Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", "schedule": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.",
"startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.", "startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.",
"concurrencyPolicy": "ConcurrencyPolicy specifies how to treat concurrent executions of a Job. Defaults to Allow.", "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Defaults to Allow.",
"suspend": "Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.", "suspend": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.",
"jobTemplate": "JobTemplate is the object that describes the job that will be created when executing a CronJob.", "jobTemplate": "Specifies the job that will be created when executing a CronJob.",
"successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.", "successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.",
"failedJobsHistoryLimit": "The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.", "failedJobsHistoryLimit": "The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.",
} }
...@@ -65,8 +65,8 @@ func (CronJobSpec) SwaggerDoc() map[string]string { ...@@ -65,8 +65,8 @@ func (CronJobSpec) SwaggerDoc() map[string]string {
var map_CronJobStatus = map[string]string{ var map_CronJobStatus = map[string]string{
"": "CronJobStatus represents the current state of a cron job.", "": "CronJobStatus represents the current state of a cron job.",
"active": "Active holds pointers to currently running jobs.", "active": "A list of pointers to currently running jobs.",
"lastScheduleTime": "LastScheduleTime keeps information of when was the last time the job was successfully scheduled.", "lastScheduleTime": "Information when was the last time the job was successfully scheduled.",
} }
func (CronJobStatus) SwaggerDoc() map[string]string { func (CronJobStatus) SwaggerDoc() map[string]string {
...@@ -76,7 +76,7 @@ func (CronJobStatus) SwaggerDoc() map[string]string { ...@@ -76,7 +76,7 @@ func (CronJobStatus) SwaggerDoc() map[string]string {
var map_JobTemplate = map[string]string{ var map_JobTemplate = map[string]string{
"": "JobTemplate describes a template for creating copies of a predefined pod.", "": "JobTemplate describes a template for creating copies of a predefined pod.",
"metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"template": "Template defines jobs that will be created from this template http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status", "template": "Defines jobs that will be created from this template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status",
} }
func (JobTemplate) SwaggerDoc() map[string]string { func (JobTemplate) SwaggerDoc() map[string]string {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment