Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=main.boundary.upbound.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Scope
- func (in *Scope) DeepCopy() *Scope
- func (in *Scope) DeepCopyInto(out *Scope)
- func (in *Scope) DeepCopyObject() runtime.Object
- func (mg *Scope) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Scope) GetConnectionDetailsMapping() map[string]string
- func (mg *Scope) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Scope) GetID() string
- func (tr *Scope) GetInitParameters() (map[string]any, error)
- func (mg *Scope) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Scope) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Scope) GetObservation() (map[string]any, error)
- func (tr *Scope) GetParameters() (map[string]any, error)
- func (mg *Scope) GetProviderConfigReference() *xpv1.Reference
- func (mg *Scope) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Scope) GetTerraformResourceType() string
- func (tr *Scope) GetTerraformSchemaVersion() int
- func (mg *Scope) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Scope) Hub()
- func (tr *Scope) LateInitialize(attrs []byte) (bool, error)
- func (mg *Scope) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *Scope) SetConditions(c ...xpv1.Condition)
- func (mg *Scope) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Scope) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Scope) SetObservation(obs map[string]any) error
- func (tr *Scope) SetParameters(params map[string]any) error
- func (mg *Scope) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Scope) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Scope) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type ScopeInitParameters
- type ScopeList
- type ScopeObservation
- type ScopeParameters
- type ScopeSpec
- type ScopeStatus
Constants ¶
const ( CRDGroup = "main.boundary.upbound.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
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 )
var ( Scope_Kind = "Scope" Scope_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Scope_Kind}.String() Scope_KindAPIVersion = Scope_Kind + "." + CRDGroupVersion.String() Scope_GroupVersionKind = CRDGroupVersion.WithKind(Scope_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type Scope ¶
type Scope struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ScopeSpec `json:"spec"` Status ScopeStatus `json:"status,omitempty"` }
Scope is the Schema for the Scopes API. The scope resource allows you to configure a Boundary scope. +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=Cluster,categories={crossplane,managed,boundary}
func (*Scope) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Scope.
func (*Scope) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Scope) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Scope) GetCondition ¶
func (mg *Scope) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Scope.
func (*Scope) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Scope
func (*Scope) GetDeletionPolicy ¶
func (mg *Scope) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Scope.
func (*Scope) GetInitParameters ¶
GetInitParameters of this Scope
func (*Scope) GetManagementPolicies ¶
func (mg *Scope) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Scope.
func (*Scope) GetMergedParameters ¶
GetInitParameters of this Scope
func (*Scope) GetObservation ¶
GetObservation of this Scope
func (*Scope) GetParameters ¶
GetParameters of this Scope
func (*Scope) GetProviderConfigReference ¶
GetProviderConfigReference of this Scope.
func (*Scope) GetPublishConnectionDetailsTo ¶
func (mg *Scope) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Scope.
func (*Scope) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Scope
func (*Scope) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Scope) GetWriteConnectionSecretToReference ¶
func (mg *Scope) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Scope.
func (*Scope) LateInitialize ¶
LateInitialize this Scope using its observed tfState. returns True if there are any spec changes for the resource.
func (*Scope) ResolveReferences ¶
ResolveReferences of this Scope.
func (*Scope) SetConditions ¶
SetConditions of this Scope.
func (*Scope) SetDeletionPolicy ¶
func (mg *Scope) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Scope.
func (*Scope) SetManagementPolicies ¶
func (mg *Scope) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Scope.
func (*Scope) SetObservation ¶
SetObservation for this Scope
func (*Scope) SetParameters ¶
SetParameters for this Scope
func (*Scope) SetProviderConfigReference ¶
SetProviderConfigReference of this Scope.
func (*Scope) SetPublishConnectionDetailsTo ¶
func (mg *Scope) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Scope.
func (*Scope) SetWriteConnectionSecretToReference ¶
func (mg *Scope) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Scope.
type ScopeInitParameters ¶
type ScopeInitParameters struct { // (Boolean) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. // If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. AutoCreateAdminRole *bool `json:"autoCreateAdminRole,omitempty" tf:"auto_create_admin_role,omitempty"` // (Boolean) Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. // Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. AutoCreateDefaultRole *bool `json:"autoCreateDefaultRole,omitempty" tf:"auto_create_default_role,omitempty"` // (String) The scope description. // The scope description. Description *string `json:"description,omitempty" tf:"description,omitempty"` // (Boolean) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. // Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. GlobalScope *bool `json:"globalScope,omitempty" tf:"global_scope,omitempty"` // (String) The scope name. Defaults to the resource name. // The scope name. Defaults to the resource name. Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The scope ID containing the sub scope resource. // The scope ID containing the sub scope resource. // +crossplane:generate:reference:type=github.com/releaseband/crossplane-provider-boundary/apis/main/v1alpha1.Scope // +crossplane:generate:reference:extractor=github.com/crossplane/upjet/pkg/resource.ExtractParamPath("id",true) ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` // Reference to a Scope in main to populate scopeId. // +kubebuilder:validation:Optional ScopeIDRef *v1.Reference `json:"scopeIdRef,omitempty" tf:"-"` // Selector for a Scope in main to populate scopeId. // +kubebuilder:validation:Optional ScopeIDSelector *v1.Selector `json:"scopeIdSelector,omitempty" tf:"-"` }
func (*ScopeInitParameters) DeepCopy ¶
func (in *ScopeInitParameters) DeepCopy() *ScopeInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeInitParameters.
func (*ScopeInitParameters) DeepCopyInto ¶
func (in *ScopeInitParameters) DeepCopyInto(out *ScopeInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScopeList ¶
type ScopeList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Scope `json:"items"` }
ScopeList contains a list of Scopes
func (*ScopeList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeList.
func (*ScopeList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ScopeList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ScopeObservation ¶
type ScopeObservation struct { // (Boolean) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. // If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. AutoCreateAdminRole *bool `json:"autoCreateAdminRole,omitempty" tf:"auto_create_admin_role,omitempty"` // (Boolean) Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. // Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. AutoCreateDefaultRole *bool `json:"autoCreateDefaultRole,omitempty" tf:"auto_create_default_role,omitempty"` // (String) The scope description. // The scope description. Description *string `json:"description,omitempty" tf:"description,omitempty"` // (Boolean) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. // Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. GlobalScope *bool `json:"globalScope,omitempty" tf:"global_scope,omitempty"` // (String) The ID of the scope. ID *string `json:"id,omitempty" tf:"id,omitempty"` // (String) The scope name. Defaults to the resource name. // The scope name. Defaults to the resource name. Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The scope ID containing the sub scope resource. // The scope ID containing the sub scope resource. ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` }
func (*ScopeObservation) DeepCopy ¶
func (in *ScopeObservation) DeepCopy() *ScopeObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeObservation.
func (*ScopeObservation) DeepCopyInto ¶
func (in *ScopeObservation) DeepCopyInto(out *ScopeObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScopeParameters ¶
type ScopeParameters struct { // (Boolean) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. // If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. // +kubebuilder:validation:Optional AutoCreateAdminRole *bool `json:"autoCreateAdminRole,omitempty" tf:"auto_create_admin_role,omitempty"` // (Boolean) Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. // Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. // +kubebuilder:validation:Optional AutoCreateDefaultRole *bool `json:"autoCreateDefaultRole,omitempty" tf:"auto_create_default_role,omitempty"` // (String) The scope description. // The scope description. // +kubebuilder:validation:Optional Description *string `json:"description,omitempty" tf:"description,omitempty"` // (Boolean) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. // Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. // +kubebuilder:validation:Optional GlobalScope *bool `json:"globalScope,omitempty" tf:"global_scope,omitempty"` // (String) The scope name. Defaults to the resource name. // The scope name. Defaults to the resource name. // +kubebuilder:validation:Optional Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The scope ID containing the sub scope resource. // The scope ID containing the sub scope resource. // +crossplane:generate:reference:type=github.com/releaseband/crossplane-provider-boundary/apis/main/v1alpha1.Scope // +crossplane:generate:reference:extractor=github.com/crossplane/upjet/pkg/resource.ExtractParamPath("id",true) // +kubebuilder:validation:Optional ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` // Reference to a Scope in main to populate scopeId. // +kubebuilder:validation:Optional ScopeIDRef *v1.Reference `json:"scopeIdRef,omitempty" tf:"-"` // Selector for a Scope in main to populate scopeId. // +kubebuilder:validation:Optional ScopeIDSelector *v1.Selector `json:"scopeIdSelector,omitempty" tf:"-"` }
func (*ScopeParameters) DeepCopy ¶
func (in *ScopeParameters) DeepCopy() *ScopeParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeParameters.
func (*ScopeParameters) DeepCopyInto ¶
func (in *ScopeParameters) DeepCopyInto(out *ScopeParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScopeSpec ¶
type ScopeSpec struct { v1.ResourceSpec `json:",inline"` ForProvider ScopeParameters `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 ScopeInitParameters `json:"initProvider,omitempty"` }
ScopeSpec defines the desired state of Scope
func (*ScopeSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeSpec.
func (*ScopeSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScopeStatus ¶
type ScopeStatus struct { v1.ResourceStatus `json:",inline"` AtProvider ScopeObservation `json:"atProvider,omitempty"` }
ScopeStatus defines the observed state of Scope.
func (*ScopeStatus) DeepCopy ¶
func (in *ScopeStatus) DeepCopy() *ScopeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeStatus.
func (*ScopeStatus) DeepCopyInto ¶
func (in *ScopeStatus) DeepCopyInto(out *ScopeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.