Trilio Operator API Specifications

API Specification for Trilio for Kubernetes Upstream Operator

Packages:

• triliovault.trilio.io/v1

triliovault.trilio.io/v1

Package v1 contains API Schema definitions for the triliocrds v1 API group

Resource Types:

CSIConfig

(Appears on: TrilioVaultManagerSpec)

Field	Description
include []string	Include denotes the list of CSI drivers to be included in the non-snapshot functionality category
exclude []string	Exclude denotes the list of CSI drivers to be excluded from the non-snapshot functionality category

ComponentConfiguration

(Appears on: TrilioVaultManagerSpec)

Field	Description
control-plane HelmValues	ControlPlane holds all configuration for the control-plane deployment
exporter HelmValues	Exporter holds all configuration for the exporter deployment.
web HelmValues	Web holds all configuration for the web deployment
web-backend HelmValues	WebBackend holds all configuration for the web-backend deployment
event-target HelmValues	EventTarget holds all configuration for the event-target deployment
ingress-controller HelmValues	IngressController holds all configuration for the ingress-controller deployment

ConditionStatus (string alias)

(Appears on: TrilioAppCondition)

Helm

(Appears on: TrilioVaultManagerSpec)

Field	Description
version string
tillerNamespace string

HelmValues

(Appears on: ComponentConfiguration, TrilioVaultManagerSpec)

HelmValues takes any custom helm value user wants to provide to TVK helm chart

Field	Description
- map[string]interface{}	Data holds the configuration keys and values. Work around for https://github.com/kubernetes-sigs/kubebuilder/issues/528

IngressConfig

(Appears on: TrilioVaultManagerSpec)

Field	Description
ingressClass string
annotations map[string]string
host string
tlsSecretName string

LevelType (string alias)

(Appears on: TrilioVaultManagerSpec)

ResourceScope (string alias)

(Appears on: TrilioVaultManagerSpec)

ResourceType (string alias)

TrilioAppCondition

(Appears on: TrilioVaultManagerStatus)

Field	Description
type TrilioAppConditionType
status ConditionStatus
reason TrilioAppConditionReason
message string
lastTransitionTime Kubernetes meta/v1.Time

TrilioAppConditionReason (string alias)

(Appears on: TrilioAppCondition)

TrilioAppConditionType (string alias)

(Appears on: TrilioAppCondition, TrilioVaultManagerStatus)

TrilioAppRelease

(Appears on: TrilioVaultManagerStatus)

Field	Description
name string
manifest string

TrilioVaultManager

TrilioVaultManager is the Schema for the triliovaultmanagers API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TrilioVaultManagerSpec	trilioVaultAppVersion string Deprecated: TrilioVaultAppVersion Helm Chart version helmVersion Helm Deprecated: Helm Version applicationScope ResourceScope Scope for the application which will be installed in the cluster NamespaceScope or ClusterScope restoreNamespaces []string Deprecated: RestoreNamespaces are the namespace where you want to restore your applications. Restore Namespaces depends on your k8s RBAC resources Kubernetes core/v1.ResourceRequirements Deprecated: Resources are the resource requirements for the containers. deploymentLimits Kubernetes core/v1.ResourceList Deprecated: DeploymentLimits are the resource limits for all the deployments. metadataJobLimits Kubernetes core/v1.ResourceList Deprecated: MetadataJobLimits are the resource limits for all the meta processing jobs. dataJobLimits Kubernetes core/v1.ResourceList Deprecated: DataJobLimits are the resource limits for all the data processing jobs. metadataJobResources Kubernetes core/v1.ResourceRequirements MetadataJobResources is the resource limits & requests for all the meta processing jobs. dataJobResources Kubernetes core/v1.ResourceRequirements DataJobResources is the resource limits & requests for all the data processing jobs. targetBrowserResources Kubernetes core/v1.ResourceRequirements TargetBrowserResources is the resource limits & requests for the target browser. nodeSelector map[string]string NodeSelector specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels. affinity Kubernetes core/v1.Affinity The scheduling constraints on application pods. tolerations []Kubernetes core/v1.Toleration The toleration of application against the specific taints on the nodes workerJobsSchedulingConfig WorkloadSchedulingConfigs WorkerJobsSchedulingConfig holds the scheduling constraints for tvk jobs and data-mover pods. helmValues HelmValues HelmValues holds all the additional fields in the values.yaml of TVK helm chart. componentConfiguration ComponentConfiguration ComponentConfiguration holds all the field related to the TVK deployments. ingressConfig IngressConfig IngressConfig holds field related to ingress resource to access the TVK UI. tvkInstanceName string TVKInstanceName is a TVK installation name to be displayed on UI. logLevel LevelType LogLevel is a level used in TVK logging. datamoverLogLevel LevelType DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the TVK. csiConfig CSIConfig CSIConfig is the configuration for the CSI drivers which doesn’t support snapshot functionality pauseSchedule bool PauseSchedule is flag to pause schedule backups or snapshot for all the backupplan/clusterbackupplan.
trilioVaultAppVersion string	Deprecated: TrilioVaultAppVersion Helm Chart version
helmVersion Helm	Deprecated: Helm Version
applicationScope ResourceScope	Scope for the application which will be installed in the cluster NamespaceScope or ClusterScope
restoreNamespaces []string	Deprecated: RestoreNamespaces are the namespace where you want to restore your applications. Restore Namespaces depends on your k8s RBAC
resources Kubernetes core/v1.ResourceRequirements	Deprecated: Resources are the resource requirements for the containers.
deploymentLimits Kubernetes core/v1.ResourceList	Deprecated: DeploymentLimits are the resource limits for all the deployments.
metadataJobLimits Kubernetes core/v1.ResourceList	Deprecated: MetadataJobLimits are the resource limits for all the meta processing jobs.
dataJobLimits Kubernetes core/v1.ResourceList	Deprecated: DataJobLimits are the resource limits for all the data processing jobs.
metadataJobResources Kubernetes core/v1.ResourceRequirements	MetadataJobResources is the resource limits & requests for all the meta processing jobs.
dataJobResources Kubernetes core/v1.ResourceRequirements	DataJobResources is the resource limits & requests for all the data processing jobs.
targetBrowserResources Kubernetes core/v1.ResourceRequirements	TargetBrowserResources is the resource limits & requests for the target browser.
nodeSelector map[string]string	NodeSelector specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels.
affinity Kubernetes core/v1.Affinity	The scheduling constraints on application pods.
tolerations []Kubernetes core/v1.Toleration	The toleration of application against the specific taints on the nodes
workerJobsSchedulingConfig WorkloadSchedulingConfigs	WorkerJobsSchedulingConfig holds the scheduling constraints for tvk jobs and data-mover pods.
helmValues HelmValues	HelmValues holds all the additional fields in the values.yaml of TVK helm chart.
componentConfiguration ComponentConfiguration	ComponentConfiguration holds all the field related to the TVK deployments.
ingressConfig IngressConfig	IngressConfig holds field related to ingress resource to access the TVK UI.
tvkInstanceName string	TVKInstanceName is a TVK installation name to be displayed on UI.
logLevel LevelType	LogLevel is a level used in TVK logging.
datamoverLogLevel LevelType	DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the TVK.
csiConfig CSIConfig	CSIConfig is the configuration for the CSI drivers which doesn’t support snapshot functionality
pauseSchedule bool	PauseSchedule is flag to pause schedule backups or snapshot for all the backupplan/clusterbackupplan.
status TrilioVaultManagerStatus

TrilioVaultManagerSpec

(Appears on: TrilioVaultManager)

TrilioVaultManagerSpec defines the desired state of TrilioVaultManager

Field	Description
trilioVaultAppVersion string	Deprecated: TrilioVaultAppVersion Helm Chart version
helmVersion Helm	Deprecated: Helm Version
applicationScope ResourceScope	Scope for the application which will be installed in the cluster NamespaceScope or ClusterScope
restoreNamespaces []string	Deprecated: RestoreNamespaces are the namespace where you want to restore your applications. Restore Namespaces depends on your k8s RBAC
resources Kubernetes core/v1.ResourceRequirements	Deprecated: Resources are the resource requirements for the containers.
deploymentLimits Kubernetes core/v1.ResourceList	Deprecated: DeploymentLimits are the resource limits for all the deployments.
metadataJobLimits Kubernetes core/v1.ResourceList	Deprecated: MetadataJobLimits are the resource limits for all the meta processing jobs.
dataJobLimits Kubernetes core/v1.ResourceList	Deprecated: DataJobLimits are the resource limits for all the data processing jobs.
metadataJobResources Kubernetes core/v1.ResourceRequirements	MetadataJobResources is the resource limits & requests for all the meta processing jobs.
dataJobResources Kubernetes core/v1.ResourceRequirements	DataJobResources is the resource limits & requests for all the data processing jobs.
targetBrowserResources Kubernetes core/v1.ResourceRequirements	TargetBrowserResources is the resource limits & requests for the target browser.
nodeSelector map[string]string	NodeSelector specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels.
affinity Kubernetes core/v1.Affinity	The scheduling constraints on application pods.
tolerations []Kubernetes core/v1.Toleration	The toleration of application against the specific taints on the nodes
workerJobsSchedulingConfig WorkloadSchedulingConfigs	WorkerJobsSchedulingConfig holds the scheduling constraints for tvk jobs and data-mover pods.
helmValues HelmValues	HelmValues holds all the additional fields in the values.yaml of TVK helm chart.
componentConfiguration ComponentConfiguration	ComponentConfiguration holds all the field related to the TVK deployments.
ingressConfig IngressConfig	IngressConfig holds field related to ingress resource to access the TVK UI.
tvkInstanceName string	TVKInstanceName is a TVK installation name to be displayed on UI.
logLevel LevelType	LogLevel is a level used in TVK logging.
datamoverLogLevel LevelType	DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the TVK.
csiConfig CSIConfig	CSIConfig is the configuration for the CSI drivers which doesn’t support snapshot functionality
pauseSchedule bool	PauseSchedule is flag to pause schedule backups or snapshot for all the backupplan/clusterbackupplan.

TrilioVaultManagerStatus

(Appears on: TrilioVaultManager)

TrilioVaultManagerStatus defines the observed state of TrilioVaultManager

Field	Description
conditions []TrilioAppCondition
deployedRelease TrilioAppRelease
releaseVersion string
helmRevision int
status TrilioAppConditionType
dashboard string

WorkloadSchedulingConfigs

(Appears on: TrilioVaultManagerSpec)

WorkloadSchedulingConfigs holds the scheduling constraints on tvk jobs and data-mover pods.

Field	Description
affinity Kubernetes core/v1.Affinity	Affinity specifies the affinity/anti-affinity settings for the pod.
nodeSelector map[string]string	NodeSelector specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels.
tolerations []Kubernetes core/v1.Toleration	Tolerations specifies the tolerations of the pod against the specific taints on the nodes.

---

Generated with gen-crd-api-reference-docs on git commit b8cbeb3b.