You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 16, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ A Framework represents an application with a set of Tasks:
75
75
12. Aligned with Kubernetes [Controller Design Guidelines](https://github.com/kubernetes/community/blob/f0dd87ad477e1e91c53866902adf7832c32ce543/contributors/devel/sig-api-machinery/controllers.md) and [API Conventions](https://github.com/kubernetes/community/blob/a2cdce51a0bbbc214f0e8813e0a877176ad3b6c9/contributors/devel/sig-architecture/api-conventions.md)
76
76
77
77
## Prerequisite
78
-
1. A Kubernetes cluster, v1.14.2 or above, on-cloud or on-premise.
78
+
1. A Kubernetes cluster, v1.16.15 or above, on-cloud or on-premise.
|[ConfigMap](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#configmap-v1-core)| All operations except for [CREATE](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#create-configmap-v1-core)[PUT](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#replace-configmap-v1-core)[PATCH](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#patch-configmap-v1-core)|
44
-
|[Pod](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#pod-v1-core)| All operations except for [CREATE](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#create-pod-v1-core)[PUT](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#replace-pod-v1-core)[PATCH](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#patch-pod-v1-core)|
43
+
|[ConfigMap](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmap-v1-core)| All operations except for [CREATE](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#create-configmap-v1-core)[PUT](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#replace-configmap-v1-core)[PATCH](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#patch-configmap-v1-core)|
44
+
|[Pod](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#pod-v1-core)| All operations except for [CREATE](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#create-pod-v1-core)[PUT](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#replace-pod-v1-core)[PATCH](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#patch-pod-v1-core)|
@@ -98,7 +98,7 @@ Before the Start, the Framework will not start to run or complete, but the objec
98
98
| Code | Body | Description |
99
99
|:---- |:---- |:---- |
100
100
| OK(200) |[Framework](../pkg/apis/frameworkcontroller/v1/types.go)| Return current Framework. |
101
-
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified Framework is not found. |
101
+
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified Framework is not found. |
102
102
103
103
##### <aname="Stop_Framework">Stop Framework</a>
104
104
**Request**
@@ -130,7 +130,7 @@ After the Stop, the Framework will start to complete, but the object of the Fram
130
130
| Code | Body | Description |
131
131
|:---- |:---- |:---- |
132
132
| OK(200) |[Framework](../pkg/apis/frameworkcontroller/v1/types.go)| Return current Framework. |
133
-
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified Framework is not found. |
133
+
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified Framework is not found. |
134
134
135
135
##### <aname="Add_TaskRole">Add TaskRole</a>
136
136
**Request**
@@ -164,7 +164,7 @@ See more in [Framework ScaleUp/ScaleDown](#FrameworkRescale).
164
164
| Code | Body | Description |
165
165
|:---- |:---- |:---- |
166
166
| OK(200) |[Framework](../pkg/apis/frameworkcontroller/v1/types.go)| Return current Framework. |
167
-
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified Framework is not found. |
167
+
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified Framework is not found. |
| OK(200) |[Framework](../pkg/apis/frameworkcontroller/v1/types.go)| Return current Framework. |
208
-
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified Framework is not found. |
209
-
| UnprocessableEntity(422) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified $(TaskRoleName) does not exist or does not match the specified $(TaskRoleIndex). |
208
+
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified Framework is not found. |
209
+
| UnprocessableEntity(422) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified $(TaskRoleName) does not exist or does not match the specified $(TaskRoleIndex). |
@@ -272,8 +272,8 @@ See more in [Framework ScaleUp/ScaleDown](#FrameworkRescale).
272
272
| Code | Body | Description |
273
273
|:---- |:---- |:---- |
274
274
| OK(200) |[Framework](../pkg/apis/frameworkcontroller/v1/types.go)| Return current Framework. |
275
-
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified Framework is not found. |
276
-
| UnprocessableEntity(422) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta)| The specified $(TaskRoleName) does not exist or does not match the specified $(TaskRoleIndex). |
275
+
| NotFound(404) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified Framework is not found. |
276
+
| UnprocessableEntity(422) |[Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta)| The specified $(TaskRoleName) does not exist or does not match the specified $(TaskRoleIndex). |
@@ -301,15 +301,15 @@ Delete the specified Framework.
301
301
302
302
Notes:
303
303
* If you need to achieve all the [Framework ConsistencyGuarantees](#ConsistencyGuarantees) or achieve higher [Framework Availability](#FrameworkAvailability) by leveraging the [PodGracefulDeletionTimeoutSec](../pkg/apis/frameworkcontroller/v1/types.go), you should always use and only use the [Foreground Deletion](https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/#foreground-cascading-deletion) in the provided body.
304
-
* However, `kubectl delete` does not support to specify the Foreground Deletion at least for [Kubernetes v1.14.2](https://github.com/kubernetes/kubernetes/issues/66110#issuecomment-413761559), so you may have to use other [Supported Client](#SupportedClient).
304
+
* However, `kubectl delete` does not support to specify the Foreground Deletion at least for [Kubernetes v1.23.2](https://github.com/kubernetes/kubernetes/issues/66110#issuecomment-413761559), so you may have to use other [Supported Client](#SupportedClient).
305
305
306
306
**Response**
307
307
308
308
| Code | Body | Description |
309
309
|:---- |:---- |:---- |
310
310
| OK(200) | [Framework](../pkg/apis/frameworkcontroller/v1/types.go) | The specified Framework is deleting.<br>Return current Framework. |
311
-
| OK(200) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta) | The specified Framework is deleted. |
312
-
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta) | The specified Framework is not found. |
311
+
| OK(200) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta) | The specified Framework is deleted. |
312
+
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta) | The specified Framework is not found. |
313
313
314
314
#### <a name="GET_Framework">GET Framework</a>
315
315
**Request**
@@ -325,15 +325,15 @@ Get the specified Framework.
325
325
| Code | Body | Description |
326
326
|:---- |:---- |:---- |
327
327
| OK(200) | [Framework](../pkg/apis/frameworkcontroller/v1/types.go) | Return current Framework. |
328
-
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta) | The specified Framework is not found. |
328
+
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta) | The specified Framework is not found. |
GET /apis/frameworkcontroller.microsoft.com/v1/namespaces/{FrameworkNamespace}/frameworks
334
334
GET /apis/frameworkcontroller.microsoft.com/v1/frameworks
335
335
336
-
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#list-statefulset-v1-apps)
336
+
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#list-statefulset-v1-apps)
337
337
338
338
**Description**
339
339
@@ -350,7 +350,7 @@ Get all Frameworks (in the specified FrameworkNamespace).
350
350
351
351
GET /apis/frameworkcontroller.microsoft.com/v1/watch/namespaces/{FrameworkNamespace}/frameworks/{FrameworkName}
352
352
353
-
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#watch-statefulset-v1-apps)
353
+
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#watch-statefulset-v1-apps)
354
354
355
355
**Description**
356
356
@@ -360,16 +360,16 @@ Watch the change events of the specified Framework.
360
360
361
361
| Code | Body | Description |
362
362
|:---- |:---- |:---- |
363
-
| OK(200) | [WatchEvent](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#watchevent-v1-meta) | Streaming the change events of the specified Framework. |
364
-
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta) | The specified Framework is not found. |
363
+
| OK(200) | [WatchEvent](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#watchevent-v1-meta) | Streaming the change events of the specified Framework. |
364
+
| NotFound(404) | [Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#status-v1-meta) | The specified Framework is not found. |
GET /apis/frameworkcontroller.microsoft.com/v1/watch/namespaces/{FrameworkNamespace}/frameworks
370
370
GET /apis/frameworkcontroller.microsoft.com/v1/watch/frameworks
371
371
372
-
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#watch-list-statefulset-v1-apps)
372
+
QueryParameters: Same as [StatefulSet QueryParameters](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#watch-list-statefulset-v1-apps)
373
373
374
374
**Description**
375
375
@@ -379,7 +379,7 @@ Watch the change events of all Frameworks (in the specified FrameworkNamespace).
379
379
380
380
| Code | Body | Description |
381
381
|:---- |:---- |:---- |
382
-
| OK(200) | [WatchEvent](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#watchevent-v1-meta) | Streaming the change events of all Frameworks (in the specified FrameworkNamespace). |
382
+
| OK(200) | [WatchEvent](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#watchevent-v1-meta) | Streaming the change events of all Frameworks (in the specified FrameworkNamespace). |
2. Use above creation response's `metadata.uid` to override below {{FrameworkUID}}, and [Create ServiceAccount](https://v1-14.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#create-serviceaccount-v1-core) with above Framework reference as below:
425
+
2. Use above creation response's `metadata.uid` to override below {{FrameworkUID}}, and [Create ServiceAccount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#create-serviceaccount-v1-core) with above Framework reference as below:
0 commit comments