forked from kubernetes-client/python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cluster_scoped_custom_object.py
141 lines (123 loc) · 4.22 KB
/
cluster_scoped_custom_object.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Copyright 2021 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Uses a Custom Resource Definition (CRD) to create a Custom Resource (CR), in this case
a CronTab. This example use an example CRD from this tutorial:
https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
Apply the following yaml manifest to create a cluster-scoped CustomResourceDefinition (CRD)
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: crontabs.stable.example.com
spec:
group: stable.example.com
versions:
- name: v1
served: true
storage: true
schema:
openAPIV3Schema:
type: object
properties:
spec:
type: object
properties:
cronSpec:
type: string
image:
type: string
replicas:
type: integer
scope: Cluster
names:
plural: crontabs
singular: crontab
kind: CronTab
shortNames:
- ct
"""
from pprint import pprint
from kubernetes import client, config
def main():
config.load_kube_config()
api = client.CustomObjectsApi()
# definition of custom resource
test_resource = {
"apiVersion": "stable.example.com/v1",
"kind": "CronTab",
"metadata": {"name": "test-crontab"},
"spec": {"cronSpec": "* * * * */5", "image": "my-awesome-cron-image"},
}
# patch to update the `spec.cronSpec` field
cronspec_patch = {
"spec": {"cronSpec": "* * * * */15", "image": "my-awesome-cron-image"}
}
# patch to add the `metadata.labels` field
metadata_label_patch = {
"metadata": {
"labels": {
"foo": "bar",
}
}
}
# create a cluster scoped resource
created_resource = api.create_cluster_custom_object(
group="stable.example.com",
version="v1",
plural="crontabs",
body=test_resource,
)
print("[INFO] Custom resource `test-crontab` created!\n")
# get the cluster scoped resource
resource = api.get_cluster_custom_object(
group="stable.example.com",
version="v1",
name="test-crontab",
plural="crontabs",
)
print("%s\t\t%s" % ("NAME", "CRON-SPEC"))
print(f"{resource['metadata']['name']}\t{resource['spec']['cronSpec']}\n")
# patch the `spec.cronSpec` field of the custom resource
patched_resource = api.patch_cluster_custom_object(
group="stable.example.com",
version="v1",
plural="crontabs",
name="test-crontab",
body=cronspec_patch,
)
print("[INFO] Custom resource `test-crontab` patched to update the cronSpec schedule!\n")
print("%s\t\t%s" % ("NAME", "PATCHED-CRON-SPEC"))
print(f"{patched_resource['metadata']['name']}\t{patched_resource['spec']['cronSpec']}\n")
# patch the `metadata.labels` field of the custom resource
patched_resource = api.patch_cluster_custom_object(
group="stable.example.com",
version="v1",
plural="crontabs",
name="test-crontab",
body=metadata_label_patch,
)
print("[INFO] Custom resource `test-crontab` patched to apply new metadata labels!\n")
print("%s\t\t%s" % ("NAME", "PATCHED_LABELS"))
print(f"{patched_resource['metadata']['name']}\t{patched_resource['metadata']['labels']}\n")
# delete the custom resource "test-crontab"
api.delete_cluster_custom_object(
group="stable.example.com",
version="v1",
name="test-crontab",
plural="crontabs",
body=client.V1DeleteOptions(),
)
print("[INFO] Custom resource `test-crontab` deleted!")
if __name__ == "__main__":
main()