27 KiB
| layout | parent | title |
|---|---|---|
| page | CRD reference | GraphAnalyticsEngine V1Alpha1 |
API Reference for GraphAnalyticsEngine V1Alpha1
Spec
.spec.deployment.affinity
Type: core.Affinity [ref]
Affinity defines scheduling constraints for workload
Links:
.spec.deployment.annotations
Type: object [ref]
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
Links:
.spec.deployment.args
Type: array [ref]
Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
Links:
.spec.deployment.automountServiceAccountToken
Type: boolean [ref]
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
.spec.deployment.command
Type: array [ref]
Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
Links:
.spec.deployment.env
Type: core.EnvVar [ref]
Env keeps the information about environment variables provided to the container
Links:
.spec.deployment.envFrom
Type: core.EnvFromSource [ref]
EnvFrom keeps the information about environment variable sources provided to the container
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.image
Type: string [ref]
Image define image details
.spec.deployment.imagePullPolicy
Type: string [ref]
ImagePullPolicy define Image pull policy
Default Value: IfNotPresent
.spec.deployment.imagePullSecrets
Type: array [ref]
ImagePullSecrets define Secrets used to pull Image from registry
.spec.deployment.labels
Type: object [ref]
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.
Links:
.spec.deployment.lifecycle
Type: core.Lifecycle [ref]
Lifecycle keeps actions that the management system should take in response to container lifecycle events.
.spec.deployment.livenessProbe
Type: core.Probe [ref]
LivenessProbe keeps configuration of periodic probe of container liveness. Container will be restarted if the probe fails.
Links:
.spec.deployment.method
Type: string [ref]
Method defines the merge method
Possible Values:
"override"(default) - Overrides values during configuration merge"append"- Appends, if possible, values during configuration merge
.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.ownerReferences
Type: meta.OwnerReference [ref]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
.spec.deployment.podSecurityContext
Type: core.PodSecurityContext [ref]
PodSecurityContext holds pod-level security attributes and common container settings.
Links:
.spec.deployment.port
Type: integer [ref]
Port defines on which port the container will be listening for connections
.spec.deployment.ports
Type: []core.ContainerPort [ref]
Ports contains list of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network.
.spec.deployment.readinessProbe
Type: core.Probe [ref]
ReadinessProbe keeps configuration of periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails.
Links:
.spec.deployment.resources
Type: core.ResourceRequirements [ref]
Resources holds resource requests & limits for container
Links:
.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.securityContext
Type: core.SecurityContext [ref]
SecurityContext holds container-level security attributes and common container settings.
Links:
.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"None"- service is not created
.spec.deployment.serviceAccountName
Type: string [ref]
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
Links:
.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.startupProbe
Type: core.Probe [ref]
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation.
Links:
.spec.deployment.tls.altNames
Type: array [ref]
AltNames define TLS AltNames used when TLS on the ArangoDB is enabled
.spec.deployment.tls.enabled
Type: boolean [ref]
Enabled define if TLS Should be enabled. If is not set then default is taken from ArangoDeployment settings
.spec.deployment.tolerations
Type: []core.Toleration [ref]
Tolerations defines tolerations
Links:
.spec.deployment.volumeMounts
Type: []core.VolumeMount [ref]
VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
.spec.deployment.volumes
Type: []core.Volume [ref]
Volumes keeps list of volumes that can be mounted by containers belonging to the pod.
Links:
.spec.deployment.workingDir
Type: string [ref]
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
.spec.deploymentName
Type: string [ref]
DeploymentName define deployment name used in the object. Immutable
.spec.integrationSidecar.args
Type: array [ref]
Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
Links:
.spec.integrationSidecar.command
Type: array [ref]
Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
Links:
.spec.integrationSidecar.controllerListenPort
Type: integer [ref]
ControllerListenPort defines on which port the sidecar container will be listening for controller requests
Default Value: 9202
.spec.integrationSidecar.env
Type: core.EnvVar [ref]
Env keeps the information about environment variables provided to the container
Links:
.spec.integrationSidecar.envFrom
Type: core.EnvFromSource [ref]
EnvFrom keeps the information about environment variable sources provided to the container
Links:
.spec.integrationSidecar.image
Type: string [ref]
Image define image details
.spec.integrationSidecar.imagePullPolicy
Type: string [ref]
ImagePullPolicy define Image pull policy
Default Value: IfNotPresent
.spec.integrationSidecar.lifecycle
Type: core.Lifecycle [ref]
Lifecycle keeps actions that the management system should take in response to container lifecycle events.
.spec.integrationSidecar.listenPort
Type: integer [ref]
ListenPort defines on which port the sidecar container will be listening for connections
Default Value: 9201
.spec.integrationSidecar.livenessProbe
Type: core.Probe [ref]
LivenessProbe keeps configuration of periodic probe of container liveness. Container will be restarted if the probe fails.
Links:
.spec.integrationSidecar.method
Type: string [ref]
Method defines the merge method
Possible Values:
"override"(default) - Overrides values during configuration merge"append"- Appends, if possible, values during configuration merge
.spec.integrationSidecar.ports
Type: []core.ContainerPort [ref]
Ports contains list of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network.
.spec.integrationSidecar.readinessProbe
Type: core.Probe [ref]
ReadinessProbe keeps configuration of periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails.
Links:
.spec.integrationSidecar.resources
Type: core.ResourceRequirements [ref]
Resources holds resource requests & limits for container
Links:
.spec.integrationSidecar.securityContext
Type: core.SecurityContext [ref]
SecurityContext holds container-level security attributes and common container settings.
Links:
.spec.integrationSidecar.startupProbe
Type: core.Probe [ref]
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation.
Links:
.spec.integrationSidecar.volumeMounts
Type: []core.VolumeMount [ref]
VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
.spec.integrationSidecar.workingDir
Type: string [ref]
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
Status
.status.arangoDB.deployment.checksum
Type: string [ref]
UID keeps the information about object Checksum
.status.arangoDB.deployment.name
Type: string [ref]
Name of the object
.status.arangoDB.deployment.namespace
Type: string [ref]
Namespace of the object. Should default to the namespace of the parent object
.status.arangoDB.deployment.uid
Type: string [ref]
UID keeps the information about object UID
.status.arangoDB.secret.checksum
Type: string [ref]
UID keeps the information about object Checksum
.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.arangoDB.tls.checksum
Type: string [ref]
UID keeps the information about object Checksum
.status.arangoDB.tls.name
Type: string [ref]
Name of the object
.status.arangoDB.tls.namespace
Type: string [ref]
Namespace of the object. Should default to the namespace of the parent object
.status.arangoDB.tls.uid
Type: string [ref]
UID keeps the information about object UID
.status.conditions
Type: api.Conditions [ref]
Conditions specific to the entire extension
.status.reconciliation.service.checksum
Type: string [ref]
UID keeps the information about object Checksum
.status.reconciliation.service.name
Type: string [ref]
Name of the object
.status.reconciliation.service.namespace
Type: string [ref]
Namespace of the object. Should default to the namespace of the parent object
.status.reconciliation.service.uid
Type: string [ref]
UID keeps the information about object UID
.status.reconciliation.statefulSet.checksum
Type: string [ref]
UID keeps the information about object Checksum
.status.reconciliation.statefulSet.name
Type: string [ref]
Name of the object
.status.reconciliation.statefulSet.namespace
Type: string [ref]
Namespace of the object. Should default to the namespace of the parent object
.status.reconciliation.statefulSet.uid
Type: string [ref]
UID keeps the information about object UID