# Trilio Operator API Specifications
### Packages
* [triliovault.trilio.io/v1](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaulttrilioiov1)
### Custom Resource Definition Resources
The main CRDs provided by TrilioVault Manager for Kubernetes.
* [TrilioVaultManager](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanager)
#### TrilioVaultManager
TrilioVaultManager is the Schema for the triliovaultmanagers API
| Field | Description | Default | Validation |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ------- | ---------- |
| `apiVersion` *string* | `triliovault.trilio.io/v1` | | |
| `kind` *string* | `TrilioVaultManager` | | |
| `spec` [*TrilioVaultManagerSpec*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec) | | | |
| `status` [*TrilioVaultManagerStatus*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerstatus) | | | |
### Supporting Resources
Supporting types and specifications used by the main CRDs.
#### CSIConfig
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| 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:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| Field | Description | Default | Validation |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------- |
| `control-plane` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | ControlPlane holds all configuration for the control-plane deployment | | optionalXPreserveUnknownFields: {}
|
| `exporter` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | Exporter holds all configuration for the exporter deployment. | | optionalXPreserveUnknownFields: {}
|
| `web` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | Web holds all configuration for the web deployment | | optionalXPreserveUnknownFields: {}
|
| `web-backend` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | WebBackend holds all configuration for the web-backend deployment | | optionalXPreserveUnknownFields: {}
|
| `event-target` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | EventTarget holds all configuration for the event-target deployment | | optionalXPreserveUnknownFields: {}
|
| `ingress-controller` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | IngressController holds all configuration for the ingress-controller deployment | | optionalXPreserveUnknownFields: {}
|
#### ConditionStatus
*Underlying type:* *string*
*Appears in:*
* [TrilioAppCondition](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappcondition)
| Field | Description |
| --------- | ----------- |
| `True` | |
| `False` | |
| `Unknown` | |
#### Helm
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| Field | Description | Default | Validation |
| -------------------------- | ----------- | ------- | ---------------------- |
| `version` *string* | | | Enum: \[v3]
|
| `tillerNamespace` *string* | | | **optional** |
#### HelmValues
HelmValues takes any custom helm value user wants to provide to T4K helm chart
*Validation:*
* XPreserveUnknownFields: {}
*Appears in:*
* [ComponentConfiguration](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#componentconfiguration)
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
#### IngressConfig
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| 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](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#logconfig)
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
#### LogConfig
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| Field | Description | Default | Validation |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
| `logLevel` [*LevelType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#leveltype) | | | Enum: \[Panic Fatal Error Warn Info Debug Trace]
optional
|
| `datamoverLogLevel` [*LevelType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#leveltype) | | | 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
* [TrilioVaultManager](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanager)
#### ResourceScope
*Underlying type:* *string*
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| Field | Description |
| ------------ | ----------- |
| `Cluster` | |
| `Namespaced` | |
#### TrilioAppCondition
*Appears in:*
* [TrilioVaultManagerStatus](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerstatus)
| Field | Description | Default | Validation |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `type` [*TrilioAppConditionType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappconditiontype) | | | Enum: \[Initialized Deployed Updated ReleaseFailed Irreconcilable]
|
| `status` [*ConditionStatus*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#conditionstatus) | | | Enum: \[True False Unknown]
|
| `reason` [*TrilioAppConditionReason*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappconditionreason) | | | Enum: \[InstallSuccessful UpdateSuccessful UninstallSuccessful InstallError UpdateError ReconcileError UninstallError]
|
| `message` *string* | | | MinLength: 0
|
| `lastTransitionTime` [*Time*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta) | | | **optional** |
#### TrilioAppConditionReason
*Underlying type:* *string*
*Appears in:*
* [TrilioAppCondition](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappcondition)
| Field | Description |
| --------------------- | ----------- |
| `InstallSuccessful` | |
| `UpdateSuccessful` | |
| `UninstallSuccessful` | |
| `InstallError` | |
| `UpdateError` | |
| `ReconcileError` | |
| `UninstallError` | |
#### TrilioAppConditionType
*Underlying type:* *string*
*Appears in:*
* [TrilioAppCondition](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappcondition)
* [TrilioVaultManagerStatus](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerstatus)
| Field | Description |
| ---------------- | ----------- |
| `Initialized` | |
| `Deployed` | |
| `Updated` | |
| `ReleaseFailed` | |
| `Irreconcilable` | |
#### TrilioAppRelease
*Appears in:*
* [TrilioVaultManagerStatus](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerstatus)
| Field | Description | Default | Validation |
| ------------------- | ----------- | ------- | ---------- |
| `name` *string* | | | |
| `manifest` *string* | | | |
#### TrilioVaultManagerSpec
TrilioVaultManagerSpec defines the desired state of TrilioVaultManager
*Appears in:*
* [TrilioVaultManager](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanager)
| Field | Description | Default | Validation |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------- |
| `trilioVaultAppVersion` *string* | Deprecated: TrilioVaultAppVersion
Helm Chart version
| | **optional** |
| `helmVersion` [*Helm*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helm) | Deprecated: Helm Version | | **optional** |
| `applicationScope` [*ResourceScope*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#resourcescope) | 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** |
| `resources` [*ResourceRequirements*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | Deprecated: Resources are the resource requirements for the containers. | | **optional** |
| `metadataJobResources` [*ResourceRequirements*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | MetadataJobResources is the resource limits & requests for all the meta processing jobs. | | **optional** |
| `dataJobResources` [*ResourceRequirements*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | DataJobResources is the resource limits & requests for all the data processing jobs. | | **optional** |
| `targetBrowserResources` [*ResourceRequirements*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | 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** |
| `affinity` [*Affinity*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#affinity-v1-core) | The scheduling constraints on application pods. | | **optional** |
| `tolerations` [*Toleration*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core) *array* | The toleration of application against the specific taints on the nodes | | **optional** |
| `workerJobsSchedulingConfig` [*WorkloadSchedulingConfigs*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#workloadschedulingconfigs) | WorkerJobsSchedulingConfig holds the scheduling constraints for tvk jobs and data-mover pods. | | **optional** |
| `helmValues` [*HelmValues*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#helmvalues) | HelmValues holds all the additional fields in the values.yaml of T4K helm chart. | | optionalXPreserveUnknownFields: {}
|
| `componentConfiguration` [*ComponentConfiguration*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#componentconfiguration) | ComponentConfiguration holds all the field related to the T4K deployments. | | **optional** |
| `ingressConfig` [*IngressConfig*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#ingressconfig) | IngressConfig holds field related to ingress resource to access the T4K UI. | | **optional** |
| `tvkInstanceName` *string* | TVKInstanceName is a T4K installation name to be displayed on UI. | | **optional** |
| `logConfig` [*LogConfig*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#logconfig) | LogConfig is a configuration for the T4K logging. | | **optional** |
| `logLevel` [*LevelType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#leveltype) | Deprecated: LogLevel is a level used in T4K logging now used under logConfig
LogLevel is a level used in T4K logging.
| | Enum: \[Panic Fatal Error Warn Info Debug Trace]
|
| `datamoverLogLevel` [*LevelType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#leveltype) | Deprecated: DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the T4K now used under logConfig
DatamoverLogLevel is a log level used in datamover i.e. data upload/restore part of the T4K.
| | Enum: \[Panic Fatal Error Warn Info Debug Trace]
|
| `csiConfig` [*CSIConfig*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#csiconfig) | 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:*
* [TrilioVaultManager](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanager)
| Field | Description | Default | Validation |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | ------------ |
| `conditions` [*TrilioAppCondition*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappcondition) *array* | | | **optional** |
| `deployedRelease` [*TrilioAppRelease*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioapprelease) | | | |
| `releaseVersion` *string* | | | |
| `helmRevision` *integer* | | | |
| `status` [*TrilioAppConditionType*](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#trilioappconditiontype) | | | |
| `dashboard` *string* | | | |
#### WorkloadSchedulingConfigs
WorkloadSchedulingConfigs holds the scheduling constraints on tvk jobs and data-mover pods.
*Appears in:*
* [TrilioVaultManagerSpec](https://github.com/trilioData/k8s-triliovault-operator/blob/fe73f248297c585fa66ab49f31af4775693aa72f/docs/api-docs/api-docs-v1.md#triliovaultmanagerspec)
| Field | Description | Default | Validation |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------ |
| `affinity` [*Affinity*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#affinity-v1-core) | 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` [*Toleration*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core) *array* | Tolerations specifies the tolerations of the pod against the specific taints on the nodes. | | **optional** |
| `topologySpreadConstraints` [*TopologySpreadConstraint*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#topologyspreadconstraint-v1-core) *array* | TopologySpreadConstraints defines topology spread constraints for workload pods. | | **optional** |
*Generated with `gen-crd-api-reference-docs` on git commit ec84b9a.*
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.trilio.io/kubernetes/reference/custom-resource-definition-operator.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.