Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=configuration.artifactory.jfrog.m.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Backup
- func (in *Backup) DeepCopy() *Backup
- func (in *Backup) DeepCopyInto(out *Backup)
- func (in *Backup) DeepCopyObject() runtime.Object
- func (mg *Backup) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Backup) GetConnectionDetailsMapping() map[string]string
- func (tr *Backup) GetID() string
- func (tr *Backup) GetInitParameters() (map[string]any, error)
- func (mg *Backup) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Backup) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Backup) GetObservation() (map[string]any, error)
- func (tr *Backup) GetParameters() (map[string]any, error)
- func (mg *Backup) GetProviderConfigReference() *xpv1.ProviderConfigReference
- func (mg *Backup) GetTerraformResourceType() string
- func (tr *Backup) GetTerraformSchemaVersion() int
- func (mg *Backup) GetWriteConnectionSecretToReference() *xpv1.LocalSecretReference
- func (tr *Backup) Hub()
- func (tr *Backup) LateInitialize(attrs []byte) (bool, error)
- func (mg *Backup) SetConditions(c ...xpv1.Condition)
- func (mg *Backup) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Backup) SetObservation(obs map[string]any) error
- func (tr *Backup) SetParameters(params map[string]any) error
- func (mg *Backup) SetProviderConfigReference(r *xpv1.ProviderConfigReference)
- func (mg *Backup) SetWriteConnectionSecretToReference(r *xpv1.LocalSecretReference)
- type BackupInitParameters
- type BackupList
- type BackupObservation
- type BackupParameters
- type BackupSpec
- type BackupStatus
Constants ¶
const ( CRDGroup = "configuration.artifactory.jfrog.m.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( Backup_Kind = "Backup" Backup_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Backup_Kind}.String() Backup_KindAPIVersion = Backup_Kind + "." + CRDGroupVersion.String() Backup_GroupVersionKind = CRDGroupVersion.WithKind(Backup_Kind) )
Repository type metadata.
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Backup ¶
type Backup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.cronExp) || (has(self.initProvider) && has(self.initProvider.cronExp))",message="spec.forProvider.cronExp is a required parameter"
Spec BackupSpec `json:"spec"`
Status BackupStatus `json:"status,omitempty"`
}
Backup is the Schema for the Backups API. This resource can be used to manage the automatic and periodic backups of the entire Artifactory instance. When an artifactory_backup resource is configured and enabled to true, backup of the entire Artifactory system will be done automatically and periodically. The backup process creates a time-stamped directory in the target backup directory. See JFrog Artifactory Backup https://www.jfrog.com/confluence/display/JFROG/Backups for more details. ~>Only supported in self-hosted environment. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Namespaced,categories={crossplane,managed,artifactory}
func (*Backup) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Backup.
func (*Backup) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Backup) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Backup) GetCondition ¶
func (mg *Backup) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Backup.
func (*Backup) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Backup
func (*Backup) GetInitParameters ¶
GetInitParameters of this Backup
func (*Backup) GetManagementPolicies ¶
func (mg *Backup) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Backup.
func (*Backup) GetMergedParameters ¶
GetInitParameters of this Backup
func (*Backup) GetObservation ¶
GetObservation of this Backup
func (*Backup) GetParameters ¶
GetParameters of this Backup
func (*Backup) GetProviderConfigReference ¶
func (mg *Backup) GetProviderConfigReference() *xpv1.ProviderConfigReference
GetProviderConfigReference of this Backup.
func (*Backup) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Backup
func (*Backup) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Backup) GetWriteConnectionSecretToReference ¶
func (mg *Backup) GetWriteConnectionSecretToReference() *xpv1.LocalSecretReference
GetWriteConnectionSecretToReference of this Backup.
func (*Backup) LateInitialize ¶
LateInitialize this Backup using its observed tfState. returns True if there are any spec changes for the resource.
func (*Backup) SetConditions ¶
SetConditions of this Backup.
func (*Backup) SetManagementPolicies ¶
func (mg *Backup) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Backup.
func (*Backup) SetObservation ¶
SetObservation for this Backup
func (*Backup) SetParameters ¶
SetParameters for this Backup
func (*Backup) SetProviderConfigReference ¶
func (mg *Backup) SetProviderConfigReference(r *xpv1.ProviderConfigReference)
SetProviderConfigReference of this Backup.
func (*Backup) SetWriteConnectionSecretToReference ¶
func (mg *Backup) SetWriteConnectionSecretToReference(r *xpv1.LocalSecretReference)
SetWriteConnectionSecretToReference of this Backup.
type BackupInitParameters ¶
type BackupInitParameters struct {
// (Boolean) If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false
// If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is `false`
CreateArchive *bool `json:"createArchive,omitempty" tf:"create_archive,omitempty"`
// (String) Cron expression to control the backup frequency.
// Cron expression to control the backup frequency.
CronExp *string `json:"cronExp,omitempty" tf:"cron_exp,omitempty"`
// (Boolean) Flag to enable or disable the backup config. Default value is true.
// Flag to enable or disable the backup config. Default value is `true`.
Enabled *bool `json:"enabled,omitempty" tf:"enabled,omitempty"`
// (Boolean) When set to true, new repositories will not be automatically added to the backup. Default value is false.
// When set to true, new repositories will not be automatically added to the backup. Default value is `false`.
ExcludeNewRepositories *bool `json:"excludeNewRepositories,omitempty" tf:"exclude_new_repositories,omitempty"`
// (List of String) List of excluded repositories from the backup.
// List of excluded repositories from the backup.
ExcludedRepositories []*string `json:"excludedRepositories,omitempty" tf:"excluded_repositories,omitempty"`
// (Boolean) When set to true, mission control will not be automatically added to the backup. Default value is false.
// When set to true, mission control will not be automatically added to the backup. Default value is `false`.
ExportMissionControl *bool `json:"exportMissionControl,omitempty" tf:"export_mission_control,omitempty"`
// incremental backups. Default value is 168 hours i.e. 7 days.
// The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours i.e. 7 days.
RetentionPeriodHours *float64 `json:"retentionPeriodHours,omitempty" tf:"retention_period_hours,omitempty"`
// (Boolean) If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
// If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is `true`.
SendMailOnError *bool `json:"sendMailOnError,omitempty" tf:"send_mail_on_error,omitempty"`
// incremental backups. Default value is false.
// If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups. Default value is `false`.
VerifyDiskSpace *bool `json:"verifyDiskSpace,omitempty" tf:"verify_disk_space,omitempty"`
}
func (*BackupInitParameters) DeepCopy ¶
func (in *BackupInitParameters) DeepCopy() *BackupInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupInitParameters.
func (*BackupInitParameters) DeepCopyInto ¶
func (in *BackupInitParameters) DeepCopyInto(out *BackupInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupList ¶
type BackupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Backup `json:"items"`
}
BackupList contains a list of Backups
func (*BackupList) DeepCopy ¶
func (in *BackupList) DeepCopy() *BackupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupList.
func (*BackupList) DeepCopyInto ¶
func (in *BackupList) DeepCopyInto(out *BackupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupList) DeepCopyObject ¶
func (in *BackupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BackupList) GetItems ¶
func (l *BackupList) GetItems() []resource.Managed
GetItems of this BackupList.
type BackupObservation ¶
type BackupObservation struct {
// (Boolean) If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false
// If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is `false`
CreateArchive *bool `json:"createArchive,omitempty" tf:"create_archive,omitempty"`
// (String) Cron expression to control the backup frequency.
// Cron expression to control the backup frequency.
CronExp *string `json:"cronExp,omitempty" tf:"cron_exp,omitempty"`
// (Boolean) Flag to enable or disable the backup config. Default value is true.
// Flag to enable or disable the backup config. Default value is `true`.
Enabled *bool `json:"enabled,omitempty" tf:"enabled,omitempty"`
// (Boolean) When set to true, new repositories will not be automatically added to the backup. Default value is false.
// When set to true, new repositories will not be automatically added to the backup. Default value is `false`.
ExcludeNewRepositories *bool `json:"excludeNewRepositories,omitempty" tf:"exclude_new_repositories,omitempty"`
// (List of String) List of excluded repositories from the backup.
// List of excluded repositories from the backup.
ExcludedRepositories []*string `json:"excludedRepositories,omitempty" tf:"excluded_repositories,omitempty"`
// (Boolean) When set to true, mission control will not be automatically added to the backup. Default value is false.
// When set to true, mission control will not be automatically added to the backup. Default value is `false`.
ExportMissionControl *bool `json:"exportMissionControl,omitempty" tf:"export_mission_control,omitempty"`
ID *string `json:"id,omitempty" tf:"id,omitempty"`
// incremental backups. Default value is 168 hours i.e. 7 days.
// The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours i.e. 7 days.
RetentionPeriodHours *float64 `json:"retentionPeriodHours,omitempty" tf:"retention_period_hours,omitempty"`
// (Boolean) If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
// If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is `true`.
SendMailOnError *bool `json:"sendMailOnError,omitempty" tf:"send_mail_on_error,omitempty"`
// incremental backups. Default value is false.
// If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups. Default value is `false`.
VerifyDiskSpace *bool `json:"verifyDiskSpace,omitempty" tf:"verify_disk_space,omitempty"`
}
func (*BackupObservation) DeepCopy ¶
func (in *BackupObservation) DeepCopy() *BackupObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupObservation.
func (*BackupObservation) DeepCopyInto ¶
func (in *BackupObservation) DeepCopyInto(out *BackupObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupParameters ¶
type BackupParameters struct {
// (Boolean) If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false
// If set to true, backups will be created within a Zip archive (Slow and CPU intensive). Default value is `false`
// +kubebuilder:validation:Optional
CreateArchive *bool `json:"createArchive,omitempty" tf:"create_archive,omitempty"`
// (String) Cron expression to control the backup frequency.
// Cron expression to control the backup frequency.
// +kubebuilder:validation:Optional
CronExp *string `json:"cronExp,omitempty" tf:"cron_exp,omitempty"`
// (Boolean) Flag to enable or disable the backup config. Default value is true.
// Flag to enable or disable the backup config. Default value is `true`.
// +kubebuilder:validation:Optional
Enabled *bool `json:"enabled,omitempty" tf:"enabled,omitempty"`
// (Boolean) When set to true, new repositories will not be automatically added to the backup. Default value is false.
// When set to true, new repositories will not be automatically added to the backup. Default value is `false`.
// +kubebuilder:validation:Optional
ExcludeNewRepositories *bool `json:"excludeNewRepositories,omitempty" tf:"exclude_new_repositories,omitempty"`
// (List of String) List of excluded repositories from the backup.
// List of excluded repositories from the backup.
// +kubebuilder:validation:Optional
ExcludedRepositories []*string `json:"excludedRepositories,omitempty" tf:"excluded_repositories,omitempty"`
// (Boolean) When set to true, mission control will not be automatically added to the backup. Default value is false.
// When set to true, mission control will not be automatically added to the backup. Default value is `false`.
// +kubebuilder:validation:Optional
ExportMissionControl *bool `json:"exportMissionControl,omitempty" tf:"export_mission_control,omitempty"`
// incremental backups. Default value is 168 hours i.e. 7 days.
// The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours i.e. 7 days.
// +kubebuilder:validation:Optional
RetentionPeriodHours *float64 `json:"retentionPeriodHours,omitempty" tf:"retention_period_hours,omitempty"`
// (Boolean) If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
// If set to true, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is `true`.
// +kubebuilder:validation:Optional
SendMailOnError *bool `json:"sendMailOnError,omitempty" tf:"send_mail_on_error,omitempty"`
// incremental backups. Default value is false.
// If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups. Default value is `false`.
// +kubebuilder:validation:Optional
VerifyDiskSpace *bool `json:"verifyDiskSpace,omitempty" tf:"verify_disk_space,omitempty"`
}
func (*BackupParameters) DeepCopy ¶
func (in *BackupParameters) DeepCopy() *BackupParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupParameters.
func (*BackupParameters) DeepCopyInto ¶
func (in *BackupParameters) DeepCopyInto(out *BackupParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupSpec ¶
type BackupSpec struct {
v2.ManagedResourceSpec `json:",inline"`
ForProvider BackupParameters `json:"forProvider"`
// THIS IS A BETA FIELD. It will be honored
// unless the Management Policies feature flag is disabled.
// InitProvider holds the same fields as ForProvider, with the exception
// of Identifier and other resource reference fields. The fields that are
// in InitProvider are merged into ForProvider when the resource is created.
// The same fields are also added to the terraform ignore_changes hook, to
// avoid updating them after creation. This is useful for fields that are
// required on creation, but we do not desire to update them after creation,
// for example because of an external controller is managing them, like an
// autoscaler.
InitProvider BackupInitParameters `json:"initProvider,omitempty"`
}
BackupSpec defines the desired state of Backup
func (*BackupSpec) DeepCopy ¶
func (in *BackupSpec) DeepCopy() *BackupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSpec.
func (*BackupSpec) DeepCopyInto ¶
func (in *BackupSpec) DeepCopyInto(out *BackupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupStatus ¶
type BackupStatus struct {
v1.ResourceStatus `json:",inline"`
AtProvider BackupObservation `json:"atProvider,omitempty"`
}
BackupStatus defines the observed state of Backup.
func (*BackupStatus) DeepCopy ¶
func (in *BackupStatus) DeepCopy() *BackupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStatus.
func (*BackupStatus) DeepCopyInto ¶
func (in *BackupStatus) DeepCopyInto(out *BackupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.