Trilio Operator API Specifications

API Specification for Trilio for Kubernetes Upstream Operator

Packages

Custom Resource Definition Resources

The main CRDs provided by TrilioVault Manager for Kubernetes.

TrilioVaultManager

TrilioVaultManager is the Schema for the triliovaultmanagers API

Field
Description
Default
Validation

apiVersion string

triliovault.trilio.io/v1

kind string

TrilioVaultManager

Supporting Resources

Supporting types and specifications used by the main CRDs.

CSIConfig

Appears in:

Field
Description
Default
Validation

include string array

Include denotes the list of CSI drivers to be included in the non-snapshot functionality category

optional

exclude string array

Exclude denotes the list of CSI drivers to be excluded from the non-snapshot functionality category

optional

ComponentConfiguration

Appears in:

Field
Description
Default
Validation

ControlPlane holds all configuration for the control-plane deployment

optionalXPreserveUnknownFields: {}

Exporter holds all configuration for the exporter deployment.

optionalXPreserveUnknownFields: {}

Web holds all configuration for the web deployment

optionalXPreserveUnknownFields: {}

WebBackend holds all configuration for the web-backend deployment

optionalXPreserveUnknownFields: {}

EventTarget holds all configuration for the event-target deployment

optionalXPreserveUnknownFields: {}

ingress-controller HelmValuesarrow-up-right

IngressController holds all configuration for the ingress-controller deployment

optionalXPreserveUnknownFields: {}

ConditionStatus

Underlying type: string

Appears in:

Field
Description

True

False

Unknown

Helm

Appears in:

Field
Description
Default
Validation

version string

Enum: [v3]

tillerNamespace string

optional

HelmValues

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

Validation:

  • XPreserveUnknownFields: {}

Appears in:

IngressConfig

Appears in:

Field
Description
Default
Validation

ingressClass string

optional

annotations object (keys:string, values:string)

optional

host string

optional

tlsSecretName string

optional

LevelType

Underlying type: string

Appears in:

LogConfig

Appears in:

Field
Description
Default
Validation

Enum: [Panic Fatal Error Warn Info Debug Trace] optional

datamoverLogLevel LevelTypearrow-up-right

Enum: [Panic Fatal Error Warn Info Debug Trace] optional

enableDualOutputLog boolean

EnableDualOutputLog is a flag to enable dual output log.

optional

maxLogFileSizeMB integer

MaxLogFileSizeMB is the maximum size of each log file in MB Valid range: 1-10 (inclusive)

optional

maxLogFiles integer

MaxLogFiles is the maximum number of log files to retain. Valid range: 1-10 (inclusive)

optional

bufferSize integer

BufferSize is the size of the log buffer. Valid range: 2000-50000 (inclusive)

optional

flushDurationMilliSeconds integer

FlushDurationMilliSeconds is the duration to flush the log buffer in millisecond Valid range: 100-5000 (inclusive)

optional

Resource Types

ResourceScope

Underlying type: string

Appears in:

Field
Description

Cluster

Namespaced

TrilioAppCondition

Appears in:

Field
Description
Default
Validation

Enum: [Initialized Deployed Updated ReleaseFailed Irreconcilable]

Enum: [True False Unknown]

Enum: [InstallSuccessful UpdateSuccessful UninstallSuccessful InstallError UpdateError ReconcileError UninstallError]

message string

MinLength: 0

lastTransitionTime Timearrow-up-right

optional

TrilioAppConditionReason

Underlying type: string

Appears in:

Field
Description

InstallSuccessful

UpdateSuccessful

UninstallSuccessful

InstallError

UpdateError

ReconcileError

UninstallError

TrilioAppConditionType

Underlying type: string

Appears in:

Field
Description

Initialized

Deployed

Updated

ReleaseFailed

Irreconcilable

TrilioAppRelease

Appears in:

Field
Description
Default
Validation

name string

manifest string

TrilioVaultManagerSpec

TrilioVaultManagerSpec defines the desired state of TrilioVaultManager

Appears in:

Field
Description
Default
Validation

trilioVaultAppVersion string

Deprecated: TrilioVaultAppVersion Helm Chart version

optional

helmVersion Helmarrow-up-right

Deprecated: Helm Version

optional

Scope for the application which will be installed in the cluster NamespaceScope or ClusterScope

Enum: [Cluster Namespaced]

restoreNamespaces string array

Deprecated: RestoreNamespaces are the namespace where you want to restore your applications. Restore Namespaces depends on your k8s RBAC

optional

Deprecated: Resources are the resource requirements for the containers.

optional

MetadataJobResources is the resource limits & requests for all the meta processing jobs.

optional

DataJobResources is the resource limits & requests for all the data processing jobs.

optional

targetBrowserResources ResourceRequirementsarrow-up-right

TargetBrowserResources is the resource limits & requests for the target browser.

optional

nodeSelector object (keys:string, values: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.

optional

The scheduling constraints on application pods.

optional

tolerations Tolerationarrow-up-right array

The toleration of application against the specific taints on the nodes

optional

workerJobsSchedulingConfig WorkloadSchedulingConfigsarrow-up-right

WorkerJobsSchedulingConfig holds the scheduling constraints for tvk jobs and data-mover pods.

optional

HelmValues holds all the additional fields in the values.yaml of TVK helm chart.

optionalXPreserveUnknownFields: {}

ComponentConfiguration holds all the field related to the TVK deployments.

optional

IngressConfig holds field related to ingress resource to access the TVK UI.

optional

tvkInstanceName string

TVKInstanceName is a TVK installation name to be displayed on UI.

optional

LogConfig is a configuration for the TVK logging.

optional

Deprecated: LogLevel is a level used in TVK logging now used under logConfig LogLevel is a level used in TVK logging.

Enum: [Panic Fatal Error Warn Info Debug Trace]

datamoverLogLevel LevelTypearrow-up-right

Deprecated: DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the TVK now used under logConfig DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the TVK.

Enum: [Panic Fatal Error Warn Info Debug Trace]

CSIConfig is the configuration for the CSI drivers which doesn't support snapshot functionality

optional

pauseSchedule boolean

PauseSchedule is flag to pause schedule backups or snapshot for all the backupplan/clusterbackupplan.

optional

TrilioVaultManagerStatus

TrilioVaultManagerStatus defines the observed state of TrilioVaultManager

Appears in:

Field
Description
Default
Validation

optional

releaseVersion string

helmRevision integer

dashboard string

WorkloadSchedulingConfigs

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

Appears in:

Field
Description
Default
Validation

Affinity specifies the affinity/anti-affinity settings for the pod.

optional

nodeSelector object (keys:string, values: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.

optional

tolerations Tolerationarrow-up-right array

Tolerations specifies the tolerations of the pod against the specific taints on the nodes.

optional

topologySpreadConstraints TopologySpreadConstraintarrow-up-right array

TopologySpreadConstraints defines topology spread constraints for workload pods.

optional

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

Last updated