v1alpha1

package
v0.0.0-...-d980752 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 9, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=playbook.crossplane.io +versionName=v1alpha1

Index

Constants

View Source
const (
	CRDGroup   = "playbook.crossplane.io"
	CRDVersion = "v1alpha1"
)

Package type metadata.

Variables

View Source
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
)
View Source
var (
	Playbook_Kind             = "Playbook"
	Playbook_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Playbook_Kind}.String()
	Playbook_KindAPIVersion   = Playbook_Kind + "." + CRDGroupVersion.String()
	Playbook_GroupVersionKind = CRDGroupVersion.WithKind(Playbook_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Playbook

type Playbook 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.name) || (has(self.initProvider) && has(self.initProvider.name))",message="spec.forProvider.name is a required parameter"
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.playbook) || (has(self.initProvider) && has(self.initProvider.playbook))",message="spec.forProvider.playbook is a required parameter"
	Spec   PlaybookSpec   `json:"spec"`
	Status PlaybookStatus `json:"status,omitempty"`
}

Playbook is the Schema for the Playbooks API. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].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:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,ansible}

func (*Playbook) DeepCopy

func (in *Playbook) DeepCopy() *Playbook

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Playbook.

func (*Playbook) DeepCopyInto

func (in *Playbook) DeepCopyInto(out *Playbook)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Playbook) DeepCopyObject

func (in *Playbook) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Playbook) GetCondition

func (mg *Playbook) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Playbook.

func (*Playbook) GetConnectionDetailsMapping

func (tr *Playbook) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Playbook

func (*Playbook) GetDeletionPolicy

func (mg *Playbook) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Playbook.

func (*Playbook) GetID

func (tr *Playbook) GetID() string

GetID returns ID of underlying Terraform resource of this Playbook

func (*Playbook) GetInitParameters

func (tr *Playbook) GetInitParameters() (map[string]any, error)

GetInitParameters of this Playbook

func (*Playbook) GetManagementPolicies

func (mg *Playbook) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Playbook.

func (*Playbook) GetObservation

func (tr *Playbook) GetObservation() (map[string]any, error)

GetObservation of this Playbook

func (*Playbook) GetParameters

func (tr *Playbook) GetParameters() (map[string]any, error)

GetParameters of this Playbook

func (*Playbook) GetProviderConfigReference

func (mg *Playbook) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Playbook.

func (*Playbook) GetPublishConnectionDetailsTo

func (mg *Playbook) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Playbook.

func (*Playbook) GetTerraformResourceType

func (mg *Playbook) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Playbook

func (*Playbook) GetTerraformSchemaVersion

func (tr *Playbook) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Playbook) GetWriteConnectionSecretToReference

func (mg *Playbook) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Playbook.

func (*Playbook) LateInitialize

func (tr *Playbook) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Playbook using its observed tfState. returns True if there are any spec changes for the resource.

func (*Playbook) SetConditions

func (mg *Playbook) SetConditions(c ...xpv1.Condition)

SetConditions of this Playbook.

func (*Playbook) SetDeletionPolicy

func (mg *Playbook) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Playbook.

func (*Playbook) SetManagementPolicies

func (mg *Playbook) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Playbook.

func (*Playbook) SetObservation

func (tr *Playbook) SetObservation(obs map[string]any) error

SetObservation for this Playbook

func (*Playbook) SetParameters

func (tr *Playbook) SetParameters(params map[string]any) error

SetParameters for this Playbook

func (*Playbook) SetProviderConfigReference

func (mg *Playbook) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Playbook.

func (*Playbook) SetPublishConnectionDetailsTo

func (mg *Playbook) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Playbook.

func (*Playbook) SetWriteConnectionSecretToReference

func (mg *Playbook) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Playbook.

type PlaybookInitParameters

type PlaybookInitParameters struct {

	// playbook executable (binary).
	// Path to ansible-playbook executable (binary).
	AnsiblePlaybookBinary *string `json:"ansiblePlaybookBinary,omitempty" tf:"ansible_playbook_binary,omitempty"`

	// (Boolean) If 'true', playbook execution won't make any changes but only change predictions will be made.
	// If 'true', playbook execution won't make any changes but only change predictions will be made.
	CheckMode *bool `json:"checkMode,omitempty" tf:"check_mode,omitempty"`

	// (Boolean) If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	// If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	DiffMode *bool `json:"diffMode,omitempty" tf:"diff_mode,omitempty"`

	// 1 = value-1, key-2 = value-2, ... }.
	// A map of additional variables as: { key-1 = value-1, key-2 = value-2, ... }.
	ExtraVars map[string]*string `json:"extraVars,omitempty" tf:"extra_vars,omitempty"`

	// (Boolean) If 'true', run handlers even if a task fails.
	// If 'true', run handlers even if a task fails.
	ForceHandlers *bool `json:"forceHandlers,omitempty" tf:"force_handlers,omitempty"`

	// (List of String) List of desired groups of hosts on which the playbook will be executed.
	// List of desired groups of hosts on which the playbook will be executed.
	Groups []*string `json:"groups,omitempty" tf:"groups,omitempty"`

	// (Boolean) This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	// This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	IgnorePlaybookFailure *bool `json:"ignorePlaybookFailure,omitempty" tf:"ignore_playbook_failure,omitempty"`

	// (List of String) List of hosts to exclude from the playbook execution.
	// List of hosts to exclude from the playbook execution.
	Limit []*string `json:"limit,omitempty" tf:"limit,omitempty"`

	// (String) Name of the desired host on which the playbook will be executed.
	// Name of the desired host on which the playbook will be executed.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`

	// (String) Path to ansible playbook.
	// Path to ansible playbook.
	Playbook *string `json:"playbook,omitempty" tf:"playbook,omitempty"`

	Replayable *bool `json:"replayable,omitempty" tf:"replayable,omitempty"`

	// (List of String) List of tags of plays and tasks to run.
	// List of tags of plays and tasks to run.
	Tags []*string `json:"tags,omitempty" tf:"tags,omitempty"`

	// (List of String) List of variable files.
	// List of variable files.
	VarFiles []*string `json:"varFiles,omitempty" tf:"var_files,omitempty"`

	// (List of String) List of vault files.
	// List of vault files.
	VaultFiles []*string `json:"vaultFiles,omitempty" tf:"vault_files,omitempty"`

	// (String) ID of the desired vault(s).
	// ID of the desired vault(s).
	VaultID *string `json:"vaultId,omitempty" tf:"vault_id,omitempty"`

	// (String) Path to a vault password file.
	// Path to a vault password file.
	VaultPasswordFile *string `json:"vaultPasswordFile,omitempty" tf:"vault_password_file,omitempty"`

	// (Number) A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	// A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	Verbosity *float64 `json:"verbosity,omitempty" tf:"verbosity,omitempty"`
}

func (*PlaybookInitParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookInitParameters.

func (*PlaybookInitParameters) DeepCopyInto

func (in *PlaybookInitParameters) DeepCopyInto(out *PlaybookInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PlaybookList

type PlaybookList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Playbook `json:"items"`
}

PlaybookList contains a list of Playbooks

func (*PlaybookList) DeepCopy

func (in *PlaybookList) DeepCopy() *PlaybookList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookList.

func (*PlaybookList) DeepCopyInto

func (in *PlaybookList) DeepCopyInto(out *PlaybookList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PlaybookList) DeepCopyObject

func (in *PlaybookList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*PlaybookList) GetItems

func (l *PlaybookList) GetItems() []resource.Managed

GetItems of this PlaybookList.

type PlaybookObservation

type PlaybookObservation struct {

	// playbook executable (binary).
	// Path to ansible-playbook executable (binary).
	AnsiblePlaybookBinary *string `json:"ansiblePlaybookBinary,omitempty" tf:"ansible_playbook_binary,omitempty"`

	// playbook CLI stderr output.
	// An ansible-playbook CLI stderr output.
	AnsiblePlaybookStderr *string `json:"ansiblePlaybookStderr,omitempty" tf:"ansible_playbook_stderr,omitempty"`

	// playbook CLI stdout output.
	// An ansible-playbook CLI stdout output.
	AnsiblePlaybookStdout *string `json:"ansiblePlaybookStdout,omitempty" tf:"ansible_playbook_stdout,omitempty"`

	// (List of String) Used to build arguments to run Ansible playbook with.
	// Used to build arguments to run Ansible playbook with.
	Args []*string `json:"args,omitempty" tf:"args,omitempty"`

	// (Boolean) If 'true', playbook execution won't make any changes but only change predictions will be made.
	// If 'true', playbook execution won't make any changes but only change predictions will be made.
	CheckMode *bool `json:"checkMode,omitempty" tf:"check_mode,omitempty"`

	// (Boolean) If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	// If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	DiffMode *bool `json:"diffMode,omitempty" tf:"diff_mode,omitempty"`

	// 1 = value-1, key-2 = value-2, ... }.
	// A map of additional variables as: { key-1 = value-1, key-2 = value-2, ... }.
	ExtraVars map[string]*string `json:"extraVars,omitempty" tf:"extra_vars,omitempty"`

	// (Boolean) If 'true', run handlers even if a task fails.
	// If 'true', run handlers even if a task fails.
	ForceHandlers *bool `json:"forceHandlers,omitempty" tf:"force_handlers,omitempty"`

	// (List of String) List of desired groups of hosts on which the playbook will be executed.
	// List of desired groups of hosts on which the playbook will be executed.
	Groups []*string `json:"groups,omitempty" tf:"groups,omitempty"`

	// (String) The ID of this resource.
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// (Boolean) This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	// This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	IgnorePlaybookFailure *bool `json:"ignorePlaybookFailure,omitempty" tf:"ignore_playbook_failure,omitempty"`

	// (List of String) List of hosts to exclude from the playbook execution.
	// List of hosts to exclude from the playbook execution.
	Limit []*string `json:"limit,omitempty" tf:"limit,omitempty"`

	// (String) Name of the desired host on which the playbook will be executed.
	// Name of the desired host on which the playbook will be executed.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`

	// (String) Path to ansible playbook.
	// Path to ansible playbook.
	Playbook *string `json:"playbook,omitempty" tf:"playbook,omitempty"`

	Replayable *bool `json:"replayable,omitempty" tf:"replayable,omitempty"`

	// (List of String) List of tags of plays and tasks to run.
	// List of tags of plays and tasks to run.
	Tags []*string `json:"tags,omitempty" tf:"tags,omitempty"`

	// (String) Path to created temporary inventory file.
	// Path to created temporary inventory file.
	TempInventoryFile *string `json:"tempInventoryFile,omitempty" tf:"temp_inventory_file,omitempty"`

	// (List of String) List of variable files.
	// List of variable files.
	VarFiles []*string `json:"varFiles,omitempty" tf:"var_files,omitempty"`

	// (List of String) List of vault files.
	// List of vault files.
	VaultFiles []*string `json:"vaultFiles,omitempty" tf:"vault_files,omitempty"`

	// (String) ID of the desired vault(s).
	// ID of the desired vault(s).
	VaultID *string `json:"vaultId,omitempty" tf:"vault_id,omitempty"`

	// (String) Path to a vault password file.
	// Path to a vault password file.
	VaultPasswordFile *string `json:"vaultPasswordFile,omitempty" tf:"vault_password_file,omitempty"`

	// (Number) A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	// A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	Verbosity *float64 `json:"verbosity,omitempty" tf:"verbosity,omitempty"`
}

func (*PlaybookObservation) DeepCopy

func (in *PlaybookObservation) DeepCopy() *PlaybookObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookObservation.

func (*PlaybookObservation) DeepCopyInto

func (in *PlaybookObservation) DeepCopyInto(out *PlaybookObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PlaybookParameters

type PlaybookParameters struct {

	// playbook executable (binary).
	// Path to ansible-playbook executable (binary).
	// +kubebuilder:validation:Optional
	AnsiblePlaybookBinary *string `json:"ansiblePlaybookBinary,omitempty" tf:"ansible_playbook_binary,omitempty"`

	// (Boolean) If 'true', playbook execution won't make any changes but only change predictions will be made.
	// If 'true', playbook execution won't make any changes but only change predictions will be made.
	// +kubebuilder:validation:Optional
	CheckMode *bool `json:"checkMode,omitempty" tf:"check_mode,omitempty"`

	// (Boolean) If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	// If 'true', when changing (small) files and templates, differences in those files will be shown. Recommended usage with 'check_mode'.
	// +kubebuilder:validation:Optional
	DiffMode *bool `json:"diffMode,omitempty" tf:"diff_mode,omitempty"`

	// 1 = value-1, key-2 = value-2, ... }.
	// A map of additional variables as: { key-1 = value-1, key-2 = value-2, ... }.
	// +kubebuilder:validation:Optional
	ExtraVars map[string]*string `json:"extraVars,omitempty" tf:"extra_vars,omitempty"`

	// (Boolean) If 'true', run handlers even if a task fails.
	// If 'true', run handlers even if a task fails.
	// +kubebuilder:validation:Optional
	ForceHandlers *bool `json:"forceHandlers,omitempty" tf:"force_handlers,omitempty"`

	// (List of String) List of desired groups of hosts on which the playbook will be executed.
	// List of desired groups of hosts on which the playbook will be executed.
	// +kubebuilder:validation:Optional
	Groups []*string `json:"groups,omitempty" tf:"groups,omitempty"`

	// (Boolean) This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	// This parameter is good for testing. Set to 'true' if the desired playbook is meant to fail, but still want the resource to run successfully.
	// +kubebuilder:validation:Optional
	IgnorePlaybookFailure *bool `json:"ignorePlaybookFailure,omitempty" tf:"ignore_playbook_failure,omitempty"`

	// (List of String) List of hosts to exclude from the playbook execution.
	// List of hosts to exclude from the playbook execution.
	// +kubebuilder:validation:Optional
	Limit []*string `json:"limit,omitempty" tf:"limit,omitempty"`

	// (String) Name of the desired host on which the playbook will be executed.
	// Name of the desired host on which the playbook will be executed.
	// +kubebuilder:validation:Optional
	Name *string `json:"name,omitempty" tf:"name,omitempty"`

	// (String) Path to ansible playbook.
	// Path to ansible playbook.
	// +kubebuilder:validation:Optional
	Playbook *string `json:"playbook,omitempty" tf:"playbook,omitempty"`

	// +kubebuilder:validation:Optional
	Replayable *bool `json:"replayable,omitempty" tf:"replayable,omitempty"`

	// (List of String) List of tags of plays and tasks to run.
	// List of tags of plays and tasks to run.
	// +kubebuilder:validation:Optional
	Tags []*string `json:"tags,omitempty" tf:"tags,omitempty"`

	// (List of String) List of variable files.
	// List of variable files.
	// +kubebuilder:validation:Optional
	VarFiles []*string `json:"varFiles,omitempty" tf:"var_files,omitempty"`

	// (List of String) List of vault files.
	// List of vault files.
	// +kubebuilder:validation:Optional
	VaultFiles []*string `json:"vaultFiles,omitempty" tf:"vault_files,omitempty"`

	// (String) ID of the desired vault(s).
	// ID of the desired vault(s).
	// +kubebuilder:validation:Optional
	VaultID *string `json:"vaultId,omitempty" tf:"vault_id,omitempty"`

	// (String) Path to a vault password file.
	// Path to a vault password file.
	// +kubebuilder:validation:Optional
	VaultPasswordFile *string `json:"vaultPasswordFile,omitempty" tf:"vault_password_file,omitempty"`

	// (Number) A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	// A verbosity level between 0 and 6. Set ansible 'verbose' parameter, which causes Ansible to print more debug messages. The higher the 'verbosity', the more debug details will be printed.
	// +kubebuilder:validation:Optional
	Verbosity *float64 `json:"verbosity,omitempty" tf:"verbosity,omitempty"`
}

func (*PlaybookParameters) DeepCopy

func (in *PlaybookParameters) DeepCopy() *PlaybookParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookParameters.

func (*PlaybookParameters) DeepCopyInto

func (in *PlaybookParameters) DeepCopyInto(out *PlaybookParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PlaybookSpec

type PlaybookSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     PlaybookParameters `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 PlaybookInitParameters `json:"initProvider,omitempty"`
}

PlaybookSpec defines the desired state of Playbook

func (*PlaybookSpec) DeepCopy

func (in *PlaybookSpec) DeepCopy() *PlaybookSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookSpec.

func (*PlaybookSpec) DeepCopyInto

func (in *PlaybookSpec) DeepCopyInto(out *PlaybookSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PlaybookStatus

type PlaybookStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        PlaybookObservation `json:"atProvider,omitempty"`
}

PlaybookStatus defines the observed state of Playbook.

func (*PlaybookStatus) DeepCopy

func (in *PlaybookStatus) DeepCopy() *PlaybookStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlaybookStatus.

func (*PlaybookStatus) DeepCopyInto

func (in *PlaybookStatus) DeepCopyInto(out *PlaybookStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL