v1alpha1

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Nov 4, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package v1alpha1 contains the v1alpha1 group Sample resources of the BTPAccount provider. +kubebuilder:object:generate=true +groupName=btp.sap.crossplane.io +versionName=v1alpha1

Index

Constants

View Source
const (
	Group   = "btp.sap.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

View Source
const (
	LabelKeySourceUid          = "ref.orchestrate.cloud.sap/source-uid"
	LabelKeyTargetUid          = "ref.orchestrate.cloud.sap/target-uid"
	AnnotationIgnoreReferences = "ref.orchestrate.cloud.sap/ignore"
	ErrResourceInUse           = "Resource cannot be deleted, still has usages"
	Finalizer                  = "finalizer.orchestrate.cloud.sap"
)
View Source
const InUseReason xpv1.ConditionReason = "ResourceUsagesFound"
View Source
const NotInUseReason xpv1.ConditionReason = "NoResourceUsagesFound"
View Source
const (
	RawBindingKey = "__raw"
)
View Source
const UseCondition xpv1.ConditionType = "ResourceUsage"

Variables

View Source
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)
View Source
var (
	ProviderConfigKind             = reflect.TypeOf(ProviderConfig{}).Name()
	ProviderConfigGroupKind        = schema.GroupKind{Group: Group, Kind: ProviderConfigKind}.String()
	ProviderConfigKindAPIVersion   = ProviderConfigKind + "." + SchemeGroupVersion.String()
	ProviderConfigGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigKind)
)

ProviderConfig type metadata.

View Source
var (
	ProviderConfigUsageKind             = reflect.TypeOf(ProviderConfigUsage{}).Name()
	ProviderConfigUsageGroupKind        = schema.GroupKind{Group: Group, Kind: ProviderConfigUsageKind}.String()
	ProviderConfigUsageKindAPIVersion   = ProviderConfigUsageKind + "." + SchemeGroupVersion.String()
	ProviderConfigUsageGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigUsageKind)

	ProviderConfigUsageListKind             = reflect.TypeOf(ProviderConfigUsageList{}).Name()
	ProviderConfigUsageListGroupKind        = schema.GroupKind{Group: Group, Kind: ProviderConfigUsageListKind}.String()
	ProviderConfigUsageListKindAPIVersion   = ProviderConfigUsageListKind + "." + SchemeGroupVersion.String()
	ProviderConfigUsageListGroupVersionKind = SchemeGroupVersion.WithKind(ProviderConfigUsageListKind)
)

ProviderConfigUsage type metadata.

View Source
var (
	ResourceUsageKind             = reflect.TypeOf(ResourceUsage{}).Name()
	ResourceUsageGroupKind        = schema.GroupKind{Group: Group, Kind: ResourceUsageKind}.String()
	ResourceUsageKindAPIVersion   = ResourceUsageKind + "." + SchemeGroupVersion.String()
	ResourceUsageGroupVersionKind = SchemeGroupVersion.WithKind(ResourceUsageKind)

	ResourceUsageListKind             = reflect.TypeOf(ResourceUsageList{}).Name()
	ResourceUsageListGroupKind        = schema.GroupKind{Group: Group, Kind: ResourceUsageListKind}.String()
	ResourceUsageListKindAPIVersion   = ResourceUsageListKind + "." + SchemeGroupVersion.String()
	ResourceUsageListGroupVersionKind = SchemeGroupVersion.WithKind(ResourceUsageListKind)
)

ResourceUsage type metadata.

View Source
var (
	StoreConfigKind             = reflect.TypeOf(StoreConfig{}).Name()
	StoreConfigGroupKind        = schema.GroupKind{Group: Group, Kind: StoreConfigKind}.String()
	StoreConfigKindAPIVersion   = StoreConfigKind + "." + SchemeGroupVersion.String()
	StoreConfigGroupVersionKind = SchemeGroupVersion.WithKind(StoreConfigKind)
)

StoreConfig type metadata.

Functions

func InUse

func InUse() xpv1.Condition

func InUseError

func InUseError(err error) xpv1.Condition

func NewInUseCondition

func NewInUseCondition(isUsed bool, err error) xpv1.Condition

func NotInUse

func NotInUse() xpv1.Condition

Types

type ProviderConfig

type ProviderConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ProviderConfigSpec   `json:"spec"`
	Status ProviderConfigStatus `json:"status,omitempty"`
}

A ProviderConfig configures a Template provider. +kubebuilder:subresource:status +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="SECRET-NAME",type="string",JSONPath=".spec.credentials.secretRef.name",priority=1 +kubebuilder:resource:scope=Cluster

func (*ProviderConfig) DeepCopy

func (in *ProviderConfig) DeepCopy() *ProviderConfig

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

func (*ProviderConfig) DeepCopyInto

func (in *ProviderConfig) DeepCopyInto(out *ProviderConfig)

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

func (*ProviderConfig) DeepCopyObject

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

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

func (*ProviderConfig) GetCondition

func (p *ProviderConfig) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this ProviderConfig.

func (*ProviderConfig) GetUsers

func (p *ProviderConfig) GetUsers() int64

GetUsers of this ProviderConfig.

func (*ProviderConfig) SetConditions

func (p *ProviderConfig) SetConditions(c ...xpv1.Condition)

SetConditions of this ProviderConfig.

func (*ProviderConfig) SetUsers

func (p *ProviderConfig) SetUsers(i int64)

SetUsers of this ProviderConfig.

type ProviderConfigList

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

ProviderConfigList contains a list of ProviderConfig.

func (*ProviderConfigList) DeepCopy

func (in *ProviderConfigList) DeepCopy() *ProviderConfigList

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

func (*ProviderConfigList) DeepCopyInto

func (in *ProviderConfigList) DeepCopyInto(out *ProviderConfigList)

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

func (*ProviderConfigList) DeepCopyObject

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

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

type ProviderConfigSpec

type ProviderConfigSpec struct {
	// Credentials required to authenticate to this provider.
	// Reference to a secret containing the CIS Accounts service credentials.
	// The Cloud Management (CIS) instance must be of plan `central`.
	// The Service Binding should be created with the following parameters `{"grantType": "clientCredentials"}`
	// See [Setup](https://pages.github.tools.sap/cloud-orchestration/docs/sap-services/btp-services/account-managment/provider) for more details
	CISSecret ProviderCredentials `json:"cisCredentials"`

	// A user available in BTP.
	// The Credentials in the ServiceAccountSecret are relevant for two reasons
	// (1) On environment creation (Kyma & CloudFoundry) the APIs require a users email address
	// (2) For updating the managers of a CloudFoundry Environment it is required to have a user and a password
	// The structure is pretty basic, a json object with email, username and password. Username & Password must not be filled if there is no need for CloudFoundry Environments.
	// Example:
	//   {
	//      "email": "<EMAIL>",
	//      "username": "PUserID",
	//      "password": "--"
	//    }
	ServiceAccountSecret ProviderCredentials `json:"serviceAccountSecret,omitempty"`

	CliServerUrl string `json:"cliServerUrl,omitempty"`

	// GlobalAccount is the Global Account Subdomain.
	GlobalAccount string `json:"globalAccount,omitempty"`
}

A ProviderConfigSpec defines the desired state of a ProviderConfig.

func (*ProviderConfigSpec) DeepCopy

func (in *ProviderConfigSpec) DeepCopy() *ProviderConfigSpec

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

func (*ProviderConfigSpec) DeepCopyInto

func (in *ProviderConfigSpec) DeepCopyInto(out *ProviderConfigSpec)

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

type ProviderConfigStatus

type ProviderConfigStatus struct {
	xpv1.ProviderConfigStatus `json:",inline"`
}

A ProviderConfigStatus reflects the observed state of a ProviderConfig.

func (*ProviderConfigStatus) DeepCopy

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

func (*ProviderConfigStatus) DeepCopyInto

func (in *ProviderConfigStatus) DeepCopyInto(out *ProviderConfigStatus)

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

type ProviderConfigUsage

type ProviderConfigUsage struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	xpv1.ProviderConfigUsage `json:",inline"`
}

A ProviderConfigUsage indicates that a resource is using a ProviderConfig. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="CONFIG-NAME",type="string",JSONPath=".providerConfigRef.name" +kubebuilder:printcolumn:name="RESOURCE-KIND",type="string",JSONPath=".resourceRef.kind" +kubebuilder:printcolumn:name="RESOURCE-NAME",type="string",JSONPath=".resourceRef.name" +kubebuilder:resource:scope=Cluster,categories={crossplane,provider,template}

func (*ProviderConfigUsage) DeepCopy

func (in *ProviderConfigUsage) DeepCopy() *ProviderConfigUsage

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

func (*ProviderConfigUsage) DeepCopyInto

func (in *ProviderConfigUsage) DeepCopyInto(out *ProviderConfigUsage)

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

func (*ProviderConfigUsage) DeepCopyObject

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

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

func (*ProviderConfigUsage) GetProviderConfigReference

func (p *ProviderConfigUsage) GetProviderConfigReference() xpv1.Reference

GetProviderConfigReference of this ProviderConfigUsage.

func (*ProviderConfigUsage) GetResourceReference

func (p *ProviderConfigUsage) GetResourceReference() xpv1.TypedReference

GetResourceReference of this ProviderConfigUsage.

func (*ProviderConfigUsage) SetProviderConfigReference

func (p *ProviderConfigUsage) SetProviderConfigReference(r xpv1.Reference)

SetProviderConfigReference of this ProviderConfigUsage.

func (*ProviderConfigUsage) SetResourceReference

func (p *ProviderConfigUsage) SetResourceReference(r xpv1.TypedReference)

SetResourceReference of this ProviderConfigUsage.

type ProviderConfigUsageList

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

ProviderConfigUsageList contains a list of ProviderConfigUsage

func (*ProviderConfigUsageList) DeepCopy

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

func (*ProviderConfigUsageList) DeepCopyInto

func (in *ProviderConfigUsageList) DeepCopyInto(out *ProviderConfigUsageList)

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

func (*ProviderConfigUsageList) DeepCopyObject

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

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

func (*ProviderConfigUsageList) GetItems

GetItems of this ProviderConfigUsageList.

type ProviderCredentials

type ProviderCredentials struct {
	// Source of the provider credentials.
	// +kubebuilder:validation:Enum=None;Secret;InjectedIdentity;Environment;Filesystem
	Source xpv1.CredentialsSource `json:"source"`

	xpv1.CommonCredentialSelectors `json:",inline"`
}

ProviderCredentials required to authenticate.

func (*ProviderCredentials) DeepCopy

func (in *ProviderCredentials) DeepCopy() *ProviderCredentials

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

func (*ProviderCredentials) DeepCopyInto

func (in *ProviderCredentials) DeepCopyInto(out *ProviderCredentials)

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

type ResourceUsage

type ResourceUsage struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	//Spec ResourceUsageSpec `json:"spec"`
	Spec ResourceUsageSpec `json:"spec"`

	Status metav1.Status `json:"status,omitempty"`
}

A ResourceUsage indicates that a resource is using a another resource. It is used to track dependencies between objects. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="SOURCE-KIND",type="string",JSONPath=".spec.sourceRef.kind" +kubebuilder:printcolumn:name="SOURCE",type="string",JSONPath=".spec.sourceRef.name" +kubebuilder:printcolumn:name="TARGET-KIND",type="string",JSONPath=".spec.targetRef.kind" +kubebuilder:printcolumn:name="TARGET",type="string",JSONPath=".spec.targetRef.name" +kubebuilder:resource:scope=Cluster,categories={crossplane,provider,template}

func (*ResourceUsage) DeepCopy

func (in *ResourceUsage) DeepCopy() *ResourceUsage

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

func (*ResourceUsage) DeepCopyInto

func (in *ResourceUsage) DeepCopyInto(out *ResourceUsage)

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

func (*ResourceUsage) DeepCopyObject

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

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

type ResourceUsageList

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

ResourceUsageList contains a list of ProviderResourceUsage

func (*ResourceUsageList) DeepCopy

func (in *ResourceUsageList) DeepCopy() *ResourceUsageList

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

func (*ResourceUsageList) DeepCopyInto

func (in *ResourceUsageList) DeepCopyInto(out *ResourceUsageList)

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

func (*ResourceUsageList) DeepCopyObject

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

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

type ResourceUsageSpec

type ResourceUsageSpec struct {

	// ResourceReference to the source managed resource.
	SourceReference xpv1.TypedReference `json:"sourceRef"`

	// ResourceReference to the source managed resource.
	TargetReference xpv1.TypedReference `json:"targetRef"`
}

A ResourceUsageSpec is a record that a particular managed resource is using a particular provider configuration.

func (*ResourceUsageSpec) DeepCopy

func (in *ResourceUsageSpec) DeepCopy() *ResourceUsageSpec

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

func (*ResourceUsageSpec) DeepCopyInto

func (in *ResourceUsageSpec) DeepCopyInto(out *ResourceUsageSpec)

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

type StoreConfig

type StoreConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StoreConfigSpec   `json:"spec"`
	Status StoreConfigStatus `json:"status,omitempty"`
}

A StoreConfig configures how GCP controller should store connection details. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:printcolumn:name="TYPE",type="string",JSONPath=".spec.type" +kubebuilder:printcolumn:name="DEFAULT-SCOPE",type="string",JSONPath=".spec.defaultScope" +kubebuilder:resource:scope=Cluster,categories={crossplane,store,gcp} +kubebuilder:subresource:status

func (*StoreConfig) DeepCopy

func (in *StoreConfig) DeepCopy() *StoreConfig

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

func (*StoreConfig) DeepCopyInto

func (in *StoreConfig) DeepCopyInto(out *StoreConfig)

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

func (*StoreConfig) DeepCopyObject

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

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

func (*StoreConfig) GetCondition

func (in *StoreConfig) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this StoreConfig.

func (*StoreConfig) GetStoreConfig

func (in *StoreConfig) GetStoreConfig() xpv1.SecretStoreConfig

GetStoreConfig returns SecretStoreConfig

func (*StoreConfig) SetConditions

func (in *StoreConfig) SetConditions(c ...xpv1.Condition)

SetConditions of this StoreConfig.

type StoreConfigList

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

StoreConfigList contains a list of StoreConfig

func (*StoreConfigList) DeepCopy

func (in *StoreConfigList) DeepCopy() *StoreConfigList

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

func (*StoreConfigList) DeepCopyInto

func (in *StoreConfigList) DeepCopyInto(out *StoreConfigList)

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

func (*StoreConfigList) DeepCopyObject

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

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

type StoreConfigSpec

type StoreConfigSpec struct {
	xpv1.SecretStoreConfig `json:",inline"`
}

A StoreConfigSpec defines the desired state of a ProviderConfig.

func (*StoreConfigSpec) DeepCopy

func (in *StoreConfigSpec) DeepCopy() *StoreConfigSpec

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

func (*StoreConfigSpec) DeepCopyInto

func (in *StoreConfigSpec) DeepCopyInto(out *StoreConfigSpec)

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

type StoreConfigStatus

type StoreConfigStatus struct {
	xpv1.ConditionedStatus `json:",inline"`
}

A StoreConfigStatus represents the status of a StoreConfig.

func (*StoreConfigStatus) DeepCopy

func (in *StoreConfigStatus) DeepCopy() *StoreConfigStatus

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

func (*StoreConfigStatus) DeepCopyInto

func (in *StoreConfigStatus) DeepCopyInto(out *StoreConfigStatus)

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