LogoLogo
5.0.X
5.0.X
  • About Trilio for Kubernetes
    • Welcome to Trilio For Kubernetes
    • Version 5.0.X Release Highlights
    • Compatibility Matrix
    • Marketplace Support
    • Features
    • Use Cases
  • Getting Started
    • Getting Started with Trilio on Red Hat OpenShift (OCP)
    • Getting Started with Trilio for Upstream Kubernetes (K8S)
    • Getting Started with Trilio for AWS Elastic Kubernetes Service (EKS)
    • Getting Started with Trilio on Google Kubernetes Engine (GKE)
    • Getting Started with Trilio on VMware Tanzu Kubernetes Grid (TKG)
    • More Trilio Supported Kubernetes Distributions
      • General Installation Prerequisites
      • Rancher Deployments
      • Azure Cloud AKS
      • Digital Ocean Cloud
      • Mirantis Kubernetes Engine
      • IBM Cloud
    • Licensing
    • Using Trilio
      • Overview
      • Post-Install Configuration
      • Management Console
        • About the UI
        • Navigating the UI
          • UI Login
          • Cluster Management (Home)
          • Backup & Recovery
            • Namespaces
              • Namespaces - Actions
              • Namespaces - Bulk Actions
            • Applications
              • Applications - Actions
              • Applications - Bulk Actions
            • Virtual Machines
              • Virtual Machine -Actions
              • Virtual Machine - Bulk Actions
            • Backup Plans
              • Create Backup Plans
              • Backup Plans - Actions
            • Targets
              • Create New Target
              • Targets - Actions
            • Hooks
              • Create Hook
              • Hooks - Actions
            • Policies
              • Create Policies
              • Policies - Actions
          • Monitoring
          • Guided Tours
        • UI How-to Guides
          • Multi-Cluster Management
          • Creating Backups
            • Pause Schedule Backups and Snapshots
            • Cancel InProgress Backups
            • Cleanup Failed Backups
          • Restoring Backups & Snapshots
            • Cross-Cluster Restores
            • Namespace & application scoped
            • Cluster scoped
          • Disaster Recovery Plan
          • Continuous Restore
      • Command-Line Interface
        • YAML Examples
        • Trilio Helm Operator Values
    • Upgrade
    • Air-Gapped Installations
    • Uninstall
  • Reference Guides
    • T4K Pod/Job Capabilities
      • Resource Quotas
    • Trilio Operator API Specifications
    • Custom Resource Definition - Application
  • Advanced Configuration
    • AWS S3 Target Permissions
    • Management Console
      • KubeConfig Authenticaton
      • Authentication Methods Via Dex
      • UI Authentication
      • RBAC Authentication
      • Configuring the UI
    • Resource Request Requirements
      • Fine Tuning Resource Requests and Limits
    • Observability
      • Observability of Trilio with Prometheus and Grafana
      • Exported Prometheus Metrics
      • Observability of Trilio with Openshift Monitoring
      • T4K Integration with Observability Stack
    • Modifying Default T4K Configuration
  • T4K Concepts
    • Supported Application Types
    • Support for Helm Releases
    • Support for OpenShift Operators
    • T4K Components
    • Backup and Restore Details
      • Immutable Backups
      • Application Centric Backups
    • Retention Process
      • Retention Use Case
    • Continuous Restore
      • Architecture and Concepts
  • Performance
    • S3 as Backup Target
      • T4K S3 Fuse Plugin performance
    • Measuring Backup Performance
  • Ecosystem
    • T4K Integration with Slack using BotKube
    • Monitoring T4K Logs using ELK Stack
    • Rancher Navigation Links for Trilio Management Console
    • Optimize T4K Backups with StormForge
    • T4K GitHub Runner
    • AWS RDS snapshots using T4K hooks
    • Deploying Trilio For Kubernetes with Openshift ACM Policies
  • Krew Plugins
    • T4K QuickStart Plugin
    • Trilio for Kubernetes Preflight Checks Plugin
    • T4K Log Collector Plugin
    • T4K Cleanup Plugin
  • Support
    • Troubleshooting Guide
    • Known Issues and Workarounds
    • Contacting Support
  • Appendix
    • Ignored Resources
    • OpenSource Software Disclosure
    • CSI Drivers
      • Installing VolumeSnapshot CRDs
      • Install AWS EBS CSI Driver
    • T4K Product Quickview
    • OpenShift OperatorHub Custom CatalogSource
      • Custom CatalogSource in a restricted environment
    • Configure OVH Object Storage as a Target
    • Connect T4K UI hosted with HTTPS to another cluster hosted with HTTP or vice versa
    • Fetch DigitalOcean Kubernetes Cluster kubeconfig for T4K UI Authentication
    • Force Update T4K Operator in Rancher Marketplace
    • Backup and Restore Virtual Machines running on OpenShift
    • T4K For Volumes with Generic Storage
    • T4K Best Practices
Powered by GitBook
On this page

Was this helpful?

  1. Reference Guides

Custom Resource Definition - Application

API reference for Trilio Application

PreviousTrilio Operator API SpecificationsNextAWS S3 Target Permissions

Was this helpful?

Packages:

triliovault.trilio.io/v1

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

Resource Types:

ActionFlags

(Appears on: , )

Field
Description

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupPlan to protect the restored application.

imageRestore bool

ImageRestore is flag to perform the container image restore

ApplicationType (string alias)

(Appears on: , , )

ApplicationType specifies type of a Backup of an application

Backup

Backup represents the capture of Kubernetes BackupPlan defined by user at a point in time

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

BackupComponent

BackupComponent defines the namespace and their configurations for backup

Field
Description

namespace string

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specifies the resources included during backup

ExcludedResources specifies the resources excluded during backup

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupComponentInfo

Field
Description

Name string

BackupCondition

BackupCondition specifies the current condition of a backup resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller. nolint:lll // directive continuation

BackupConfig

BackupConfig defines the required configuration for taking the backup such as target and retention policy. NOTE: ClusterBackupConfig field in clusterbackupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.

Field
Description

Target is the object reference for the backup target resources

RetentionPolicy is the object reference for the policy of type retention defined

SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full

maxIncrBackupsPerFullBackup byte

MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

BackupInfo

BackupInfo contains the relevant information to uniquely identify a child Backup created from a ClusterBackup

Field
Description

Backup ObjectReference of child Backup

Status status of child Backup

percentageCompletion byte

PercentageCompletion is the amount of backup operation completed.

location string

Location is the Backup’s location on the target

BackupPlan

BackupPlan is the Schema for the BackupPlan API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

BackupPlanComponents

BackupPlanComponents contains the 3 types of components, helm charts, operators and custom label-based resources

Field
Description

helmReleases []string

HelmReleases is the list of release names

Operators is the list of operator names and their selectors

Deprecated: Custom is the combination of label selectors including match labels and match expressions

CustomSelector specify resource selection for custom resources, This is the combination of LabelSelectorincluding match labels and match expressions and GVKSelector which could be GroupVersionKind & Objects

BackupPlanCondition

BackupPlanCondition specifies the current condition of a backupPlan resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

BackupPlanFlags

Field
Description

skipImageBackup bool

SkipImageBackup is flag to skip the container images backup

BackupPlanInfo

BackupPlanInfo defines the object reference and status of a backupPlan

Field
Description

BackupPlan is the object reference of a backupPlan

PartOf specify how backupPlan is selected, it could be by NamespaceSelector or by BackupComponent

name string

Name will specify namespace selector’s name if backupPlan is PartOf NamespaceSelector Name will be empty if backupPlan is PartOf BackupComponents

Status is the status of the backupPlan

BackupPlanSelector (string alias)

BackupPlanSelector used in ClusterBackupPlan Status to identify how corresponding backupPlan is selected by, it could be by NamespaceSelector or by BackupComponent

BackupPlanSpec

BackupPlanSpec defines the desired state of BackupPlan

Field
Description

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based onLabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

BackupPlanStats

BackupPlanStats defines the stats for a BackupPlan

Field
Description

immutable bool

Immutable specify whether a backup data is going to be immutable.

BackupPlanStatus

BackupPlanStatus defines the observed state of BackupPlan

Field
Description

Condition is the current condition of a backupPlan.

Status defines the status oif the application resource as available when no operation is running and unavailable when a backup or restore operation is in progress

Scope indicates scope of component in BackupPlan i.e. App or Namespace.

ApplicationType is the type of BackupPlan defining backup

Deprecated: IncrementalCron will be used as an list of references of Crons

Deprecated: FullBackupCron will be used as an list of references of Crons

SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status

ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

BackupScanInfo

Field
Description

MetadataScannerStatus is the result of Metadata Scanning It is the mapping of scanner name and its corresponding report

DataScannerStatus is the result of Data Scanning It is the mapping of scanner name and its corresponding report

ImageScannerStatus is the result of Image Scanning It is the mapping of scanner name and its corresponding report

BackupScheduleType (string alias)

BackupScheduleType specifies the type of schedule which triggered the backup

BackupSpec

BackupSpec defines the desired state of Backup

Field
Description

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

BackupStats

BackupStats specifies the stats of a Backup

Field
Description

Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field.

TargetInfo is the information to a Target backed up

LatestInProgressRestore is the reference to the latest InProgress Restore of a Backup

LatestCompletedRestore is the reference to the latest Completed Restore of a Backup

hookExists bool

HookExists is a bool value that states if a backup has hooks in backup plan

Encryption specifies encryption details of a backup

immutable bool

Immutable specify whether a backup data is immutable

BackupStatus

BackupStatus defines the observed state of Backup

Field
Description

BackupScope indicates scope of component in backup i.e. App or Namespace.

ApplicationType is the type of Application backed up in the App Scoped backup.

Type indicates the backup type in backup i.e. Full, Incremental or Mixed.

location string

Location is the absolute path of the target where backup resides.

StartTimestamp is the time a backup was started.

CompletionTimestamp is the time a backup was finished.

Phase is the current phase of the backup operation.

PhaseStatus is the status of phase backup operation going through.

Status is the status of the backup operation.

Size is the aggregate size of the data backuped up.

percentageCompletion byte

PercentageCompletion is the amount of backup operation completed.

ExpirationTimeStamp is the time a backup will not be available after retention.

Todo: Do we need this option as optional one? Todo: This is optional because, we are allowing the custom backup as empty Snapshot specifies the contents of captured backup.

Condition is the current condition of hooks while backup.

HookStatus specifies pre/post hook execution status for current backup.

SecurityScanStatus contains the information of Security Scan performed for Backup on each Security instanceID defined.

ConsistentSetStatus contains the mapping of instanceID and the ContinuousRestore performed for Backup on that ContinuousRestore site instance.

Duration is the amount of time the backup process took to finish.

encryptionEnabled bool

EncryptionEnabled flag shows that encryption is enabled for backup

BackupSummary

BackupSummary comprises of backup object references and count of backups with different statuses

Field
Description

InProgressBackup is the reference to an InProgress backup of a BackupPlan

LastSuccessfulBackup is the reference to Latest available Backup of a BackupPlan

LatestBackup is the reference to Latest Backup in any state, of a BackupPlan

totalAvailableBackups uint32

TotalAvailableBackups is the count of total number of Available Backups

totalFailedBackups uint32

TotalFailedBackups is the count of total number of InProgress Backups

totalQueuedBackups uint32

TotalQueuedBackups is the count of total number of Queued Backups

pvcExistsForBackup bool

PVCExistsForBackup is a bool value that states if the latest backup of a backup plan has PVCs in its data component

BackupType (string alias)

BackupType defines the type backup instance of an BackupPlan

CleanupConfig

CleanupConfig is the configuration for the PolicyType: Cleanup

Field
Description

backupDays int

BackupDays is the age of backups to be cleaned

ClusterBackup

ClusterBackup is the Schema for the ClusterBackup API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

ClusterBackupCondition

ClusterBackupCondition specifies the current condition of a clusterBackup resource.

Field
Description

Phase defines the current phase of the controller.

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why clusterBackup is in this condition.

ClusterBackupConfig

ClusterBackupConfig defines the require configuration for taking the backup such as target and retention policy. NOTE: BackupConfig field in backupplan_types.go is similar to this structure. Changes made here might be required to be reflected there as well.

Field
Description

Target is the object reference for the backup target resources

RetentionPolicy is the object reference for the policy of type retention defined

SchedulePolicy includes the object references of 2 type of cron schedule policy: incremental and full

maxIncrBackupsPerFullBackup byte

MaxIncrBackupsPerFullBackup is the number of incremental backups after which full backup will ge triggered. This is relevant only in case of immutable backups

ClusterBackupPlan

ClusterBackupPlan is the Schema for the ClusterBackupPlan API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanCondition

ClusterBackupPlanCondition specifies the current condition of a cluster backup plan resource.

Field
Description

Status is the status of the condition

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

Phase defines the current phase of the controller.

Phase defines the current phase of the controller.

Phase defines the current phase of the controller.

ClusterBackupPlanSpec

ClusterBackupPlanSpec defines the desired state of ClusterBackupPlan

Field
Description

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

ClusterBackupPlanStats

ClusterBackupPlanStats defines the stats for a ClusterBackupPlan

Field
Description

immutable bool

Immutable specify whether a backup data is going to be immutable

ClusterBackupPlanStatus

ClusterBackupPlanStatus defines the observed state of ClusterBackupPlan

Field
Description

Status defines the current state of the ClusterBackupPlan resource. Availablestate ClusterBackupPlan only can be used for ClusterBackup

BackupPlans is the map of backupPlan name and its object ref managed by cluster backup plan

Condition is the current condition of a cluster backup plan.

SecurityScanStatus contains the information of each Security instanceID defined, and it’s Security Scan status

ContinuousRestoreStatus contains the information of each ContinuousRestore instanceID defined, and it’s ContinuousRestore service status

ClusterBackupSchedulePolicy

ClusterBackupSchedulePolicy contains the object references for incremental or full backup type schedule policy

Field
Description

IncrementalBackupPolicy is the object reference for the policy of type schedule defined

FullBackupPolicy is the object reference for the policy of type schedule defined

ClusterBackupSpec

ClusterBackupSpec defines the desired state of ClusterBackup

Field
Description

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

ClusterBackupStats

ClusterBackupStats specifies the stats of a ClusterBackup

Field
Description

Target is the reference to a Target backuped up Deprecated: Target information moved to TargetInfo field

TargetInfo is the information to a Target backed up

LatestInProgressClusterRestore is the reference to the latest InProgress ClusterRestore of a ClusterBackup

LastCompletedClusterRestore is the reference to the latest Completed ClusterRestore of a ClusterBackup

hookExists bool

HookExists is a bool value that states if a ClusterBackup has hooks in ClusterBackupPlan

Encryption specifies encryption details of a ClusterBackup

immutable bool

Immutable specify whether a clusterBackup data is immutable

ClusterBackupStatus

ClusterBackupStatus defines the observed state of ClusterBackup

Field
Description

Type indicates the ClusterBackup type in backup i.e. Full, Incremental or Mixed.

location string

Location is the absolute path of the target where backup resides.

StartTimestamp is the time when ClusterBackup was started.

CompletionTimestamp is the time when ClusterBackup finished.

Status is the status of the ClusterBackup operation.

Size is the aggregate size of the data backuped up.

percentageCompletion byte

PercentageCompletion is the percentage of ClusterBackup operation completed.

ExpirationTimeStamp is the time after which a ClusterBackup will not be available after retention.

Condition is the conditions a ClusterBackup goes through during backup TODO: Define a separate condition struct

Duration is the amount of time the ClusterBackup process took to finish.

BackupInfos contains the information of the child Backup CRs created by this ClusterBackup

SecurityScanStatus contains the information of Security Scan performed for ClusterBackup on each Security instanceID defined.

ConsistentSetStatus contains the information of ContinuousRestore performed for ClusterBackup on each ContinuousRestore instanceID defined.

encryptionEnabled bool

EncryptionEnabled flag shows that encryption is enabled for cluster backup

ClusterBackupSummary

ClusterBackupSummary comprises of ClusterBackup object references and count of ClusterBackups with different statuses

Field
Description

InProgressClusterBackup is the reference to an InProgress ClusterBackup of a ClusterBackupPlan

LastSuccessfulClusterBackup is the reference to Latest available ClusterBackup of a ClusterBackupPlan

LatestClusterBackup is the reference to Latest ClusterBackup in any state, of a ClusterBackupPlan

totalAvailableClusterBackups uint32

TotalAvailableClusterBackups is the count of total number of Available ClusterBackups

totalFailedClusterBackups uint32

TotalFailedClusterBackups is the count of total number of Failed ClusterBackups.

totalQueuedClusterBackups uint32

TotalQueuedClusterBackups is the count of total number of Queued ClusterBackups.

pvcExistsForBackup bool

PVCExistsForBackup is a bool value that states if the latest clusterBackup of a clusterBackupPlan has any backup that has PVCs in its data component

ClusterRestore

ClusterRestore defines the desired state of ClusterRestore

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

ClusterRestoreCondition

Field
Description

Phase defines the current phase of the controller.

Status is the status of the cluster restore.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

ClusterRestoreSource

Field
Description

Type is the type of source for restore

ClusterBackup is a reference to the ClusterBackup instance restored if type is ClusterBackup.

Target is a reference to the Target instance where from restore is performed if type is Location.

location string

Location is an absolute path to remote target from where restore is performed if type is Location.

ClusterBackupPlan is a reference to the ClusterBackupPlan whose latest successful backup is to be restored.

ConsistentSet is a reference to the ConsistentSet where restore is performed if type is ConsistentSet.

ClusterRestoreSourceType (string alias)

ClusterRestoreSpec

ClusterRestoreSpec defines the source from where the ClusterRestore is to be done

Field
Description

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

ClusterRestoreStats

ClusterRestoreStats defines the stats for a RestorCluster

Field
Description

ClusterBackupPlan is the reference to ClusterBackupPlan associated with ClusterRestore

ClusterBackup is the reference to the ClusterBackup associated with ClusterRestore

ClusterRestoreStatus

ClusterRestoreStatus defines the observed state of ClusterRestore

Field
Description

StartTimestamp is the time when ClusterRestore was started.

CompletionTimestamp is the time when ClusterRestore finished.

Phase is the current phase of the ClusterRestore operation.

PhaseStatus is the status of phase ClusterRestore operation going through.

Status is the status of the ClusterRestore operation.

Size is the aggregate size of the data restored back.

percentageCompletion byte

PercentageCompletion is the percentage of ClusterRestore operation completed.

Condition is the overall condition of cluster restore resource.

Duration is the amount of time the ClusterRestore process took to finish.

ComponentInfos contains information related to each individual backup to be restored

createdNamespaces []string

CreatedNamespaces are the namespaces created for restores.

ProtectingResources lists the Trilio resources and dependent resources which are getting created after user cluster restore operation. It’s applicable only if ProtectRestoredApp is set to true.

encryptionEnabled bool

EncryptionEnabled flag shows that encryption is enabled for cluster backup

ClusterRestoreSummary

ClusterRestoreSummary comprises of ClusterRestore object references and count of ClusterRestore with different statuses

Field
Description

LastSuccessfulClusterRestore is the reference to Latest completed ClusterRestore of a ClusterBackupPlan

LatestClusterRestore is the reference to Latest ClusterRestore in any state, of a ClusterBackupPlan

totalInProgressClusterRestores uint32

TotalInProgressClusterRestores is the count of total number of InProgress ClusterRestores

totalCompletedClusterRestores uint32

TotalCompletedClusterRestores is the count of total number of Completed ClusterRestores

totalFailedClusterRestores uint32

TotalFailedClusterRestores is the count of total number of Failed ClusterRestores

ComponentConfig

Field
Description

backupNamespace string

restoreNamespace string

ComponentInfo

Field
Description

location string

Location is the location of the backup on target.

Backup is the reference of the Backup CR used for backing up this component

Restore is the reference of the Restore CR used for restoring this component.

Status is the status of particular restore.

percentageCompletion byte

PercentageCompletion is the amount of restore operation completed.

ComponentScope (string alias)

ComponentScope indicates scope of components i.e. [App or Namespace] present in backup or restore

ComponentStatus

ComponentStatus defines the details of restore of application component.

Field
Description

ExistingResource specifies the resources already existing in cluster defined in application.

SkippedResources specifies the resources skipped while restoring.

FailedResources specifies the resources for which the restore operation failed

NewResourcesAdded specifies the resources added(duplicated and modified) during restore.

ExcludedResources specifies the resources excluded during restore

FailedCleanupResources specified the resources which doesn’t get clean up in failed restore

TransformStatus is the status of transformation performed

Phase is the current phase of the application component while restore.

PhaseStatus is the status of phase restore operation going through.

reason string

A brief message indicating details about why the application component is in this state.

Conditions

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the data components.

ConsistentSet

nolint:lll // directive continuation ConsistentSet is the Schema for the ConsistentSet API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ConsistentSetCondition

Field
Description

Phase defines the current phase of the controller.

Status is the status of the cluster restore.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

ConsistentSetInfo

Field
Description

consistentSetName string

ConsistentSetName is the name of ConsistentSet created for ContinuousRestore corresponding to the Backup/ClusterBackup

consistentSetUID k8s.io/apimachinery/pkg/types.UID

ScanInstanceUID is the UID of the ConsistentSet created for ContinuousRestore corresponding to the Backup/ClusterBackup

ConsistentSetStatus is the current Status of ConsistentSet.

ConsistentSetCreationTimeStamp is the creation timestamp of ConsistentSet

ConsistentSetCompletionTimeStamp is the completion timestamp of ConsistentSet

TotalSize is the aggregate size of the data restored

ConsistentSetScope (string alias)

ConsistentSetScope indicates scope of Consistent i.e. [Namespace or Cluster] as per the location given

ConsistentSetSpec

ConsistentSetSpec defines the desired state of ConsistentSet

Field
Description

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ConsistentSetStats

ConsistentSetStats defines the stats for a consistent set

Field
Description

ConsistentSetStatus

ConsistentSetStatus defines the observed state of ConsistentSet

Field
Description

Status defines the status of ConsistentSet. When consistentSet is used in any Restore/ClusterRestore, it’s status will be in InUse

Scope defines scope of ConsistentSet i.e. Namespace or Cluster

StartTimestamp is the time when ConsistentSet was started.

CompletionTimestamp is the time when ConsistentSet operation finished.

BackupInfo contains the information of data restored done for each Backup available on the location specified. It contains a mapping of Backup-uuid and related data restored info.

Size is the aggregate size of the data restored back.

percentageCompletion byte

PercentageCompletion is the percentage of ConsistentSet operation completed.

Phase is the current phase of the ConsistentSet operation.

PhaseStatus is the status of phase ConsistentSet operation going through.

Condition is the overall condition of ConsistentSet resource.

Duration is the amount of time the ConsistentSet process took to finish.

ContainerHookStatus

ContainerHookStatus defines hook execution status for a containers

Field
Description

containerName string

ContainerName is container in which hooks are executed.

PreHookStatus defines status for pre hooks

PostHookStatus defines status for post hooks

ContainerImage

Field
Description

ID string

ID is the image ID to uniquely identify the image

registry string

Registry of the container image

repository string

Repository of the container image

image string

Image is the name of the container image

backupImageFQDN string

BackupImageFQDN is the actual image name provided in resource spec at the time of backup

tag string

Tag is the image tag of the container image

newTag string

NewTag is populated when the Tag exists on the repo with a different sha in case of restore

sha string

Sha is the sha digest of the container image

ImagePullSecrets defines imagePullSecrets and resource who used these imagePullSecrets

warnings []string

Warnings is the list of warnings captured during image backup or restore of an application

ContinuousRestoreConfig

Field
Description

consistentSets int

ConsistentSets is the number of ConsistentSets to be retained for each Backup

ContinuousRestoreConfigInfo

ContinuousRestoreConfigInfo defines the Continuous Restore instances info which will be used for Continuous Restore operation

Field
Description

ContinuousRestoreInstances defines the list of Continuous Restore instances which will perform the Continuous Restore operation

ContinuousRestoreInstance

ContinuousRestoreInstance defines details of Continuous Restore for InstanceID specified

Field
Description

instanceID string

InstanceID is the unique Instance ID of the Continuous Restore Service to be used for Continuous Restore

ContinuousRestorePolicy is the object reference to the Continuous Restore Policy to be used for Continuous Restore

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlan

ContinuousRestorePlan is the Schema for the ContinuousRestorePlan API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlanCondition

ContinuousRestorePlanCondition specifies the current condition of a ContinuousRestorePlan resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

ContinuousRestorePlanSpec

ContinuousRestorePlanSpec defines the desired state of ContinuousRestorePlan

Field
Description

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePlanStatus

ContinuousRestorePlanStatus defines the observed state of ContinuousRestorePlan

Field
Description

Condition is the current condition of a ContinuousRestorePlan.

Status defines the status of the ContinuousRestorePlan resource as per the status of target

ConsistentSetInfo is the list of ConsistentSet related info for the number of ConsistentSet defined

ContinuousRestoreStatus

ContinuousRestoreStatus specifies the details of Continuous Restore operation status of an instance

Field
Description

continuousRestoreEnabled bool

ContinuousRestoreEnabled denotes if the Continuous Restore service is actually enabled on the ContinuousRestore site

ContinuousRestoreSiteStatus is the current Status of ContinuousRestore service Available/Unavailable. It is updated as per the heartbeat of ContinuousRestore service

LastConsistentSetCreationTimestamp is the creation time stamp of the last ConsistentSet created for this BackupPlan/ClusterBackupPlan

LastSuccessfulConsistentSetTimestamp is the completion timestamp of the last successful ScanSet created for this BackupPlan/ClusterBackupPlan

numAvailableConsistentSet int

NumAvailableConsistentSet is the number of available ConsistentSets for this BackupPlan/ClusterBackupPlan on ContinuousRestore site

continuousRestorePlan string

ContinuousRestorePlan denotes the name of ContinuousRestorePlan created for this BackupPlan/ClusterBackupPlan on the ContinuousRestore site

CronSpec

CronSpec defines the Schedule string and the cronjob reference. The Schedule string will only be visible to the user to be configured, the reference will be set by the controller Deprecated: Instead of using single cron string, schedule policy will use list of cron string

Field
Description

schedule string

Crons

Crons defines the list of Schedule string and the cronjob references. The list of Schedule string will only be visible to the user to be configured, and the references will be set by the controller

Field
Description

schedule []string

Custom

Custom defines the snapshot of Custom defined application.

Field
Description

Resources defines the Kubernetes resources found from Custom application.

DataSnapshot specifies the Snapshot of the Volumes resources in the Custom defined application.

warnings []string

Warnings is the list of warnings captured during backup or restore of an application

CustomSelector

CustomSelector defines custom resource selection using SelectResources which defines include resources & ExcludeResourcesspecify resource exclusion based on Label based & GVK based selection

Field
Description

SelectResources specify resource selection based on LabelSelector & GVKSelector

ExcludeResources specify resource exclusion based on LabelSelector & GVKSelector

CustomTransform

CustomTransform specifies transformation configuration for Custom label-based resources

Field
Description

transformName string

TransformName specifies the name of transformation

Resources specifies the resources for which transformation needs to be applied

JSONPatches specifies the JSON patches to be applied

DataSnapshot

DataSnapshot defines Snapshot of a Persistent Volume

Field
Description

BackupType is the type of Volume backup in the sequence of backups.

location string

Location is the absolute path of qcow2 image of a volume in the target.

persistentVolumeName string

PersistentVolumeName is the name of PersistentVolume which is bound to PersistentVolumeClaim

persistentVolumeMetadata string

PersistentVolumeMetadata is the metadata of PersistentVolume which is bound to PersistentVolumeClaim.

persistentVolumeClaimName string

PersistentVolumeClaimName is the name of PersistentVolumeClaim which is bound to Volume.

persistentVolumeClaimMetadata string

PersistentVolumeClaimMetadata is the metadata of PersistentVolumeClaim which is bound to Volume(Deprecated).

operatorResourceVolume bool

OperatorResourceVolume will be true for the PVC created by the operator resource.

VolumeSnapshot specifies the CSI snapshot of a Persistent Volume.

PVSize is the actual size of the persistent volume for which backup is happening.

SnapshotSize is the size of the volume snapshot of a Persistent Volume.

Size is the size of qcow2 created/restored in backup/restore.

uploaded bool

Uploaded is to imply whether volume snapshot taken is uploaded to target.

error string

Error is the error occurred while backing up data component if any.

PodContainersMap is the set of Pod-Containers which share Persistent Volume.

Conditions are the current statuses for backup and restore PVCs.

DayOfWeek (string alias)

Encryption

Encryption defines encryption secret to encrypt/decrypt backup data on target

Field
Description

EncryptionSecret is object ref of a secret which contains encryption key for backup encryption

GVKR

GVKR defines the Kubernetes resource type and name

Field
Description

GroupVersionKind specifies GVK uniquely representing particular resource type.

resource string

Resource specifies resource name

GroupVersionKind

GroupVersionKind defines the Kubernetes resource type

Field
Description

group string

version string

kind string

Helm

Helm defines the snapshot of application defined by a Helm.

Field
Description

release string

Release string is the name of release

newRelease string

NewRelease string is the new release name which will get used while validation and restore process

revision int32

Revision defines the version of deployed release backed up

Deprecated: Resource is the captured GVK (secret or configmap) and corresponding object names slice.

Resources are the helm release resources with their GVK and Name

StorageBackend is the enum which can be either configmaps and secrets

Version represents the Helm binary version used at the time of snapshot

DataSnapshot specifies the Snapshot of the Volumes defined in the helm chart resources.

warnings []string

Warnings is the list of warnings captured during backup or restore of an application

HelmStorageBackend (string alias)

HelmStorageBackend defines the enum for the types of storage backend from where the helm release is backed-up

HelmTransform

HelmTransform specifies transformation configuration for Helm

Field
Description

transformName string

TransformName specifies the name of transformation

release string

Release specifies the release name for which the transformation is to be done

Set specifies the key-value pair to be set

HelmVersion (string alias)

HelmVersion defines the version of helm binary used while backup; currently supported version is v3

Hook

Hook is the Schema for the hooks API.

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

HookComponentStatus

HookComponentStatus indicates status of hook execution for backup/restore

Field
Description

podReadyWaitSeconds uint16

PodReadyWaitSeconds is the wait time for which hook execution waits before performing hook Quiescing/UnQuiescing It is only applicable for pods which are found in NotRunning state during hook execution Default value is 120s, that will be set by webhook.

HookPriorityStatuses specifies pre/post hook execution status for current backup.

HookConfig

HookConfig defines the sequence of hook actions and their associated pod-container regexes

Field
Description

Mode can be sequential or parallel which defines the way hooks will be executed. If mode is parallel, ignore the hook sequence.

podReadyWaitSeconds uint16

PodReadyWaitSeconds is the wait time for which hook execution waits before performing hook Quiescing/UnQuiescing It is only applicable for pods which are found in NotRunning state during hook execution Default value is 120s, that will be set by webhook.

Hooks defines the config’s for hook action object reference to the matching regexes of pod and containers

HookConfiguration

HookConfiguration contain’s configuration for hook implementation.

Field
Description

maxRetryCount byte

MaxRetryCount is the maximum number of times pre/post hook execution can be retried. MaxRetryCount will be equal to the RetryCount specified in Hook Spec.

timeoutSeconds uint16

TimeoutSeconds is A Maximum allowed time in seconds to execute Hook. timeout here is a hard timeout. Meaning the command needs to exit in that time, either with exit code 0 or non 0. hook execution will be considered in error if it fails to complete within timeout.

ignoreFailure bool

IgnoreFailure is a boolean, if set to true all the failures will be ignored for both in pre and post hooks Default is false.

HookExecution

HookExecution specifies the Hook required to quiesce or unquiesce the application

Field
Description

ExecAction is a Command to be executed as a part of Hook. Specifies the action to take. Commands should include what shell to use or the commands and its args which will be able to run without the shell. User can provide multiple commands merged as a part of a single command in the ExecAction. Shell Script Ex. [“/bin/bash”, “-c”, “echo hello > hello.txt && echo goodbye > goodbye.txt”]

ignoreFailure bool

IgnoreFailure is a boolean, if set to true all the failures will be ignored both in pre and post hooks Default is false.

maxRetryCount byte

MaxRetryCount count will be used to retry hook execution within the time range specified by Timeout in TimeoutSeconds field. Hook execution will be considered in error if it fails to complete within MaxRetryCount. Each retry count will be run with timeout of TimeoutSeconds field. Default is 0

timeoutSeconds uint16

TimeoutSeconds is A Maximum allowed time in seconds for each retry count according to value set inMaxRetryCount field to execute Hook. timeout here is a hard timeout. MaxRetryCount field is related to TimeoutSeconds, Meaning each retry count will run with a timeout of TimeoutSeconds. The command needs to exit in that time, either with exit code 0 or non 0.

HookInfo

HookInfo defines the config for hook action object reference to the matching regexes of pod and containers

Field
Description

Hook is the object reference of the Hook resource which will be run while quiescing

PodSelector will identify set of pods for hook config based on either Labels or Regex pattern.

containerRegex string

ContainerRegex identifies containers for hook execution from pods which are filtered using PodSelector. If not given then hooks will be executed in all the containers of the identified pods

HookPriority

HookPriority contain hook & their targeted resources

Field
Description

Hook is the object reference of the Hook resource which will be run while quiescing

PreHookConf defines how pre hook implementation will be handled

PostHookConf defines how post hook implementation will be handled

HookTarget defines targeting hook resources.

HookPriorityStatus

HookPriorityStatus defines observed state for hooks priority wise.

Field
Description

priority byte

Priority defines priority for hooks. backup controller will use Priority to determine sequence of hook execution. In case of parallel Mode, priority will be same for all, in case of sequential Mode, priority will be same for a group and not individual HookConfig Set. Default Priority is 0.

Hooks defines list of hooks with priority Priority.

HookSpec

HookSpec defines the desired state of Hook.

Field
Description

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

HookStatus

HookStatus defines the observed state of Hook.

HookTarget

Field
Description

Owner specifies the parent for identified pods in PodHookStatus. backup controller will fetch pods from Owner to execute the hooks. Owner will be nil for pods with no owner.

containerRegex string

ContainerRegex identifies containers in identified pods to execute hooks.

PodHookStatus specifies pre/post hook execution status for current backup.

Image

Field
Description

ImageSnapshot specifies the Snapshot of the container images in the backup.

ImagePullSecret

ImagePullSecret defines imagePullSecrets and resource who used these imagePullSecrets

Field
Description

ReferencedBy defines GVK and name of resource who is using these imagePullSecrets

ImagePullSecret is the pull secret to pull the container image

ImageRegistry

Field
Description

repository string

Repository is a container repository to restore the backup container images

registry string

Registry is container registry to restore the backup container images

RegistryAuthSecret contains the docker config auth file or username and password, which will authenticate the docker push

ImageSnapshot

ImageSnapshot defines the snapshot of images defined by all applications.

Field
Description

BackupType is the type of image backup in the sequence of backups.

location string

Location is the absolute path of image qcow2 in the target.

Size is the size of qcow2 created/restored in backup/restore.

error string

Error is the error occurred while backing up image component if any.

ContainerImages specifies the list of container images to use in the backup

KeyValue

KeyValue specifies key-value pair for helm transformation

Field
Description

key string

Key denotes the key for which value is to be set

value string

Value denotes the value to be set

License

License is the Schema for the licenses API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

key string

Key is the product key to use triliovault application to perform backup/restore.

key string

Key is the product key to use triliovault application to perform backup/restore.

key string

Key is the product key to use triliovault application to perform backup/restore.

key string

Key is the product key to use triliovault application to perform backup/restore.

LicenseCondition

LicenseCondition specifies the current condition of a license.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

message string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

LicenseEdition (string alias)

LicenseEdition specifies the edition of the license.

LicenseProperties

LicenseProperties specifies the properties of a license based on provided license key.

Field
Description

company string

Company is the name of a company purchased license for.

Edition is the type of license purchased to use triliovault application.

CreationTimestamp is the time license created to use triliovault application.

PurchaseTimestamp is the time user purchased the license to use triliovault application.

ExpirationTimestamp is the time provided license going to expire and won’t be able to perform backup/restore operation.

MaintenanceExpiryTimestamp is the time maintenance support for the provided license going to expire.

kubeUID string

KubeUID is the kubesystem or namespace uuid of the cluster the license purchased for.

Scope is the scope of a KubeUID the license purchased for.

version string

Version is the version of a license.

sen string

SEN is the unique serial of a license purchased.

numberOfUsers int

NumberOfUsers is the total number of users the license valid for.

serverID string

ServerID is the unique serverID of license purchased.

licenseID string

LicenseID is the identifier for the license.

capacity uint32

Capacity is the maximum capacity to use the license in number of CPUs.

active bool

Active is the status of the license.

LicenseSpec

LicenseSpec defines the desired state of License

Field
Description

key string

Key is the product key to use triliovault application to perform backup/restore.

LicenseState (string alias)

LicenseState specifies the overall status of the license.

LicenseStatus

LicenseStatus defines the observed state of License

Field
Description

Status is the overall status of the license based on provided key.

message string

A brief message indicating details about why the license in this state.

Properties is the details about the license based on provided license key.

Condition is the current condition of a license.

currentNodeCount uint32

Deprecated: CurrentNodeCount is the total number of nodes kubernetes cluster comprised of where each node capped at 2 vCPUs/pCPUs.

currentCPUCount uint32

CurrentCPUCount is the total number of CPUs currently available.

GracePeriodStartTimestamp is the time grace period started to use triliovault application.

GracePeriodEndTimestamp is the time grace period for using the triliovault application going to end.

maxNodes uint32

Deprecated: MaxNodes is the count of maximum number of nodes available in cluster.

maxCPUs uint32

MaxCPUs is the count of maximum number of CPUs available in cluster.

Mode (string alias)

Mode is the enum for 2 modes of quiescing the application components i.e Sequential or Parallel

MonthOfYear (string alias)

MultiNamespaceCondition

MultiNamespaceCondition specifies the current condition of a clusterNamespace resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why clusterNamespace resource is in this condition.

NFSCredentials

NFSCredentials defines the credentials to use NFS as a target type.

Field
Description

nfsExport string

A NFS location in format trilio.net:/data/location/abcde or 192.156.13.1:/user/keeth/data.

nfsOptions string

An additional options passed to mount NFS directory e.g. rw, suid, hard, intr, timeo, retry.

NamespaceSelector

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

Field
Description

name string

Name specify name for NamespaceSelector, useful to identify why namespaces grouped together using LabelSelector

LabelSelector identifies set of namespaces for which backup are to be taken based on labels & match expression

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specifies the resources included during backup

ExcludedResources specifies the resources excluded during backup

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

ObjectStoreCredentials

ObjectStoreCredentials defines the credentials to use Object Store as a target type.

Field
Description

url string

URL to connect the Object Store.

accessKey string

AccessKey is to authenticate access to Object Store. Deprecated: after addition of secret object ref

secretKey string

SecretKey is to authenticate access to Object Store. Deprecated: after addition of secret object ref

CredentialSecret is object ref of a secret which contains target credentials like accessKey, secretKey, etc.

bucketName string

BucketName is the name of a bucket within Object Store.

region string

Region where the Object Store resides.

objectLockingEnabled bool

ObjectLockingEnabled specify if target is set to be immutable

skipCertVerification bool

SkipCertVerification specify if target needs to be accessed without certificate verification and usage.

Op (string alias)

Op indicates the Json Patch operations

OperationType (string alias)

OperationType specifies the type of operation for Job

Operator

Operator defines the snapshot of application defined by an Operator.

Field
Description

operatorId string

OperatorId is unique ID for a particular operator

CustomResources is the list of all custom resource’s GVK and names list

Helm represents the snapshot of the helm chart for helm based operator

OperatorResources defines the a kubernetes resources found from Operator resources.

ApplicationResources defines the kubernetes resources found from operator Custom Resources.

DataSnapshot specifies the Snapshot of the Volumes defined in the operator resources.

warnings []string

Warnings is the list of warnings captured during backup or restore of an application

OperatorSelector

OperatorSelector defines the mapping of operator name and their selectors

Field
Description

operatorId string

OperatorId is any unique ID for a particular operator

CustomResources list resources where each resource contains custom resource gvk and metadata

helmRelease string

HelmRelease is the release name of the helm based operator

olmSubscription string

OLMSubscription is the subscription name for the olm based operator

Deprecated: OperatorResourceSelector is the selector for operator resources

OperatorResources specify operator resource selection based on LabelSelector & GVKSelector

Deprecated: ApplicationResourceSelector is the selector for instances deployed by the operator resources

ApplicationResources specify resource selection for instances deployed by the operator resources based on LabelSelector & GVKSelector.

ExcludeResources specify operator resources to exclude from backup based on LabelSelector & GVKSelector

Owner

Field
Description

GroupVersionKind specifies GVK uniquely representing particular owner type.

name string

Name is name of owner

Patch

Field
Description

Op specifies the operation to perform, can be test/add/remove/replace/copy/move

from string

From specifies the source element path. This field is mandatory for copy/move operation

path string

Path specifies the destination element path which needs to be transformed

value Kubernetes apiextensions/v1.JSON

Values specifies the value for any operation. This field is mandatory for test/add/replace operation

PodContainers

PodContainers defines Pod and containers running in that Pod.

Field
Description

podName string

PodName is the name of pod which will be the key for the map between pod containers list

containers []string

Containers is the list of containers inside a pod

PodHookStatus

PodHookStatus defines observed state for hooks

Field
Description

podName string

PodName is the single pod name from identified sets of pods filtered for hook config.

ContainerHookStatus defines status for filtered containers in a pod named ‘PodName’ One Container can have multiple hook executions.

PodSelector

PodSelector selects pods for hook execution based on either Labels or Regex pattern. Both Labels & Regex can also specify

Field
Description

regex string

Policy

Policy is the Schema for the policies API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

PolicySpec

PolicySpec defines the desired state of Policy

Field
Description

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

PolicyStatus

PolicyStatus defines the observed state of Policy

PolicyType (string alias)

PolicyType is the Enum for types of policies

PrePostHookStatus

PrePostHookStatus defines Pre and Post hook execution status.

Field
Description

Status is the status for pre/post hook execution

exitStatus string

ExitStatus contains returned exit code and error trace after pre/post hook execution

retryCount byte

RetryCount count used to retry hook execution within the time range specified by Timeout. This is the actual number of times backup controller retried for pre/post hook execution if MaxRetryCount>0. Default is 0

Report

Report specifies counts of different level of Vulnerabilities

Field
Description

low int

medium int

high int

critical int

total int

Resource

Resource defines the list of names of a Kubernetes resource of a particular GVK.

Field
Description

GroupVersionKind specifies GVK uniquely representing particular resource type.

objects []string

Objects is the list of names of all the objects of the captured GVK

ResourceSelector

ResourceSelector used to define include/exclude resources as well as other resource selection, resource selection can be done using LabelSelector(MatchLabels & MatchExpression) & GVKSelector(GVK based & object names).

Field
Description

LabelSelector specifies resource selection using labels & match expression

GVKSelector specify resource selection using GVK & object name based selection Default ignore list won’t be considered for these resources and will always be backed up whatever is specified

Restore

Restore is the Schema for the restores API

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

RestoreApplication

RestoreApplication defines the snapshot contents of an Application Backup.

Field
Description

HelmCharts specifies the backed up helm resources restored as Helm Charts.

Operators specifies the backed up operator resources restored as Operators.

Custom specifies the backup up kubernetes resources.

Image specifies the backed up container images to be restored

RestoreCondition

RestoreCondition specifies the current condition of a restore resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

RestoreConfig

Field
Description

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

RestoreCustom

RestoreCustom defines the backed up kubernetes resources.

Field
Description

Snapshot defines the snapshot of custom application to be restored.

Status specifies the details of component restore in a namespace

RestoreFlags

Field
Description

useOCPNamespaceUIDRange bool

UseOCPNamespaceUIDRange specifies whether to restore the original uid or use the SCC UID range defined on OCP namespaces on the application data.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored.

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored.

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd.

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them.

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored)

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored

onlyData bool

OnlyData flag decides if the restore operation will only restore data components.

onlyMetadata bool

OnlyMetadata flag decides if the restore operation will only restore metadata components.

overrideImageIfExist bool

OverrideImageIfExist overrides existing image from the backup image if it is already present.

RestoreHelm

RestoreHelm defines the backed up helm application to be restored.

Field
Description

Snapshot defines the snapshot of application to be restored by a Helm.

Status specifies the details of component restore in a namespace

RestoreImage

RestoreImage defines the backup container images to be restored.

Field
Description

ImageSnapshot are the images which are restored from the backup.

RestoreOperator

RestoreOperator defines the backed up operator application to be restored.

Field
Description

Snapshot defines the snapshot of application to be restored by a Operator.

Status specifies the details of component restore in a namespace

RestorePhase (string alias)

nolint:lll // too long line RestorePhase specifies the one of phase of Restore operation

RestoreSource

RestoreSource defines the source from where the restore is to be done

Field
Description

Type is the type of source for restore

Backup is a reference to the Backup instance restored if type is Backup.

Target is a reference to the Target instance where from restore is performed if type is Location.

location string

Location is an absolute path to remote target from where restore is performed if type is Location.

BackupPlan is a reference to the BackupPlan whose latest successful backup is to be restored.

ConsistentSet is a reference to the ConsistentSet where restore is performed if type is ConsistentSet.

RestoreSourceType (string alias)

RestoreSourceType defines the type of source for restore

RestoreSpec

RestoreSpec defines the desired state of Restore

Field
Description

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

RestoreStats

RestoreStats defines the stats for a Restore

Field
Description

BackupPlan is the reference to BackupPlan associated with Restore

Backup is the reference to the Backup associated with Restore

RestoreStatus

RestoreStatus defines the observed state of Restore

Field
Description

RestoreScope indicates scope of component being restored i.e. App or Namespace.

ApplicationType is the type of Application restored in the App Scoped backup

StartTimestamp is the time a restore was started.

CompletionTimestamp is the time a restore was finished.

Phase is the current phase of the restore operation.

PhaseStatus is the status of phase restore operation going through.

Status is the status of the restore operation.

Size is the aggregate size of the data restored back.

percentageCompletion byte

PercentageCompletion is the amount of restore operation completed.

RestoreApplication defines the information about the different applications restored back to cluster.

HookStatus specifies pre/post hook execution status for current backup.

Condition is the current condition of restore resource.

Duration is the amount of time the restore process took to finish.

ProtectingResources lists the Trilio resources and dependent resources which are getting created after user application restore operation. It’s applicable only if ProtectRestoredApp is set to true.

encryptionEnabled bool

EncryptionEnabled flag shows that meta and data encryption is enabled.

RestoreSummary

RestoreSummary comprises of restore object references and count of restore with different statuses

Field
Description

LatestRestore is the reference to Latest Restore in any state, of a BackupPlan

LastSuccessfulRestore is the reference to Latest completed Restore of a BackupPlan

totalInProgressRestores uint32

TotalInProgressRestores is the count of total number of InProgress Restores

totalCompletedRestores uint32

TotalCompletedRestores is the count of total number of Completed Restores

totalFailedRestores uint32

TotalFailedRestores is the count of total number of Failed Restores

RetentionConfig

RetentionConfig is the configuration for the PolicyType: Retention

Field
Description

latest int

Latest is the max number of latest backups to be retained

weekly int

Weekly is max number of backups to be retained in a week

monthly int

Monthly is max number of backups to be retained in a month

yearly int

Yearly is max number of backups to be retained in a year

DayOfWeek is Day of the week to maintain weekly backup/restore resources

dateOfMonth int

DateOfMonth is Date of the month to maintain monthly backup/restore resources

MonthOfYear is the month of the backup to retain for yearly backups

ScanInstance

ScanInstance specifies the info about Security ScanInstance and its related report summary

Field
Description

scanInstanceName string

ScanInstanceName is the name of the ScanInstance triggered on the Security site

ScanTimestamp is the time stamp when scanning completed/failed

BackupScanInfo defines the scanning report for Backup or each Backup of a ClusterBackup It is the mapping of Backup-uuid and corresponding Scanning report

reportPath string

ReportPath is the location of Scanning report on the target

ScannerStatus

Field
Description

totalScans int

TotalScans denotes the total number of scans done for each type

scansPassed int

ScansPassed denotes the number of scans passed out of TotalScans

Status is the status of the condition.

ReportSummary is the summary of vulnerabilities detected in the Security scanning

SchedulePolicy

SchedulePolicy contains the object references for incremental or full backup type schedule policy

Field
Description

IncrementalCron is the cronspec schedule for incremental backups Deprecated: IncrementalCron will be used as an object reference of schedule type policy.

FullBackupCron is the cronspec schedule for full backups Deprecated: FullBackupCron will be used as an object reference of schedule type policy.

IncrementalBackupPolicy is the object reference for the policy of type schedule defined

FullBackupPolicy is the object reference for the policy of type schedule defined

Scope (string alias)

Scope specifies the scope of a resource.

SecurityScanConfig

Field
Description

schedule []string

Schedule is the cron schedules for periodic scanning of Backups/ClusterBackups

retention int

Retention is the number of Security Scan reports to be retained for each Backup

SecurityScanConfigInfo

SecurityScanConfigInfo defines the Security Scan instances info which will be used for Backup/ClusterBackup scanning

Field
Description

SecurityServiceInstances defines the list of Security instances which will perform the Backup/ClusterBackup Security scanning

SecurityScanStatus

SecurityScanStatus specifies the details of Security scan status of an instance

Field
Description

securityEnabled bool

SecurityEnabled denotes if the Security service is actually enabled on the Security site

ServiceStatus is the current Status of Security service Available/Unavailable. It is updated as per the heartbeat of Security service

LastScanTimestamp is the time stamp of the last scan performed on this BackupPlan/ClusterBackupPlan

LastSuccessfulScanScanTimestamp is the time of the last successful scan performed this BackupPlan/ClusterBackupPlan

scanPlan string

ScanPlan denotes the name of ScanPlan created for this BackupPlan/ClusterBackupPlan on the Security site

SecurityScanStatusInfo

Field
Description

ScanInstances defines the list of latest 3 Security ScanInstances which were triggered for a Backup/ClusterBackup Security scanning

SecurityServiceInstance

SecurityServiceInstance defines details of Security Scan for InstanceID specified

Field
Description

instanceID string

InstanceID is the unique Instance ID of the Security Service to be used for Security Scanning

SecurityScanPolicy is the object reference to the Security Scan Policy to be used for scanning

scanAllBackups bool

ScanAllBackups enables Security Scan on all Backups/ClusterBackups of BackupPlan/ClusterBackupPlan (old and new)

Snapshot

Snapshot defines the snapshot contents of an Application Backup.

Field
Description

HelmCharts specifies the snapshot of application defined by Helm Charts.

Operators specifies the snapshot of application defined by Operators.

Custom specifies the snapshot of Custom defined applications.

Image specifies the snapshot of the all application’s container images.

SnapshotInfo

Field
Description

VolumeSnapshotSourcePVC is the objectReference of the temporary PersistentVolumeClaim used for creating VolumeSnapshot

prePopulated bool

PrePopulated field is a bool field which denotes if the PersistentVolumeClaim used is already populated with data or not

Size is the size of the actual data restored in the PVC.

VolumeSnapshot specifies the CSI snapshot of a Persistent Volume.

path string

Path is the qcow2 path for the PersistentVolume data on the target

Conditions are the current statuses of restore PVCs.

SnapshotSize is the size of the volume snapshot of a Persistent Volume.

SourceBackupInfo

Field
Description

backupName string

BackupName is the name of source Backup

backupNamespace string

BackupNamespace is the namespace of source Backup

CompletionTimestamp is the time a backup was finished.

location string

Location is the path of Backup on the target

TotalSize is the total size of data restored done for the Backup

PVCSnapshotInfo is the mapping of source original PersistentVolumeClaim name, and it’s corresponding Snapshot info

TransformStatus is the status of transformation performed

Status is the current Status of Backup data restore operation

SourceBackupPlan

Field
Description

kind string

name string

namespace string

SourceInstanceInfo

Field
Description

name string

id string

Status (string alias)

Status specifies the status of WorkloadJob operating on

Target

Target is a location where Trilio stores backup.

Field
Description

Refer to the Kubernetes API documentation for the fields of the metadata field.

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

TargetCondition

TargetCondition specifies the current condition of a target resource.

Field
Description

Status is the status of the condition.

Timestamp is the time a condition occurred.

reason string

A brief message indicating details about why the component is in this condition.

Phase defines the current phase of the controller.

TargetInfo

TargetInfo contains minimal information about target populated in backup stats

Field
Description

Target is the reference to a Target backuped up

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

TargetSpec

TargetSpec defines the specification of a Target.

Field
Description

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

TargetStats

TargetStats defines the stats for a Target

Field
Description

totalBackupPlans uint32

TotalBackupPlans is the count of total number of BackupPlans of a Target

CapacityOccupied is the aggregate of total size occupied on the Target by Backups

TargetStatus

TargetStatus defines the observed state of Target

Field
Description

Condition is the current condition of a target.

Status is the final Status of target Available/Unavailable

browsingEnabled bool

BrowsingEnabled specifies if target browser feature is enabled for this target or not

NFSPersistentVolume is the object reference to the PersistentVolume of NFS volume type with target NFS credentials

NFSPersistentVolumeClaim is the object reference to the PersistentVolumeClaim bound to NFS volume attached to the Container

defaultRetentionPeriod uint16

DefaultRetentionPeriod is the period set by default on the target This value will always be in number of days

eventTargetEnabled bool

EventTargetEnabled specifies if target is configured as Event target or not

availableContinuousRestoreInstances map[string]string

AvailableContinuousRestoreInstances is the map of instance IDs to instance names which are available to be used as ContinuousRestore site

availableSecurityInstances map[string]string

AvailableSecurityInstances is the map of instance IDs to instance names which are available to be used as SecurityScanning site

TargetType (string alias)

TargetType is the type of target.

TimeoutConfig

TimeoutConfig is the configuration for the PolicyType: Timeout

TransformComponents

TransformComponents specifies component wise transformation configuration

Field
Description

HelmTransform specifies the Transformation configuration for Helm charts

CustomTransform specifies the Transformation configuration for Custom label-based backup

TransformStatus

TransformStatus specifies the details of transform operation

Field
Description

transformName string

TransformName is the name of transformation

Status is the status of transform operation

TransformedResources Specifies the resources transformed as part of transformation

reason string

Reason is reason for status in case of failure

Errors is the reason for transformation failure.

TransformationError

TransformationError defines the set of errors against names of a Kubernetes resource of a particular GVK.

Field
Description

GroupVersionKind specifies GVK uniquely representing particular resource type.

objects map[string]string

Objects is the map of errors against an object name

Vendor (string alias)

Vendor is the third party storage vendor hosting the target

nolint:lll // directive continuation

VolumeSnapshot

VolumeSnapshot defines the CSI snapshot of a Persistent Volume.

Field
Description

VolumeSnapshot is a reference to the Persistent Volume Snapshot captured.

retryCount byte

RetryCount is the number of attempts made to capture Volume Snapshot.

Status is the status defining the progress of Volume Snapshot capture.

error string

Error is the error occurred while capturing Volume Snapshot if any.

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

metadata

spec

type

backupPlan

type

backupPlan

type

backupPlan

type

backupPlan

status

(Appears on: , )

hookConfig

includeResources

excludeResources

BackupComponent

PartOf

(Appears on: )

status

timestamp

phase

(Appears on: )

target

retentionPolicy

schedulePolicy

(Appears on: )

backup

status

metadata

spec

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

status

(Appears on: )

operators

custom

customSelector

(Appears on: )

status

timestamp

phase

(Appears on: , )

(Appears on: )

backupPlan

partOf

status

(Appears on: , )

(Appears on: )

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

(Appears on: )

backupSummary

restoreSummary

(Appears on: )

condition

status

scope

applicationType

incrementalCron

fullBackupCron

incrementalCrons

fullBackupCrons

stats

securityScanStatus

continuousRestoreStatus

(Appears on: )

metadataScannerStatus

dataScannerStatus

imageScannerStatus

(Appears on: )

type

backupPlan

(Appears on: )

target

targetInfo

latestInProgressRestore

latestCompletedRestore

encryption

(Appears on: )

backupScope

applicationType

type

startTimestamp

completionTimestamp

phase

phaseStatus

status

size

expirationTimestamp

snapshot

condition

hookStatus

stats

securityScanStatus

consistentSetStatus

duration

(Appears on: )

inProgressBackup

lastSuccessfulBackup

latestBackup

(Appears on: , , , , , )

(Appears on: )

metadata

spec

type

clusterBackupPlan

type

clusterBackupPlan

type

clusterBackupPlan

type

clusterBackupPlan

status

(Appears on: )

phase

status

timestamp

(Appears on: )

target

retentionPolicy

schedulePolicy

metadata

spec

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

status

(Appears on: )

status

timestamp

phase

phase

phase

phase

(Appears on: )

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

(Appears on: )

clusterBackupSummary

clusterRestoreSummary

(Appears on: )

status

backupPlans

incrementalCrons

fullBackupCrons

condition

stats

securityScanStatus

continuousRestoreStatus

(Appears on: )

incrementalBackupPolicy

fullBackupPolicy

(Appears on: )

type

clusterBackupPlan

(Appears on: )

target

targetInfo

latestInProgressClusterRestore

lastCompletedClusterRestore

encryption

(Appears on: )

type

startTimestamp

completionTimestamp

status

size

expirationTimestamp

condition

duration

backupInfos

stats

securityScanStatus

consistentSetStatus

(Appears on: )

inProgressClusterBackup

lastSuccessfulClusterBackup

latestClusterBackup

metadata

spec

source

globalConfig

components

actionFlags

encryption

imageRegistry

source

globalConfig

components

actionFlags

encryption

imageRegistry

source

globalConfig

components

actionFlags

encryption

imageRegistry

source

globalConfig

components

actionFlags

encryption

imageRegistry

status

(Appears on: )

phase

status

timestamp

(Appears on: )

type

clusterBackup

target

clusterBackupPlan

consistentSet

(Appears on: )

(Appears on: )

source

globalConfig

components

actionFlags

encryption

imageRegistry

(Appears on: )

clusterBackupPlan

clusterBackup

(Appears on: )

startTimestamp

completionTimestamp

phase

phaseStatus

status

size

condition

duration

components

stats

protectingResources

(Appears on: )

lastSuccessfulClusterRestore

latestClusterRestore

(Appears on: )

restoreConfig

hookConfig

(Appears on: )

backup

restore

restoreStatus

(Appears on: , , )

(Appears on: , , )

existingResource

skippedResources

failedResources

newResourcesAdded

excludedResources

failedCleanupResources

transformStatus

phase

phaseStatus

(Appears on: , )

status

timestamp

phase

metadata

spec

continuousRestorePlan

transformComponents

continuousRestorePlan

transformComponents

continuousRestorePlan

transformComponents

continuousRestorePlan

transformComponents

status

(Appears on: )

phase

status

timestamp

(Appears on: , , )

consistentSetStatus

consistentSetCreationTimeStamp

consistentSetCompletionTimeStamp

size

(Appears on: )

(Appears on: )

continuousRestorePlan

transformComponents

(Appears on: )

sourceBackupPlan

sourceInstanceInfo

(Appears on: )

status

scope

startTimestamp

completionTimestamp

backupInfo

size

phase

phaseStatus

condition

duration

stats

(Appears on: )

preHookStatus

postHookStatus

(Appears on: )

imagePullSecrets

(Appears on: )

(Appears on: , )

continuousRestoreInstances

(Appears on: )

continuousRestorePolicy

transformComponents

metadata

spec

continuousRestorePolicy

target

transformComponents

continuousRestorePolicy

target

transformComponents

continuousRestorePolicy

target

transformComponents

continuousRestorePolicy

target

transformComponents

status

(Appears on: )

status

timestamp

phase

(Appears on: )

continuousRestorePolicy

target

transformComponents

(Appears on: )

condition

status

consistentSetInfo

(Appears on: , )

continuousRestoreSiteStatus

lastConsistentSetCreationTimestamp

lastSuccessfulConsistentSetTimestamp

(Appears on: )

(Appears on: )

(Appears on: , )

resources

dataSnapshots

(Appears on: )

selectResources

excludeResources

(Appears on: )

resources

jsonPatches

(Appears on: , , )

backupType

volumeSnapshot

pvSize

snapshotSize

size

podContainersMap

conditions

(Appears on: )

(Appears on: , , , , , )

encryptionSecret

(Appears on: )

groupVersionKind

(Appears on: , , , )

(Appears on: , , )

resource

resources

storageBackend

version

dataSnapshots

(Appears on: )

(Appears on: )

set

(Appears on: )

metadata

spec

pre

post

pre

post

pre

post

pre

post

status

(Appears on: , )

hookPriorityStatus

(Appears on: , , , , )

mode

hooks

(Appears on: )

(Appears on: )

execAction

(Appears on: )

hook

podSelector

(Appears on: )

hook

preHookConf

postHookConf

hookTarget

(Appears on: )

hooks

(Appears on: )

pre

post

(Appears on: )

(Appears on: )

owner

podHookStatus

(Appears on: )

imageSnapshot

(Appears on: )

referencedBy

imagePullSecrets

(Appears on: , )

registryAuthSecret

(Appears on: , )

backupType

size

containerImages

(Appears on: )

metadata

spec

status

(Appears on: )

status

timestamp

phase

(Appears on: )

(Appears on: )

edition

creationTimestamp

purchaseTimestamp

expirationTimestamp

maintenanceExpiryTimestamp

scope

(Appears on: )

(Appears on: , )

(Appears on: )

status

properties

condition

gracePeriodStartTimestamp

gracePeriodEndTimestamp

(Appears on: )

(Appears on: )

status

timestamp

(Appears on: )

(Appears on: )

labelSelector

hookConfig

includeResources

excludeResources

(Appears on: )

credentialSecret

(Appears on: )

(Appears on: , , , , , , , , , , , , )

(Appears on: , )

customResources

helm

operatorResources

applicationResources

dataSnapshots

(Appears on: )

customResources

operatorResourceSelector

operatorResources

applicationResourceSelector

applicationResources

excludeResources

(Appears on: )

groupVersionKind

(Appears on: )

op

(Appears on: )

(Appears on: )

containerHookStatus

(Appears on: )

labels

metadata

spec

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

status

(Appears on: )

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

(Appears on: )

(Appears on: )

(Appears on: )

status

(Appears on: )

(Appears on: , , , , , , , , , , , )

groupVersionKind

(Appears on: , , , , , )

labelSelector

gvkSelector

metadata

spec

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

status

(Appears on: )

helmCharts

operators

custom

image

(Appears on: )

status

timestamp

phase

(Appears on: , )

restoreFlags

transformComponents

excludeResources

(Appears on: )

snapshot

status

(Appears on: , )

(Appears on: )

snapshot

status

(Appears on: )

imageSnapshot

(Appears on: )

snapshot

status

(Appears on: , , )

(Appears on: )

type

backup

target

backupPlan

consistentSet

(Appears on: )

(Appears on: )

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

(Appears on: )

backupPlan

backup

(Appears on: )

restoreScope

applicationType

startTimestamp

completionTimestamp

phase

phaseStatus

status

size

restoreApplication

hookStatus

condition

stats

duration

protectingResources

(Appears on: )

latestRestore

lastSuccessfulRestore

(Appears on: )

dayOfWeek

monthOfYear

(Appears on: )

scanTimestamp

backupScanInfo

(Appears on: )

status

reportSummary

(Appears on: )

incrementalCron

fullBackupCron

incrementalBackupPolicy

fullBackupPolicy

(Appears on: )

(Appears on: )

(Appears on: , )

securityServiceInstances

(Appears on: , )

serviceStatus

lastScanTimestamp

lastSuccessfulScanScanTimestamp

(Appears on: , )

scanInstances

(Appears on: )

securityScanPolicy

(Appears on: )

helmCharts

operators

custom

image

(Appears on: )

volumeSnapshotSourcePVC

size

volumeSnapshot

conditions

snapshotSize

(Appears on: )

completionTimestamp

size

pvcSnapshotInfo

transformStatus

status

(Appears on: )

(Appears on: )

(Appears on: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , )

metadata

spec

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

status

(Appears on: )

status

timestamp

phase

(Appears on: , )

target

type

vendor

(Appears on: )

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

(Appears on: )

capacityOccupied

applicationCapacity

applicationCapacityConsumed

(Appears on: )

condition

status

stats

nfsPersistentVolume

nfsPersistentVolumeClaim

(Appears on: , )

(Appears on: )

(Appears on: , , , , )

helm

custom

(Appears on: , )

status

transformedResources

-

(Appears on: )

groupVersionKind

(Appears on: , )

(Appears on: , )

volumeSnapshot

status

key string

Key is the product key to use triliovault application to perform backup/restore.

triliovault.trilio.io/v1
ClusterRestoreSpec
RestoreSpec
BackupPlanStatus
BackupStatus
RestoreStatus
BackupComponentInfo
ClusterBackupPlanSpec
BackupStatus
BackupPlanSpec
ClusterBackupStatus
BackupPlanSpec
BackupPlanStatus
BackupPlanSpec
ClusterBackupPlanSpec
ClusterBackupPlanStatus
BackupComponentInfo
BackupPlanInfo
BackupPlan
BackupPlanStatus
BackupPlan
ScanInstance
Backup
BackupStatus
Backup
BackupPlanStats
BackupSpec
BackupStatus
ClusterBackupSpec
ClusterBackupStatus
DataSnapshot
ImageSnapshot
PolicySpec
ClusterBackupStatus
ClusterBackupPlanSpec
ClusterBackupPlanStatus
ClusterBackupPlan
ClusterBackupPlanStatus
ClusterBackupPlan
ClusterBackupConfig
ClusterBackup
ClusterBackupStatus
ClusterBackup
ClusterBackupPlanStats
ClusterRestoreStatus
ClusterRestoreSpec
ClusterRestoreSource
ClusterRestore
ClusterRestoreStatus
ClusterRestore
ClusterBackupPlanStats
ClusterRestoreSpec
ClusterRestoreStatus
BackupPlanStatus
BackupStatus
RestoreStatus
RestoreCustom
RestoreHelm
RestoreOperator
DataSnapshot
SnapshotInfo
ConsistentSetStatus
BackupStatus
ClusterBackupStatus
ContinuousRestorePlanStatus
ConsistentSetStatus
ConsistentSet
ConsistentSetStatus
ConsistentSet
PodHookStatus
ImageSnapshot
PolicySpec
BackupPlanSpec
ClusterBackupPlanSpec
ContinuousRestoreConfigInfo
ContinuousRestorePlanStatus
ContinuousRestorePlan
ContinuousRestorePlan
BackupPlanStatus
ClusterBackupPlanStatus
SchedulePolicy
PolicySpec
RestoreCustom
Snapshot
BackupPlanComponents
TransformComponents
Custom
Helm
Operator
RetentionConfig
BackupPlanSpec
BackupStats
ClusterBackupPlanSpec
ClusterBackupStats
ClusterRestoreSpec
RestoreSpec
ImagePullSecret
GVKR
Owner
Resource
TransformationError
Operator
RestoreHelm
Snapshot
Helm
TransformComponents
Helm
BackupStatus
RestoreStatus
BackupComponent
BackupPlanSpec
ComponentConfig
NamespaceSelector
RestoreSpec
HookPriority
HookSpec
HookConfig
HookPriorityStatus
HookComponentStatus
Hook
Hook
HookPriority
Snapshot
ContainerImage
ClusterRestoreSpec
RestoreSpec
Image
RestoreImage
HelmTransform
LicenseStatus
LicenseProperties
LicenseStatus
License
LicenseCondition
LicenseStatus
License
HookConfig
RetentionConfig
TargetSpec
ClusterBackupPlanSpec
TargetSpec
Patch
BackupCondition
BackupPlanCondition
BackupStatus
ClusterBackupCondition
ClusterBackupPlanCondition
ClusterRestoreCondition
ClusterRestoreStatus
Conditions
ConsistentSetCondition
ConsistentSetStatus
ContinuousRestorePlanCondition
LicenseCondition
TargetCondition
RestoreOperator
Snapshot
BackupPlanComponents
HookTarget
CustomTransform
DataSnapshot
HookTarget
HookInfo
Policy
Policy
PolicySpec
ContainerHookStatus
ScannerStatus
ClusterRestoreStatus
ComponentStatus
Custom
CustomTransform
Helm
Operator
OperatorSelector
ResourceSelector
RestoreConfig
RestoreSpec
RestoreStatus
TransformStatus
BackupComponent
BackupPlanSpec
ClusterBackupPlanSpec
CustomSelector
NamespaceSelector
OperatorSelector
RestoreStatus
RestoreStatus
ClusterRestoreSpec
ComponentConfig
RestoreApplication
RestoreConfig
RestoreSpec
RestoreApplication
RestoreApplication
RestoreApplication
ComponentStatus
RestoreCondition
RestoreStatus
RestoreSpec
RestoreSource
Restore
RestoreStatus
Restore
BackupPlanStats
PolicySpec
SecurityScanStatusInfo
BackupScanInfo
BackupConfig
LicenseProperties
PolicySpec
BackupPlanSpec
ClusterBackupPlanSpec
BackupPlanStatus
ClusterBackupPlanStatus
BackupStatus
ClusterBackupStatus
SecurityScanConfigInfo
BackupStatus
SourceBackupInfo
ConsistentSetStatus
ConsistentSetStats
ConsistentSetStats
BackupCondition
BackupInfo
BackupPlanCondition
BackupPlanInfo
BackupPlanStatus
BackupStatus
ClusterBackupCondition
ClusterBackupPlanCondition
ClusterBackupPlanStatus
ClusterBackupStatus
ClusterRestoreCondition
ClusterRestoreStatus
ComponentInfo
ComponentStatus
Conditions
ConsistentSetCondition
ConsistentSetInfo
ConsistentSetStatus
ContinuousRestorePlanCondition
ContinuousRestorePlanStatus
ContinuousRestoreStatus
MultiNamespaceCondition
PrePostHookStatus
RestoreCondition
RestoreStatus
ScannerStatus
SecurityScanStatus
SourceBackupInfo
TargetCondition
TargetStatus
TransformStatus
VolumeSnapshot
TargetStatus
BackupStats
ClusterBackupStats
Target
TargetStatus
Target
TargetInfo
TargetSpec
PolicySpec
ConsistentSetSpec
ContinuousRestoreInstance
ContinuousRestorePlanSpec
RestoreConfig
RestoreSpec
ComponentStatus
SourceBackupInfo
TransformStatus
TargetInfo
TargetSpec
DataSnapshot
SnapshotInfo
Kubernetes meta/v1.ObjectMeta
BackupSpec
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
BackupStatus
HookConfig
ResourceSelector
ResourceSelector
BackupComponent
BackupPlanSelector
Status
Kubernetes meta/v1.Time
OperationType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
SchedulePolicy
Kubernetes core/v1.ObjectReference
Status
Kubernetes meta/v1.ObjectMeta
BackupPlanSpec
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupPlanStatus
[]OperatorSelector
[]Kubernetes meta/v1.LabelSelector
CustomSelector
Status
Kubernetes meta/v1.Time
OperationType
Kubernetes core/v1.ObjectReference
BackupPlanSelector
Status
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupSummary
RestoreSummary
[]BackupPlanCondition
Status
ComponentScope
ApplicationType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
map[string]k8s.io/api/core/v1.ObjectReference
map[string]k8s.io/api/core/v1.ObjectReference
BackupPlanStats
map[string]github.com/trilioData/k8s-triliovault/api/v1.SecurityScanStatus
map[string]github.com/trilioData/k8s-triliovault/api/v1.ContinuousRestoreStatus
map[string]github.com/trilioData/k8s-triliovault/api/v1.ScannerStatus
map[string]github.com/trilioData/k8s-triliovault/api/v1.ScannerStatus
map[string]github.com/trilioData/k8s-triliovault/api/v1.ScannerStatus
BackupType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TargetInfo
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Encryption
ComponentScope
ApplicationType
BackupType
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
OperationType
Status
Status
k8s.io/apimachinery/pkg/api/resource.Quantity
Kubernetes meta/v1.Time
Snapshot
[]BackupCondition
HookComponentStatus
BackupStats
map[string]github.com/trilioData/k8s-triliovault/api/v1.SecurityScanStatusInfo
map[string]github.com/trilioData/k8s-triliovault/api/v1.ConsistentSetInfo
Kubernetes meta/v1.Duration
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes meta/v1.ObjectMeta
ClusterBackupSpec
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
ClusterBackupStatus
OperationType
Status
Kubernetes meta/v1.Time
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
ClusterBackupSchedulePolicy
Kubernetes meta/v1.ObjectMeta
ClusterBackupPlanSpec
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
ClusterBackupPlanStatus
Status
Kubernetes meta/v1.Time
OperationType
OperationType
OperationType
OperationType
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
ClusterBackupSummary
ClusterRestoreSummary
Status
map[string]github.com/trilioData/k8s-triliovault/api/v1.BackupPlanInfo
map[string]k8s.io/api/core/v1.ObjectReference
map[string]k8s.io/api/core/v1.ObjectReference
[]ClusterBackupPlanCondition
ClusterBackupPlanStats
map[string]github.com/trilioData/k8s-triliovault/api/v1.SecurityScanStatus
map[string]github.com/trilioData/k8s-triliovault/api/v1.ContinuousRestoreStatus
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
BackupType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TargetInfo
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Encryption
BackupType
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
Status
k8s.io/apimachinery/pkg/api/resource.Quantity
Kubernetes meta/v1.Time
[]ClusterBackupCondition
Kubernetes meta/v1.Duration
map[string]github.com/trilioData/k8s-triliovault/api/v1.BackupInfo
ClusterBackupStats
map[string]github.com/trilioData/k8s-triliovault/api/v1.SecurityScanStatusInfo
map[string]github.com/trilioData/k8s-triliovault/api/v1.ConsistentSetInfo
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes meta/v1.ObjectMeta
ClusterRestoreSpec
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
ClusterRestoreStatus
OperationType
Status
Kubernetes meta/v1.Time
ClusterRestoreSourceType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
OperationType
Status
Status
k8s.io/apimachinery/pkg/api/resource.Quantity
[]ClusterRestoreCondition
Kubernetes meta/v1.Duration
map[string]github.com/trilioData/k8s-triliovault/api/v1.ComponentInfo
ClusterRestoreStats
[]Resource
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
RestoreConfig
HookConfig
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Status
[]Resource
[]Resource
[]Resource
[]Resource
[]Resource
[]Resource
[]TransformStatus
RestorePhase
Status
Status
Kubernetes meta/v1.Time
OperationType
Kubernetes meta/v1.ObjectMeta
ConsistentSetSpec
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
TransformComponents
ConsistentSetStatus
OperationType
Status
Kubernetes meta/v1.Time
Status
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
k8s.io/apimachinery/pkg/api/resource.Quantity
Kubernetes core/v1.ObjectReference
TransformComponents
SourceBackupPlan
SourceInstanceInfo
Status
ConsistentSetScope
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
map[string]github.com/trilioData/k8s-triliovault/api/v1.SourceBackupInfo
k8s.io/apimachinery/pkg/api/resource.Quantity
OperationType
Status
[]ConsistentSetCondition
Kubernetes meta/v1.Duration
ConsistentSetStats
PrePostHookStatus
PrePostHookStatus
[]ImagePullSecret
[]ContinuousRestoreInstance
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes meta/v1.ObjectMeta
ContinuousRestorePlanSpec
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
ContinuousRestorePlanStatus
Status
Kubernetes meta/v1.Time
OperationType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
[]ContinuousRestorePlanCondition
Status
[]ConsistentSetInfo
Status
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
[]Resource
[]DataSnapshot
ResourceSelector
ResourceSelector
Resource
[]Patch
BackupType
VolumeSnapshot
k8s.io/apimachinery/pkg/api/resource.Quantity
k8s.io/apimachinery/pkg/api/resource.Quantity
k8s.io/apimachinery/pkg/api/resource.Quantity
[]PodContainers
[]Conditions
Kubernetes core/v1.ObjectReference
GroupVersionKind
Resource
[]Resource
HelmStorageBackend
HelmVersion
[]DataSnapshot
[]KeyValue
Kubernetes meta/v1.ObjectMeta
HookSpec
HookExecution
HookExecution
HookExecution
HookExecution
HookExecution
HookExecution
HookExecution
HookExecution
HookStatus
[]HookPriorityStatus
Mode
[]HookInfo
Kubernetes core/v1.ExecAction
Kubernetes core/v1.ObjectReference
PodSelector
Kubernetes core/v1.ObjectReference
HookConfiguration
HookConfiguration
[]HookTarget
[]HookPriority
HookExecution
HookExecution
Owner
[]PodHookStatus
ImageSnapshot
GVKR
[]*k8s.io/api/core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
BackupType
k8s.io/apimachinery/pkg/api/resource.Quantity
[]ContainerImage
Kubernetes meta/v1.ObjectMeta
LicenseSpec
LicenseStatus
LicenseState
Kubernetes meta/v1.Time
OperationType
LicenseEdition
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
Scope
LicenseState
LicenseProperties
[]LicenseCondition
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
Status
Kubernetes meta/v1.Time
[]Kubernetes meta/v1.LabelSelector
HookConfig
ResourceSelector
ResourceSelector
Kubernetes core/v1.ObjectReference
[]Resource
Helm
[]Resource
[]Resource
[]DataSnapshot
[]Resource
[]Kubernetes meta/v1.LabelSelector
ResourceSelector
[]Kubernetes meta/v1.LabelSelector
ResourceSelector
ResourceSelector
GroupVersionKind
Op
[]ContainerHookStatus
[]Kubernetes meta/v1.LabelSelector
Kubernetes meta/v1.ObjectMeta
PolicySpec
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
PolicyStatus
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
Status
GroupVersionKind
[]Kubernetes meta/v1.LabelSelector
[]Resource
Kubernetes meta/v1.ObjectMeta
RestoreSpec
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
RestoreStatus
[]RestoreHelm
[]RestoreOperator
RestoreCustom
RestoreImage
Status
Kubernetes meta/v1.Time
RestorePhase
RestoreFlags
TransformComponents
[]Resource
Custom
ComponentStatus
Helm
ComponentStatus
ImageSnapshot
Operator
ComponentStatus
RestoreSourceType
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
ComponentScope
ApplicationType
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
RestorePhase
Status
Status
k8s.io/apimachinery/pkg/api/resource.Quantity
RestoreApplication
HookComponentStatus
[]RestoreCondition
RestoreStats
Kubernetes meta/v1.Duration
[]Resource
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
DayOfWeek
MonthOfYear
Kubernetes meta/v1.Time
map[string]github.com/trilioData/k8s-triliovault/api/v1.BackupScanInfo
Status
Report
CronSpec
CronSpec
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
[]SecurityServiceInstance
Status
Kubernetes meta/v1.Time
Kubernetes meta/v1.Time
map[string]github.com/trilioData/k8s-triliovault/api/v1.ScanInstance
Kubernetes core/v1.ObjectReference
[]Helm
[]Operator
Custom
Image
Kubernetes core/v1.ObjectReference
k8s.io/apimachinery/pkg/api/resource.Quantity
VolumeSnapshot
[]Conditions
k8s.io/apimachinery/pkg/api/resource.Quantity
Kubernetes meta/v1.Time
k8s.io/apimachinery/pkg/api/resource.Quantity
map[string]github.com/trilioData/k8s-triliovault/api/v1.SnapshotInfo
[]TransformStatus
Status
Kubernetes meta/v1.ObjectMeta
TargetSpec
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity
TargetStatus
Status
Kubernetes meta/v1.Time
OperationType
Kubernetes core/v1.ObjectReference
TargetType
Vendor
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity
k8s.io/apimachinery/pkg/api/resource.Quantity
k8s.io/apimachinery/pkg/api/resource.Quantity
k8s.io/apimachinery/pkg/api/resource.Quantity
[]TargetCondition
Status
TargetStats
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
[]HelmTransform
[]CustomTransform
Status
[]Resource
[]TransformationError
GroupVersionKind
Kubernetes core/v1.ObjectReference
Status

Type is the type of backup in the sequence of backups of an Application.

BackupPlan is a reference to the BackupPlan to be backed up.

backupNamespace string

Namespace is the namespace from where the components of backupPlan to be selected Deprecated: After removal of cluster scope CRD support, Backup namespace will be same as BackupPlan namespace.

BackupConfig is the type containing the object references for all the configurations needed for backup operation

BackupPlanComponents includes all the components which defines this BackupPlan i.e Helm charts, operators and label based resources

hookConfig defines backup pre/post hooks and their configurations.

IncludeResources specify resources to include for namespace scope backup based on LabelSelector & GVKSelector. This acts similar like SelectResources used in custom or operators.

ExcludeResources specify resources to exclude for namespace scope backup based on LabelSelector & GVKSelector

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for Backup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the backup plan level.

Type is the type of clusterBackup in the sequence of clusterBackups.

ClusterBackupPlan is a reference to the ClusterBackupPlan to be backed up.

BackupComponents defines all the BackupComponents for which backups are to be taken. It includes namespaces and their configurations

NamespaceSelector defines namespaces for which backups are to be taken based on NamespaceSelector(labels & match expression) & their configurations

BackupConfig is the type containing the object references for all the configurations needed for backup operation

IncludeResources specifies the resources to be explicitly included during backup

ExcludedResources specifies the resources to be excluded from the backup

Encryption specify how to encrypt backups on target for this backupPlan

SecurityScanConfig defines the Security Scan config to be used for ClusterBackup scanning

ContinuousRestoreConfig defines the Continuous Restore config to be used

retainHelmApps bool

RetainHelmApps is a bool value that states that backup the helm application using helm way while taking namespace backup.

BackupPlanFlags specifies all the flags specified at the cluster backup plan level.

Type is the type of source for ClusterRestore

GlobalConfig is the global restore configuration which is applicable for the components of restore unless explicitly overridden at the component level

Components defines the components and their custom configuration using which individual component restore is to be done

excludeComponents []string

ExcludeComponents specifies the components(namespaces) to be excluded from the ClusterRestore

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup for all restores when ClusterRestore has failed. Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

ImageRegistry specifies the configuration to restore container images

ContinuousRestorePlan specifies the object references of continuousRestorePlan used

location string

Location is the target location where Backup/ClusterBackup is stored

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

ContinuousRestorePolicy specifies the object references of ContinuousRestore policy

Target specifies the object references of target used

TransformComponents specifies the transformation configuration for PVCs both in custom and helm charts

PreHook is the Hook executed to quiesce the application before backup operation

PostHook is the Hook executed to unquiesce the application after backup operation

Type is a field of Policy spec, which defines the policy type containing only 3 values: Retention, Timeout, Cleanup.

default bool

Default field states if the current type of policy is default across the TV application

RetentionConfig field defines the configuration for Retention policy

TimeoutConfig field defines the configuration for timeout policy

CleanupConfig field defines the configuration for Cleanup policy

ScheduleConfig field defines the configuration for Schedule policy

SecurityScanConfig field defines the configuration for SecurityScan policy

ContinuousRestoreConfig field defines the configuration for ContinuousRestore policy

Source defines the source referred for performing restore operation

restoreNamespace string

Namespace is a name of namespace in cluster where backed resources will be restored Deprecated: Restore will be allowed only in Restore CR Namespace so RestoreNamespace is redundant.

skipIfAlreadyExists bool

SkipIfAlreadyExists specifies whether to skip restore of a resource if already exists in the namespace restored. Deprecated: SkipIfAlreadyExists flag is now moved under RestoreFlags struct

patchIfAlreadyExists bool

PatchIfAlreadyExists specifies whether to patch spec of a already exists resource in the namespace restored. Deprecated: PatchIfAlreadyExists flag is now moved under RestoreFlags struct

patchCRD bool

PatchCRD specifies whether to patch spec of a already exists crd. Deprecated: PatchCRD flag is now moved under RestoreFlags struct

omitMetadata bool

OmitMetadata specifies whether to omit metadata like labels, annotations of resources while restoring them. Deprecated: OmitMetadata flag is now moved under RestoreFlags struct

skipOperatorResources bool

SkipOperatorResources specifies whether to skip operator resources or not at the time of restore. (for the use case when operator is already present and the application of that operator needs to be restored) Deprecated: SkipOperatorResources flag is now moved under RestoreFlags struct

disableIgnoreResources bool

DisableIgnoreResources is responsible for the behavior of default list of resources being ignored at the restore. If set to true, those resources will not be ignored Deprecated: DisableIgnoreResources flag is now moved under RestoreFlags struct

Env is the List of environment variables to set in the container. Cannot be updated.

TransformComponents specifies the component-wise transformation configuration

ExcludeResources specifies the resources to be excluded from backup while restoring

HookConfig specifies the Post Restore Hooks Executed in reverse sequence of the sequence specified here

cleanupOnFailure bool

CleanupOnFailure is flag to perform cleanup after restore fails. Defaults to false Deprecated: CleanupOnFailure flag is now moved under ActionFlags struct

protectRestoredApp bool

ProtectRestoredApp decides if T4K will setup a backupplan to protect the restored application. Deprecated: ProtectRestoredApp flag is now moved under ActionFlags struct

Encryption specify encryption key to decrypt the encrypted data.

resourcesReadyWaitSeconds uint16

ResourcesReadyWaitSeconds is the wait time for restored application’s pods to come up. If user application is having webhook then CR creation will fail is webhook is not up. Provide the wait time in such case.

ImageRegistry specifies the configuration to restore container images.

Type is the type of target for backup storage.

Vendor is the third party storage vendor hosting the target

NfsCredentials specifies the credentials for TargetType NFS

ObjectStoreCredentials specifies the credentials for TargetType ObjectStore

enableBrowsing bool

EnableBrowsing specifies if target browser feature should be enabled for this target or not

ThresholdCapacity is the maximum threshold capacity to store backup data.

type

backupPlan

backupConfig

backupPlanComponents

hookConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

backupPlanFlags

type

clusterBackupPlan

backupComponents

namespaceSelector

backupConfig

includeResources

excludeResources

encryption

securityScanConfig

continuousRestoreConfig

clusterBackupPlanFlags

source

globalConfig

components

actionFlags

encryption

imageRegistry

continuousRestorePlan

transformComponents

continuousRestorePolicy

target

transformComponents

pre

post

type

retentionConfig

timeoutConfig

cleanupConfig

scheduleConfig

securityScanConfig

continuousRestoreConfig

source

restoreFlags

actionFlags

env

transformComponents

excludeResources

hookConfig

encryption

imageRegistry

type

vendor

nfsCredentials

objectStoreCredentials

thresholdCapacity

BackupType
Kubernetes core/v1.ObjectReference
BackupConfig
BackupPlanComponents
HookConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
BackupType
Kubernetes core/v1.ObjectReference
[]BackupComponent
[]NamespaceSelector
ClusterBackupConfig
ResourceSelector
ResourceSelector
Encryption
SecurityScanConfigInfo
ContinuousRestoreConfigInfo
BackupPlanFlags
ClusterRestoreSource
RestoreConfig
[]ComponentConfig
ActionFlags
Encryption
ImageRegistry
Kubernetes core/v1.ObjectReference
TransformComponents
Kubernetes core/v1.ObjectReference
Kubernetes core/v1.ObjectReference
TransformComponents
HookExecution
HookExecution
PolicyType
RetentionConfig
TimeoutConfig
CleanupConfig
Crons
SecurityScanConfig
ContinuousRestoreConfig
RestoreSource
RestoreFlags
ActionFlags
[]Kubernetes core/v1.EnvVar
TransformComponents
[]Resource
HookConfig
Encryption
ImageRegistry
TargetType
Vendor
NFSCredentials
ObjectStoreCredentials
k8s.io/apimachinery/pkg/api/resource.Quantity