Trilio Operator API Specifications

API Specification for Trilio for Kubernetes Upstream Operator

Packages:

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)

Helm configuration for managing Helm chart deployments. This is deprecated and should not be used in new installations.

Field
Description

version string

Version specifies the Helm version to use for chart deployments

tillerNamespace string

TillerNamespace specifies the namespace where Helm Tiller is deployed (for Helm v2)

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)

IngressConfig holds configuration for the Kubernetes Ingress resource used to access the TrilioVault Management Console UI.

Field
Description

ingressClass string

IngressClass specifies the ingress class to use for the ingress resource

annotations map[string]string

Annotations specifies custom annotations to apply to the ingress resource

host string

Host specifies the hostname for the ingress resource

tlsSecretName string

TLSSecretName specifies the name of the Kubernetes secret containing TLS certificates

LevelType (string alias)

(Appears on: TrilioVaultManagerSpec)

ResourceScope (string alias)

(Appears on: TrilioVaultManagerSpec)

ResourceType (string alias)

TrilioAppCondition

(Appears on: TrilioVaultManagerStatus)

TrilioAppCondition represents the current state of a TrilioVaultManager resource condition. Conditions provide detailed status information about the installation, deployment, and health of the TrilioVault application.

Field
Description

type TrilioAppConditionType

Type specifies the type of condition (e.g., Ready, Deployed, Error)

status ConditionStatus

Status indicates whether the condition is True, False, or Unknown

reason TrilioAppConditionReason

Reason provides a brief, machine-readable reason for the condition's current status

message string

Message provides a human-readable description of the condition's current status

lastTransitionTime Kubernetes meta/v1.Time

LastTransitionTime indicates the last time the condition transitioned from one status to another

TrilioAppConditionReason (string alias)

(Appears on: TrilioAppCondition)

TrilioAppConditionType (string alias)

(Appears on: TrilioAppCondition, TrilioVaultManagerStatus)

TrilioAppRelease

(Appears on: TrilioVaultManagerStatus)

TrilioAppRelease contains information about the deployed Helm release for the TrilioVault application.

Field
Description

name string

Name specifies the name of the Helm release deployed for TrilioVault

manifest string

Manifest contains the YAML manifest of the deployed Helm release

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

Spec defines the desired state of TrilioVaultManager. See TrilioVaultManagerSpec for details.

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. It provides information about the current deployment status, conditions, and release information for the TrilioVault installation.

Field
Description

conditions []TrilioAppCondition

Conditions represents the current state of various aspects of the TrilioVault installation

deployedRelease TrilioAppRelease

DeployedRelease contains information about the currently deployed Helm release

releaseVersion string

ReleaseVersion specifies the version of the deployed TrilioVault release

helmRevision int

HelmRevision indicates the revision number of the Helm release

status TrilioAppConditionType

Status represents the overall status of the TrilioVaultManager resource

dashboard string

Dashboard provides the URL or endpoint to access the TrilioVault Management Console UI

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.

PreviousResource QuotasNextCustom Resource Definition - Application

Last updated

Was this helpful?