Adjust ML extension deployment for ContainerTemplate and PodTemplate (#1534)

Author: nikita-vanyasin

docs/api/ArangoMLExtension.V1Alpha1.md

@@ -2,6 +2,70 @@
 
 ## Spec
 
+### .spec.deployment.affinity
+
+Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/scheduling.go#L37)</sup>
+
+Affinity defines scheduling constraints for workload
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)
+
+***
+
+### .spec.deployment.hostIPC
+
+Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/container_namespace.go#L33)</sup>
+
+HostIPC defines to use the host's ipc namespace.
+
+Default Value: `false`
+
+***
+
+### .spec.deployment.hostNetwork
+
+Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/container_namespace.go#L27)</sup>
+
+HostNetwork requests Host network for this pod. Use the host's network namespace.
+If this option is set, the ports that will be used must be specified.
+
+Default Value: `false`
+
+***
+
+### .spec.deployment.hostPID
+
+Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/container_namespace.go#L30)</sup>
+
+HostPID define to use the host's pid namespace.
+
+Default Value: `false`
+
+***
+
+### .spec.deployment.nodeSelector
+
+Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/scheduling.go#L32)</sup>
+
+NodeSelector is a selector that must be true for the workload to fit on a node.
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector)
+
+***
+
+### .spec.deployment.podSecurityContext
+
+Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/security_pod.go#L29)</sup>
+
+PodSecurityContext holds pod-level security attributes and common container settings.
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
+
+***
+
 ### .spec.deployment.prediction.image
 
 Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/image.go#L31)</sup>
@@ -47,6 +111,17 @@ Links:
 
 ***
 
+### .spec.deployment.prediction.securityContext
+
+Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/security_container.go#L29)</sup>
+
+PodSecurityContext holds pod-level security attributes and common container settings.
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
+
+***
+
 ### .spec.deployment.project.image
 
 Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/image.go#L31)</sup>
@@ -92,16 +167,38 @@ Links:
 
 ***
 
+### .spec.deployment.project.securityContext
+
+Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/security_container.go#L29)</sup>
+
+PodSecurityContext holds pod-level security attributes and common container settings.
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
+
+***
+
 ### .spec.deployment.replicas
 
-Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/extension_spec_deployment.go#L32)</sup>
+Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/extension_spec_deployment.go#L33)</sup>
 
 Replicas defines the number of replicas running specified components. No replicas created if no components are defined.
 
 Default Value: `1`
 
 ***
 
+### .spec.deployment.schedulerName
+
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/scheduling.go#L47)</sup>
+
+SchedulerName specifies, the pod will be dispatched by specified scheduler.
+If not specified, the pod will be dispatched by default scheduler.
+
+Default Value: `""`
+
+***
+
 ### .spec.deployment.service.type
 
 Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/extension_spec_deployment_service.go#L37)</sup>
@@ -119,6 +216,30 @@ Possible Values:
 
 ***
 
+### .spec.deployment.shareProcessNamespace
+
+Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/container_namespace.go#L39)</sup>
+
+ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod.
+When this is set containers will be able to view and signal processes from other containers
+in the same pod, and the first process in each container will not be assigned PID 1.
+HostPID and ShareProcessNamespace cannot both be set.
+
+Default Value: `false`
+
+***
+
+### .spec.deployment.tolerations
+
+Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/scheduling.go#L42)</sup>
+
+Tolerations defines tolerations
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
+
+***
+
 ### .spec.deployment.training.image
 
 Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/image.go#L31)</sup>
@@ -164,6 +285,17 @@ Links:
 
 ***
 
+### .spec.deployment.training.securityContext
+
+Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/security_container.go#L29)</sup>
+
+PodSecurityContext holds pod-level security attributes and common container settings.
+
+Links:
+* [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
+
+***
+
 ### .spec.image
 
 Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/image.go#L31)</sup>

pkg/apis/ml/v1alpha1/extension_spec_deployment.go

@@ -22,6 +22,7 @@ package v1alpha1
 
 import (
 "github.com/arangodb/kube-arangodb/pkg/apis/shared"
+sharedApi "github.com/arangodb/kube-arangodb/pkg/apis/shared/v1"
 "github.com/arangodb/kube-arangodb/pkg/util"
 "github.com/arangodb/kube-arangodb/pkg/util/errors"
 )
@@ -34,6 +35,9 @@ type ArangoMLExtensionSpecDeployment struct {
 // Service defines how components will be exposed
 Service *ArangoMLExtensionSpecDeploymentService `json:"service,omitempty"`
 
+// PodTemplate defines base template for pods
+*sharedApi.PodTemplate
+
 // Prediction defines how Prediction workload will be deployed
 Prediction *ArangoMLExtensionSpecDeploymentComponent `json:"prediction,omitempty"`
 // Training defines how Training workload will be deployed
@@ -49,6 +53,14 @@ func (s *ArangoMLExtensionSpecDeployment) GetReplicas() int32 {
 return *s.Replicas
 }
 
+func (s *ArangoMLExtensionSpecDeployment) GetPodTemplate() *sharedApi.PodTemplate {
+if s == nil || s.PodTemplate == nil {
+return nil
+}
+
+return s.PodTemplate
+}
+
 func (s *ArangoMLExtensionSpecDeployment) GetPrediction() *ArangoMLExtensionSpecDeploymentComponent {
 if s == nil {
 return nil
@@ -108,6 +120,7 @@ func (s *ArangoMLExtensionSpecDeployment) Validate() error {
 
 errs := []error{
 shared.PrefixResourceErrors("service", shared.ValidateOptional(s.GetService(), func(s ArangoMLExtensionSpecDeploymentService) error { return s.Validate() })),
+s.GetPodTemplate().Validate(),
 }
 
 if s.GetReplicas() < 0 || s.GetReplicas() > 10 {

pkg/apis/ml/v1alpha1/extension_spec_deployment_component.go

@@ -30,12 +30,8 @@ type ArangoMLExtensionSpecDeploymentComponent struct {
 // Port defines on which port the container will be listening for connections
 Port *int32 `json:"port,omitempty"`
 
-// Image defines image used for the component
-*sharedApi.Image `json:",inline"`
-
-// Resources holds resource requests & limits for container
-// If not specified, default values will be used
-*sharedApi.Resources `json:",inline"`
+// ContainerTemplate Keeps the information about Container configuration
+*sharedApi.ContainerTemplate `json:",inline"`
 }
 
 func (s *ArangoMLExtensionSpecDeploymentComponent) GetPort() int32 {
@@ -45,20 +41,12 @@ func (s *ArangoMLExtensionSpecDeploymentComponent) GetPort() int32 {
 return *s.Port
 }
 
-func (s *ArangoMLExtensionSpecDeploymentComponent) GetImage() *sharedApi.Image {
-if s == nil || s.Image == nil {
-return nil
-}
-
-return s.Image
-}
-
-func (s *ArangoMLExtensionSpecDeploymentComponent) GetResources() *sharedApi.Resources {
-if s == nil || s.Resources == nil {
+func (s *ArangoMLExtensionSpecDeploymentComponent) GetContainerTemplate() *sharedApi.ContainerTemplate {
+if s == nil || s.ContainerTemplate == nil {
 return nil
 }
 
-return s.Resources
+return s.ContainerTemplate
 }
 
 func (s *ArangoMLExtensionSpecDeploymentComponent) Validate() error {
@@ -73,8 +61,7 @@ func (s *ArangoMLExtensionSpecDeploymentComponent) Validate() error {
 }
 
 err = append(err,
-shared.PrefixResourceErrors("resources", s.GetResources().Validate()),
-shared.PrefixResourceErrors("image", shared.ValidateRequired(s.GetImage(), func(obj sharedApi.Image) error { return obj.Validate() })),
+s.GetContainerTemplate().Validate(),
 )
 
 return shared.WithErrors(err...)