Skip to content

Latest commit

 

History

History
943 lines (499 loc) · 41.5 KB

File metadata and controls

943 lines (499 loc) · 41.5 KB

API Reference

Packages

core.armadaproject.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group

Resource Types

PermissionSubject

Appears in:

Field Description Default Validation
kind string
name string

Queue

Queue is the Schema for the queues API

Appears in:

Field Description Default Validation
apiVersion string core.armadaproject.io/v1alpha1
kind string Queue
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec QueueSpec
status QueueStatus

QueueList

QueueList contains a list of Queue

Field Description Default Validation
apiVersion string core.armadaproject.io/v1alpha1
kind string QueueList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Queue array

QueuePermissions

Appears in:

Field Description Default Validation
subjects PermissionSubject array
verbs string array

QueueSpec

QueueSpec defines the desired state of Queue

Appears in:

Field Description Default Validation
priorityFactor Quantity PriorityFactor is a multiplicative constant which is applied to the priority.
permissions QueuePermissions array Permissions describe who can perform what operations on queue related resources.

QueueStatus

QueueStatus defines the observed state of Queue

Appears in:

install.armadaproject.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the install v1alpha1 API group

Resource Types

AdditionalClusterRoleBinding

Appears in:

Field Description Default Validation
nameSuffix string
clusterRoleName string

ArmadaServer

ArmadaServer is the Schema for the Armada Server API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string ArmadaServer
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ArmadaServerSpec
status ArmadaServerStatus

ArmadaServerList

ArmadaServerList contains a list of ArmadaServer

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string ArmadaServerList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ArmadaServer array

ArmadaServerSpec

ArmadaServerSpec defines the desired state of ArmadaServer

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for ArmadaServer
nodeSelector object (keys:string, values:string) NodeSelector restricts the ArmadaServer pod to run on nodes matching the configured selectors
ingress IngressConfig Ingress defines configuration for the Ingress resource
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource
hostNames string array An array of host names to build ingress rules for
clusterIssuer string Who is issuing certificates for CA
pulsarInit boolean Run Pulsar Init Jobs On Startup
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with

ArmadaServerStatus

ArmadaServerStatus defines the observed state of ArmadaServer

Appears in:

Binoculars

Binoculars is the Schema for the binoculars API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string Binoculars
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec BinocularsSpec
status BinocularsStatus

BinocularsList

BinocularsList contains a list of Binoculars

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string BinocularsList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Binoculars array

BinocularsSpec

BinocularsSpec defines the desired state of Binoculars

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for Binoculars
nodeSelector object (keys:string, values:string) NodeSelector restricts the pod to run on nodes matching the configured selectors
ingress IngressConfig Ingress for this component. Used to inject labels/annotations into ingress
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource
hostNames string array An array of host names to build ingress rules for
clusterIssuer string Who is issuing certificates for CA
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with

BinocularsStatus

BinocularsStatus defines the observed state of binoculars

Appears in:

CommonSpecBase

CommonSpecBase is the common configuration for all services. NOTE(Clif): You must label this with json:"" when using it as an embedded struct in order for controller-gen to use the promoted fields as expected.

Appears in:

Field Description Default Validation
labels object (keys:string, values:string) Labels is the map of labels which wil be added to all objects
image Image Image is the configuration block for the image repository and tag
applicationConfig RawExtension ApplicationConfig is the internal configuration of the application which will be created as a Kubernetes Secret and mounted in the Kubernetes Deployment object Schemaless: {}
prometheus PrometheusConfig PrometheusConfig is the configuration block for Prometheus monitoring
resources ResourceRequirements Resources is the configuration block for setting resource requirements for this service
tolerations Toleration array Tolerations is the configuration block for specifying which taints this pod can tolerate
terminationGracePeriodSeconds integer TerminationGracePeriodSeconds specifies how many seconds should Kubernetes wait for the application to shut down gracefully before sending a KILL signal
customServiceAccount string if CustomServiceAccount is specified, then that service account is referenced in the Deployment (overrides service account defined in spec.serviceAccount field)
serviceAccount ServiceAccountConfig if ServiceAccount configuration is defined, it creates a new service account and references it in the deployment
environment EnvVar array Extra environment variables that get added to deployment
additionalVolumes Volume array Additional volumes that are mounted into deployments
additionalVolumeMounts VolumeMount array Additional volume mounts that are added as volumes

EventIngester

EventIngester is the Schema for the eventingesters API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string EventIngester
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec EventIngesterSpec
status EventIngesterStatus

EventIngesterList

EventIngesterList contains a list of EventIngester

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string EventIngesterList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items EventIngester array

EventIngesterSpec

EventIngesterSpec defines the desired state of EventIngester

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for EventIngester
nodeSelector object (keys:string, values:string) NodeSelector restricts the Executor pod to run on nodes matching the configured selectors
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource

EventIngesterStatus

EventIngesterStatus defines the observed state of EventIngester

Appears in:

Executor

Executor is the Schema for the executors API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string Executor
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ExecutorSpec
status ExecutorStatus

ExecutorList

ExecutorList contains a list of Executor

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string ExecutorList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Executor array

ExecutorSpec

ExecutorSpec defines the desired state of Executor

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for Executor
nodeSelector object (keys:string, values:string) NodeSelector restricts the Executor pod to run on nodes matching the configured selectors
additionalClusterRoleBindings AdditionalClusterRoleBinding array Additional ClusterRoleBindings which will be created
priorityClasses PriorityClass array List of PriorityClasses which will be created
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource

ExecutorStatus

ExecutorStatus defines the observed state of Executor

Appears in:

Image

Appears in:

Field Description Default Validation
repository string MinLength: 1
Pattern: ^([a-z0-9]+(?:[._-][a-z0-9]+)*/*)+$
tag string MinLength: 1
Pattern: ^[a-zA-Z0-9_.-]*$

IngressConfig

Appears in:

Field Description Default Validation
labels object (keys:string, values:string) Labels is the map of labels which wil be added to all objects
annotations object (keys:string, values:string) Annotations is a map of annotations which will be added to all ingress rules
ingressClass string The type of ingress that is used
hostNames string array An array of host names to build ingress rules for
clusterIssuer string Who is issuing certificates for CA

Lookout

Lookout is the Schema for the lookout API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string Lookout
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec LookoutSpec
status LookoutStatus

LookoutIngester

LookoutIngester is the Schema for the lookoutingesters API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string LookoutIngester
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec LookoutIngesterSpec
status LookoutIngesterStatus

LookoutIngesterList

LookoutIngesterList contains a list of LookoutIngester

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string LookoutIngesterList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items LookoutIngester array

LookoutIngesterSpec

LookoutIngesterSpec defines the desired state of LookoutIngester

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for LookoutIngester
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource

LookoutIngesterStatus

LookoutIngesterStatus defines the observed state of LookoutIngester

Appears in:

LookoutList

LookoutList contains a list of Lookout

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string LookoutList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Lookout array

LookoutSpec

LookoutSpec defines the desired state of Lookout

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for Lookout
nodeSelector object (keys:string, values:string) NodeSelector restricts the Lookout pod to run on nodes matching the configured selectors
ingress IngressConfig Ingress defines labels and annotations for the Ingress controller of Lookout
hostNames string array An array of host names to build ingress rules for
clusterIssuer string Who is issuing certificates for CA
migrate boolean Migrate toggles whether to run migrations when installed
dbPruningEnabled boolean DbPruningEnabled when true a pruning CronJob is created
dbPruningSchedule string DbPruningSchedule schedule to use for db pruning CronJob
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource

LookoutStatus

LookoutStatus defines the observed state of lookout

Appears in:

PrometheusConfig

Appears in:

Field Description Default Validation
enabled boolean Enabled toggles should PrometheusRule and ServiceMonitor be created
labels object (keys:string, values:string) Labels field enables adding additional labels to PrometheusRule and ServiceMonitor
scrapeInterval Duration ScrapeInterval defines the interval at which Prometheus should scrape metrics Format: duration
Type: string

PrunerArgs

PrunerArgs represent command-line args to the pruner cron job

Appears in:

Field Description Default Validation
timeout string
batchsize integer
expireAfter string

PrunerConfig

PrunerConfig definees the pruner cronjob settings

Appears in:

Field Description Default Validation
enabled boolean
schedule string
resources ResourceRequirements
args PrunerArgs

Scheduler

Scheduler is the Schema for the scheduler API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string Scheduler
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SchedulerSpec
status SchedulerStatus

SchedulerIngester

SchedulerIngester is the Schema for the scheduleringesters API

Appears in:

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string SchedulerIngester
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SchedulerIngesterSpec
status SchedulerIngesterStatus

SchedulerIngesterList

SchedulerIngesterList contains a list of SchedulerIngester

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string SchedulerIngesterList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items SchedulerIngester array

SchedulerIngesterSpec

SchedulerIngesterSpec defines the desired state of SchedulerIngester

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for SchedulerIngester
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource

SchedulerIngesterStatus

SchedulerIngesterStatus defines the observed state of SchedulerIngester

Appears in:

SchedulerList

SchedulerList contains a list of Scheduler

Field Description Default Validation
apiVersion string install.armadaproject.io/v1alpha1
kind string SchedulerList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Scheduler array

SchedulerSpec

SchedulerSpec defines the desired state of Scheduler

Appears in:

Field Description Default Validation
CommonSpecBase CommonSpecBase
replicas integer Replicas is the number of replicated instances for Scheduler
ingress IngressConfig Ingress defines labels and annotations for the Ingress controller of Scheduler
profilingIngressConfig IngressConfig ProfilingIngressConfig defines configuration for the profiling Ingress resource
hostNames string array An array of host names to build ingress rules for
clusterIssuer string Who is issuing certificates for CA
migrate boolean Migrate toggles whether to run migrations when installed
pruner PrunerConfig Pruning config for cron job
securityContext SecurityContext SecurityContext defines the security options the container should be run with
podSecurityContext PodSecurityContext PodSecurityContext defines the security options the pod should be run with

SchedulerStatus

SchedulerStatus defines the observed state of scheduler

Appears in:

ServiceAccountConfig

Appears in:

Field Description Default Validation
secrets ObjectReference array
imagePullSecrets LocalObjectReference array
automountServiceAccountToken boolean