zuul
/
nodepool
Code Issues Proposed changes

Add k8s annotations to pods 

This allows adding key/value pairs under
metadata.annotations in the kubernetes
resource specification.
This information can be used by different tools
to govern handling of resources.

One particular use-case is the runai-scheduler which
uses annotations to allocate fractional GPU resources
to a pod.

Change-Id: Ib319caffe51e00bedda2861e8e1f2bbe04340322
This commit is contained in:
mbecker 2023-05-23 11:27:06 +02:00
parent 4e3690812b
commit 60195adaea
10 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/kubernetes.rst
View File

@ -224,6 +224,16 @@ Selecting the kubernetes driver adds the following options to the
that this field contains arbitrary key/value pairs and is
unrelated to the concept of labels in Nodepool.
.. attr:: annotations
:type: dict
A dictionary of additional values to be added to the
pod metadata. The value of this field is
added to the `metadata.annotations` field in OpenShift.
This field contains arbitrary key/value pairs that can be accessed
by tools and libraries. E.g custom schedulers can make use of this
metadata.
.. attr:: python-path
:type: str
:default: auto

10
doc/source/openshift-pods.rst
View File

@ -174,6 +174,16 @@ Selecting the openshift pods driver adds the following options to the
that this field contains arbitrary key/value pairs and is
unrelated to the concept of labels in Nodepool.
.. attr:: annotations
:type: dict
A dictionary of additional values to be added to the
pod metadata. The value of this field is
added to the `metadata.annotations` field in OpenShift.
This field contains arbitrary key/value pairs that can be accessed
by tools and libraries. E.g custom schedulers can make use of this
metadata.
.. attr:: cpu
:type: int

10
doc/source/openshift.rst
View File

@ -222,6 +222,16 @@ Selecting the openshift driver adds the following options to the
that this field contains arbitrary key/value pairs and is
unrelated to the concept of labels in Nodepool.
.. attr:: annotations
:type: dict
A dictionary of additional values to be added to the
pod metadata. The value of this field is
added to the `metadata.annotations` field in OpenShift.
This field contains arbitrary key/value pairs that can be accessed
by tools and libraries. E.g custom schedulers can make use of this
metadata.
.. attr:: python-path
:type: str
:default: auto

2
nodepool/driver/kubernetes/config.py
View File

@ -79,6 +79,7 @@ class KubernetesPool(ConfigPool):
pl.volumes = label.get('volumes')
pl.volume_mounts = label.get('volume-mounts')
pl.labels = label.get('labels')
pl.annotations = label.get('annotations')
pl.pool = self
self.labels[pl.name] = pl
full_config.labels[label['name']].pools.append(self)
@ -133,6 +134,7 @@ class KubernetesProviderConfig(ProviderConfig):
'volumes': list,
'volume-mounts': list,
'labels': dict,
'annotations': dict,
}
pool = ConfigPool.getCommonSchemaDict()

5
nodepool/driver/kubernetes/provider.py
View File

@ -371,12 +371,17 @@ class KubernetesProvider(Provider, QuotaSupport):
'nodepool_node_label': label.name,
})
k8s_annotations = {}
if label.annotations:
k8s_annotations.update(label.annotations)
pod_body = {
'apiVersion': 'v1',
'kind': 'Pod',
'metadata': {
'name': label.name,
'labels': k8s_labels,
'annotations': k8s_annotations,
},
'spec': spec_body,
'restartPolicy': 'Never',

2
nodepool/driver/openshift/config.py
View File

@ -79,6 +79,7 @@ class OpenshiftPool(ConfigPool):
pl.volumes = label.get('volumes')
pl.volume_mounts = label.get('volume-mounts')
pl.labels = label.get('labels')
pl.annotations = label.get('annotations')
pl.pool = self
self.labels[pl.name] = pl
full_config.labels[label['name']].pools.append(self)
@ -135,6 +136,7 @@ class OpenshiftProviderConfig(ProviderConfig):
'volumes': list,
'volume-mounts': list,
'labels': dict,
'annotations': dict,
}
pool = ConfigPool.getCommonSchemaDict()

5
nodepool/driver/openshift/provider.py
View File

@ -288,12 +288,17 @@ class OpenshiftProvider(Provider, QuotaSupport):
'nodepool_node_label': label.name,
})
k8s_annotations = {}
if label.annotations:
k8s_annotations.update(label.annotations)
pod_body = {
'apiVersion': 'v1',
'kind': 'Pod',
'metadata': {
'name': pod_name,
'labels': k8s_labels,
'annotations': k8s_annotations,
},
'spec': spec_body,
'restartPolicy': 'Never',

1
nodepool/driver/openshiftpods/config.py
View File

@ -69,6 +69,7 @@ class OpenshiftPodsProviderConfig(OpenshiftProviderConfig):
'volumes': list,
'volume-mounts': list,
'labels': dict,
'annotations': dict,
}
pool = ConfigPool.getCommonSchemaDict()

2
nodepool/tests/unit/test_driver_kubernetes.py
View File

@ -138,6 +138,7 @@ class TestDriverKubernetes(tests.DBTestCase):
ns, pod = self.fake_k8s_client._pod_requests[0]
self.assertEqual(pod['metadata'], {
'name': 'pod-fedora',
'annotations': {},
'labels': {
'nodepool_node_id': '0000000000',
'nodepool_provider_name': 'kubespray',
@ -190,6 +191,7 @@ class TestDriverKubernetes(tests.DBTestCase):
ns, pod = self.fake_k8s_client._pod_requests[0]
self.assertEqual(pod['metadata'], {
'name': 'pod-extra',
'annotations': {},
'labels': {
'environment': 'qa',
'nodepool_node_id': '0000000000',

2
nodepool/tests/unit/test_driver_openshift.py
View File

@ -169,6 +169,7 @@ class TestDriverOpenshift(tests.DBTestCase):
ns, pod = self.fake_k8s_client._pod_requests[0]
self.assertEqual(pod['metadata'], {
'name': 'pod-fedora',
'annotations': {},
'labels': {
'nodepool_node_id': '0000000000',
'nodepool_provider_name': 'openshift',
@ -224,6 +225,7 @@ class TestDriverOpenshift(tests.DBTestCase):
ns, pod = self.fake_k8s_client._pod_requests[0]
self.assertEqual(pod['metadata'], {
'name': 'pod-extra',
'annotations': {},
'labels': {
'environment': 'qa',
'nodepool_node_id': '0000000000',