Skip to content

Latest commit

 

History

History
1565 lines (830 loc) · 48.7 KB

ArangoMLExtension.V1Alpha1.md

File metadata and controls

1565 lines (830 loc) · 48.7 KB
layout parent title
page
CRD reference
ArangoMLExtension V1Alpha1

API Reference for ArangoMLExtension V1Alpha1

Spec

.spec.deployment.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.deployment.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.deployment.hostNetwork

Type: boolean [ref]

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 [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.deployment.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.deployment.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.deployment.prediction.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.deployment.prediction.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.deployment.prediction.gpu

Type: boolean [ref]

GPU defined if GPU Jobs are enabled for component. In use only for ArangoMLExtensionSpecDeploymentComponentPrediction and ArangoMLExtensionSpecDeploymentComponentTraining

Default Value: false


.spec.deployment.prediction.image

Type: string [ref]

Image define image details


.spec.deployment.prediction.port

Type: integer [ref]

Port defines on which port the container will be listening for connections


.spec.deployment.prediction.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.deployment.prediction.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.deployment.prediction.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.deployment.prediction.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.deployment.project.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.deployment.project.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.deployment.project.gpu

Type: boolean [ref]

GPU defined if GPU Jobs are enabled for component. In use only for ArangoMLExtensionSpecDeploymentComponentPrediction and ArangoMLExtensionSpecDeploymentComponentTraining

Default Value: false


.spec.deployment.project.image

Type: string [ref]

Image define image details


.spec.deployment.project.port

Type: integer [ref]

Port defines on which port the container will be listening for connections


.spec.deployment.project.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.deployment.project.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.deployment.project.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.deployment.project.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.deployment.replicas

Type: integer [ref]

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 [ref]

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 [ref]

Type determines how the Service is exposed

Links:

Possible Values:

  • "ClusterIP" (default) - service will only be accessible inside the cluster, via the cluster IP
  • "NodePort" - service will be exposed on one port of every node, in addition to 'ClusterIP' type
  • "LoadBalancer" - service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type
  • "ExternalName" - service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved

.spec.deployment.shareProcessNamespace

Type: boolean [ref]

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 [ref]

Tolerations defines tolerations

Links:


.spec.deployment.training.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.deployment.training.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.deployment.training.gpu

Type: boolean [ref]

GPU defined if GPU Jobs are enabled for component. In use only for ArangoMLExtensionSpecDeploymentComponentPrediction and ArangoMLExtensionSpecDeploymentComponentTraining

Default Value: false


.spec.deployment.training.image

Type: string [ref]

Image define image details


.spec.deployment.training.port

Type: integer [ref]

Port defines on which port the container will be listening for connections


.spec.deployment.training.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.deployment.training.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.deployment.training.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.deployment.training.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.image

Type: string [ref]

Image define image details


.spec.init.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.init.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.init.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.init.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.init.hostNetwork

Type: boolean [ref]

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.init.hostPID

Type: boolean [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.init.image

Type: string [ref]

Image define image details


.spec.init.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.init.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.init.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.init.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.init.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.init.schedulerName

Type: string [ref]

SchedulerName specifies, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Default Value: ""


.spec.init.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.init.shareProcessNamespace

Type: boolean [ref]

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.init.tolerations

Type: []core.Toleration [ref]

Tolerations defines tolerations

Links:


.spec.jobsTemplates.prediction.cpu.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.jobsTemplates.prediction.cpu.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.jobsTemplates.prediction.cpu.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.jobsTemplates.prediction.cpu.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.jobsTemplates.prediction.cpu.hostNetwork

Type: boolean [ref]

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.jobsTemplates.prediction.cpu.hostPID

Type: boolean [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.jobsTemplates.prediction.cpu.image

Type: string [ref]

Image define image details


.spec.jobsTemplates.prediction.cpu.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.jobsTemplates.prediction.cpu.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.prediction.cpu.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.jobsTemplates.prediction.cpu.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.jobsTemplates.prediction.cpu.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.jobsTemplates.prediction.cpu.schedulerName

Type: string [ref]

SchedulerName specifies, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Default Value: ""


.spec.jobsTemplates.prediction.cpu.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.prediction.cpu.shareProcessNamespace

Type: boolean [ref]

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.jobsTemplates.prediction.cpu.tolerations

Type: []core.Toleration [ref]

Tolerations defines tolerations

Links:


.spec.jobsTemplates.prediction.gpu.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.jobsTemplates.prediction.gpu.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.jobsTemplates.prediction.gpu.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.jobsTemplates.prediction.gpu.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.jobsTemplates.prediction.gpu.hostNetwork

Type: boolean [ref]

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.jobsTemplates.prediction.gpu.hostPID

Type: boolean [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.jobsTemplates.prediction.gpu.image

Type: string [ref]

Image define image details


.spec.jobsTemplates.prediction.gpu.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.jobsTemplates.prediction.gpu.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.prediction.gpu.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.jobsTemplates.prediction.gpu.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.jobsTemplates.prediction.gpu.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.jobsTemplates.prediction.gpu.schedulerName

Type: string [ref]

SchedulerName specifies, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Default Value: ""


.spec.jobsTemplates.prediction.gpu.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.prediction.gpu.shareProcessNamespace

Type: boolean [ref]

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.jobsTemplates.prediction.gpu.tolerations

Type: []core.Toleration [ref]

Tolerations defines tolerations

Links:


.spec.jobsTemplates.training.cpu.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.jobsTemplates.training.cpu.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.jobsTemplates.training.cpu.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.jobsTemplates.training.cpu.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.jobsTemplates.training.cpu.hostNetwork

Type: boolean [ref]

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.jobsTemplates.training.cpu.hostPID

Type: boolean [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.jobsTemplates.training.cpu.image

Type: string [ref]

Image define image details


.spec.jobsTemplates.training.cpu.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.jobsTemplates.training.cpu.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.training.cpu.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.jobsTemplates.training.cpu.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.jobsTemplates.training.cpu.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.jobsTemplates.training.cpu.schedulerName

Type: string [ref]

SchedulerName specifies, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Default Value: ""


.spec.jobsTemplates.training.cpu.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.training.cpu.shareProcessNamespace

Type: boolean [ref]

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.jobsTemplates.training.cpu.tolerations

Type: []core.Toleration [ref]

Tolerations defines tolerations

Links:


.spec.jobsTemplates.training.gpu.affinity

Type: core.Affinity [ref]

Affinity defines scheduling constraints for workload

Links:


.spec.jobsTemplates.training.gpu.env

Type: core.EnvVar [ref]

Env keeps the information about environment variables provided to the container

Links:


.spec.jobsTemplates.training.gpu.envFrom

Type: core.EnvFromSource [ref]

EnvFrom keeps the information about environment variable sources provided to the container

Links:


.spec.jobsTemplates.training.gpu.hostIPC

Type: boolean [ref]

HostIPC defines to use the host's ipc namespace.

Default Value: false


.spec.jobsTemplates.training.gpu.hostNetwork

Type: boolean [ref]

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.jobsTemplates.training.gpu.hostPID

Type: boolean [ref]

HostPID define to use the host's pid namespace.

Default Value: false


.spec.jobsTemplates.training.gpu.image

Type: string [ref]

Image define image details


.spec.jobsTemplates.training.gpu.nodeSelector

Type: object [ref]

NodeSelector is a selector that must be true for the workload to fit on a node.

Links:


.spec.jobsTemplates.training.gpu.podSecurityContext

Type: core.PodSecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.training.gpu.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.jobsTemplates.training.gpu.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.jobsTemplates.training.gpu.resources

Type: core.ResourceRequirements [ref]

Resources holds resource requests & limits for container

Links:


.spec.jobsTemplates.training.gpu.schedulerName

Type: string [ref]

SchedulerName specifies, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

Default Value: ""


.spec.jobsTemplates.training.gpu.securityContext

Type: core.SecurityContext [ref]

PodSecurityContext holds pod-level security attributes and common container settings.

Links:


.spec.jobsTemplates.training.gpu.shareProcessNamespace

Type: boolean [ref]

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.jobsTemplates.training.gpu.tolerations

Type: []core.Toleration [ref]

Tolerations defines tolerations

Links:


.spec.metadataService.local.arangoMLFeatureStore

Type: string [ref]

ArangoMLFeatureStoreDatabase define Database name to be used as MetadataService Backend in ArangoMLFeatureStoreDatabase

Default Value: arangomlfeaturestore


.spec.metadataService.local.arangoPipeDatabase

Type: string [ref]

ArangoPipeDatabase define Database name to be used as MetadataService Backend in ArangoPipe

Default Value: arangopipe


.spec.pullPolicy

Type: string [ref]

PullPolicy define Image pull policy

Default Value: IfNotPresent


.spec.pullSecrets

Type: array [ref]

PullSecrets define Secrets used to pull Image from registry


.spec.storage.name

Type: string [ref]

Name of the object


.spec.storage.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.spec.storage.uid

Type: string [ref]

UID keeps the information about object UID

Status

.status.arangoDB.jwtTokenSecret.name

Type: string [ref]

Name of the object


.status.arangoDB.jwtTokenSecret.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.arangoDB.jwtTokenSecret.uid

Type: string [ref]

UID keeps the information about object UID


.status.arangoDB.secret.name

Type: string [ref]

Name of the object


.status.arangoDB.secret.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.arangoDB.secret.uid

Type: string [ref]

UID keeps the information about object UID


.status.conditions

Type: api.Conditions [ref]

Conditions specific to the entire extension


.status.metadataService.jwtTokenSecret.name

Type: string [ref]

Name of the object


.status.metadataService.jwtTokenSecret.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.metadataService.jwtTokenSecret.uid

Type: string [ref]

UID keeps the information about object UID


.status.metadataService.local.arangoMLFeatureStore

Type: string [ref]

ArangoMLFeatureStoreDatabase define Database name to be used as MetadataService Backend


.status.metadataService.local.arangoPipe

Type: string [ref]

ArangoPipeDatabase define Database name to be used as MetadataService Backend


.status.metadataService.secret.name

Type: string [ref]

Name of the object


.status.metadataService.secret.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.metadataService.secret.uid

Type: string [ref]

UID keeps the information about object UID


.status.reconciliation.serviceChecksum

Type: string [ref]


.status.reconciliation.statefulSetChecksum

Type: string [ref]


.status.serviceAccount.cluster.binding.name

Type: string [ref]

Name of the object


.status.serviceAccount.cluster.binding.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.serviceAccount.cluster.binding.uid

Type: string [ref]

UID keeps the information about object UID


.status.serviceAccount.cluster.role.name

Type: string [ref]

Name of the object


.status.serviceAccount.cluster.role.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.serviceAccount.cluster.role.uid

Type: string [ref]

UID keeps the information about object UID


.status.serviceAccount.name

Type: string [ref]

Name of the object


.status.serviceAccount.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.serviceAccount.namespaced.binding.name

Type: string [ref]

Name of the object


.status.serviceAccount.namespaced.binding.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.serviceAccount.namespaced.binding.uid

Type: string [ref]

UID keeps the information about object UID


.status.serviceAccount.namespaced.role.name

Type: string [ref]

Name of the object


.status.serviceAccount.namespaced.role.namespace

Type: string [ref]

Namespace of the object. Should default to the namespace of the parent object


.status.serviceAccount.namespaced.role.uid

Type: string [ref]

UID keeps the information about object UID


.status.serviceAccount.uid

Type: string [ref]

UID keeps the information about object UID