Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the ibmcloud v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/ibm/cos-bucket-operator/pkg/apis/ibmcloud +k8s:defaulter-gen=TypeMeta +groupName=ibmcloud.ibm.com
Package v1alpha1 contains API Schema definitions for the ibmcloud v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/ibm/cos-bucket-operator/pkg/apis/ibmcloud +k8s:defaulter-gen=TypeMeta +groupName=ibmcloud.ibm.com
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "ibmcloud.ibm.com", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is required by pkg/client/... AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource is required by pkg/client/listers/...
Types ¶
type Bucket ¶
type Bucket struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BucketSpec `json:"spec,omitempty"` Status BucketStatus `json:"status,omitempty"` }
Bucket is the Schema for the buckets API +k8s:openapi-gen=true +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.state" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status
func (*Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bucket.
func (*Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Bucket) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BucketList ¶
type BucketList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Bucket `json:"items"` }
BucketList contains a list of Bucket
func (*BucketList) DeepCopy ¶
func (in *BucketList) DeepCopy() *BucketList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketList.
func (*BucketList) DeepCopyInto ¶
func (in *BucketList) DeepCopyInto(out *BucketList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BucketList) DeepCopyObject ¶
func (in *BucketList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BucketSpec ¶
type BucketSpec struct { BindingFrom v1.BindingFrom `json:"bindingFrom,omitempty"` APIKey *keyvalue.KeyValueSource `json:"apiKey,omitempty"` Region *keyvalue.KeyValueSource `json:"region,omitempty"` Endpoints *keyvalue.KeyValueSource `json:"endpoints,omitempty"` ResourceInstanceID *keyvalue.KeyValueSource `json:"resourceInstanceID,omitempty"` Resiliency string `json:"resiliency,omitempty"` // Default to regional Location string `json:"location,omitempty"` // Default to us-south BucketType string `json:"bucketType,omitempty"` // Default to public StorageClass string `json:"storageClass,omitempty"` // Default to standard KeyProtect *KeyProtectInfo `json:"keyProtect,omitempty"` CORSRules CORSRule `json:"corsRules,omitempty"` KeepIfNotEmpty bool `json:"keepIfNotEmpty,omitempty"` // Default to true Context v1.ResourceContext `json:"context,omitempty"` BindOnly bool `json:"bindOnly,omitempty"` // Default to false RetentionPolicy RetentionPolicy `json:"retentionPolicy,omitempty"` }
BucketSpec defines the desired state of Bucket
func (*BucketSpec) DeepCopy ¶
func (in *BucketSpec) DeepCopy() *BucketSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketSpec.
func (*BucketSpec) DeepCopyInto ¶
func (in *BucketSpec) DeepCopyInto(out *BucketSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BucketStatus ¶
type BucketStatus struct {
resv1.ResourceStatus `json:",inline"`
}
BucketStatus defines the observed state of Bucket
func (*BucketStatus) DeepCopy ¶
func (in *BucketStatus) DeepCopy() *BucketStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketStatus.
func (*BucketStatus) DeepCopyInto ¶
func (in *BucketStatus) DeepCopyInto(out *BucketStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CORSRule ¶
type CORSRule struct { AllowedOrigin string `json:"allowedOrigin,omitempty"` // Default to * AllowedHeader string `json:"allowedHeader,omitempty"` // Default to * AllowedMethods []string `json:"allowedMethods,omitempty"` // Default to Post, Get, Put }
CORSRule Rules for CORS
func (*CORSRule) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CORSRule.
func (*CORSRule) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeyProtectInfo ¶
type KeyProtectInfo struct { InstanceName string `json:"instanceName,omitempty"` InstanceID string `json:"instanceID,omitempty"` InstanceLocation string `json:"instanceLocation,omitempty"` KeyName string `json:"keyName"` BindingFrom v1.BindingFrom `json:"bindingFrom,omitempty"` APIKey *keyvalue.KeyValueSource `json:"apiKey,omitempty"` }
KeyProtectInfo the KeyProtect Instance can be found from BindingObject specified in BindingFrom, or directly from InstanceName or InstanceID
func (*KeyProtectInfo) DeepCopy ¶
func (in *KeyProtectInfo) DeepCopy() *KeyProtectInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyProtectInfo.
func (*KeyProtectInfo) DeepCopyInto ¶
func (in *KeyProtectInfo) DeepCopyInto(out *KeyProtectInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeyReference ¶
type KeyReference struct { Name string `json:"name"` Key string `json:"key"` Namespace string `json:"namespace,omitempty"` }
KeyReference name value pair
func (*KeyReference) DeepCopy ¶
func (in *KeyReference) DeepCopy() *KeyReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyReference.
func (*KeyReference) DeepCopyInto ¶
func (in *KeyReference) DeepCopyInto(out *KeyReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ParametersFromSource ¶
type ParametersFromSource struct { // Selects a key of a ConfigMap. // +optional ConfigMapKeyRef *KeyReference `json:"configMapKeyRef,omitempty"` // Selects a key of a secret in the resource namespace // +optional SecretKeyRef *KeyReference `json:"secretKeyRef,omitempty"` }
ParametersFromSource Parameters value from Source: ConfigMap or Secret
func (*ParametersFromSource) DeepCopy ¶
func (in *ParametersFromSource) DeepCopy() *ParametersFromSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParametersFromSource.
func (*ParametersFromSource) DeepCopyInto ¶
func (in *ParametersFromSource) DeepCopyInto(out *ParametersFromSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RetentionPolicy ¶
type RetentionPolicy struct { MinimumRetentionDay int `json:"minimumRetentionDay,omitempty"` MaximumRetentionDay int `json:"maximumRetentionDay,omitempty"` DefaultRetentionDay int `json:"defaultRetentionDay,omitempty"` }
RetentionPolicy Policy for Retention
func (*RetentionPolicy) DeepCopy ¶
func (in *RetentionPolicy) DeepCopy() *RetentionPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetentionPolicy.
func (*RetentionPolicy) DeepCopyInto ¶
func (in *RetentionPolicy) DeepCopyInto(out *RetentionPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.