API Reference

k8s.cosmonic.io/v1alpha1

Packages

• k8s.cosmonic.io/v1alpha1

k8s.cosmonic.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the k8s v1alpha1 API group.

Resource Types

• Cluster
• ClusterList
• HostGroup
• HostGroupList

Cluster

Cluster is the Schema for the clusters API. This type is not used directly and may be implemented in the future.

Appears in:

• ClusterList

Field	Description	Default	Validation
apiVersion string	k8s.cosmonic.io/v1alpha1
kind string	Cluster
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ClusterSpec

ClusterList

ClusterList contains a list of Cluster.

Field	Description	Default	Validation
apiVersion string	k8s.cosmonic.io/v1alpha1
kind string	ClusterList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Cluster array

ClusterSpec

ClusterSpec defines the desired state of Cluster.

Appears in:

• Cluster

Field	Description	Default	Validation
nexus NexusSpec			Required: {}
operator OperatorSpec			Optional: {}
console ConsoleSpec			Optional: {}
observability ObservabilitySpec			Optional: {}

ConsoleSpec

Appears in:

• ClusterSpec

Field	Description	Default	Validation
disable boolean
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array

ContainerSpec

Appears in:

• ConsoleSpec
• GrafanaSpec
• HostGroupSpec
• NexusSpec
• OperatorSpec
• PrometheusSpec
• ReplicaSpec
• SurveyorSpec

Field	Description	Default	Validation
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array

GrafanaSpec

Appears in:

• ObservabilitySpec

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array

HostGroup

HostGroup is the Schema for the hostgroups API.

Appears in:

• HostGroupList

Field	Description	Default	Validation
apiVersion string	k8s.cosmonic.io/v1alpha1
kind string	HostGroup
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec HostGroupSpec

HostGroupList

HostGroupList contains a list of HostGroup.

Field	Description	Default	Validation
apiVersion string	k8s.cosmonic.io/v1alpha1
kind string	HostGroupList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items HostGroup array

HostGroupSpec

HostGroupSpec defines the desired state of HostGroup.

Appears in:

• HostGroup

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array
replicas integer			Minimum: 1 Required: {}
hostLabels object (keys:string, values:string)			Optional: {}
lattice string	NOTE(lxf): remove this or hardcode to default		Optional: {}
cluster LocalObjectReference			Required: {}

NexusSpec

Appears in:

• ClusterSpec

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array
replicas integer			Minimum: 1 Required: {}

ObservabilitySpec

Appears in:

• ClusterSpec

Field	Description	Default	Validation
disable boolean
grafana GrafanaSpec
prometheus PrometheusSpec
surveyor SurveyorSpec

OperatorSpec

Appears in:

• ClusterSpec

Field	Description	Default	Validation
disable boolean
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array

PrometheusSpec

Appears in:

• ObservabilitySpec

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array

ReplicaSpec

Appears in:

• ConsoleSpec
• GrafanaSpec
• HostGroupSpec
• NexusSpec
• OperatorSpec
• PrometheusSpec
• SurveyorSpec

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array

SurveyorSpec

Appears in:

• ObservabilitySpec

Field	Description	Default	Validation
labels object (keys:string, values:string)			Optional: {}
affinity Affinity			Optional: {}
automountServiceAccountToken boolean			Optional: {}
nodeSelector object (keys:string, values:string)			Optional: {}
tolerations Toleration array			Optional: {}
topologySpreadConstraints TopologySpreadConstraint array			Optional: {}
securityContext PodSecurityContext			Optional: {}
volumes Volume array			Optional: {}
serviceAccountName string			Optional: {}
initContainers ContainerSpec array	These are taken "as-is"
containers ContainerSpec array
image string
command string array
args string array
workingDir string
env EnvVar array
envFrom EnvFromSource array
imagePullSecrets LocalObjectReference array
imagePullPolicy PullPolicy
resources ResourceRequirements
containerSecurityContext SecurityContext
readinessProbe Probe
livenessProbe Probe
volumeMounts VolumeMount array