Documentation

Index

Constants

View Source
const (
	// BOSHDeploymentResourceKind is the kind name of BOSHDeployment
	BOSHDeploymentResourceKind = "BOSHDeployment"
	// BOSHDeploymentResourcePlural is the plural name of BOSHDeployment
	BOSHDeploymentResourcePlural = "boshdeployments"
)
View Source
const (
	// ConfigMapReference represents ConfigMap reference
	ConfigMapReference ReferenceType = "configmap"
	// SecretReference represents Secret reference
	SecretReference ReferenceType = "secret"
	// URLReference represents URL reference
	URLReference ReferenceType = "url"

	ManifestSpecName        string = "manifest"
	OpsSpecName             string = "ops"
	ImplicitVariableKeyName string = "value"
)

    Valid values for ref types

    Variables

    View Source
    var (
    
    	// AddToScheme is used for schema registrations in the controller package
    	// and also in the generated kube code
    	AddToScheme = schemeBuilder.AddToScheme
    
    	// BOSHDeploymentResourceShortNames is the short names of BOSHDeployment
    	BOSHDeploymentResourceShortNames = []string{"bdpl", "bdpls"}
    	// BOSHDeploymentValidation is the validation method for BOSHDeployment
    	BOSHDeploymentValidation = extv1.CustomResourceValidation{
    		OpenAPIV3Schema: &extv1.JSONSchemaProps{
    			Type: "object",
    			Properties: map[string]extv1.JSONSchemaProps{
    				"spec": {
    					Type: "object",
    					Properties: map[string]extv1.JSONSchemaProps{
    						"manifest": {
    							Type: "object",
    							Properties: map[string]extv1.JSONSchemaProps{
    								"name": {
    									Type:      "string",
    									MinLength: pointers.Int64(1),
    								},
    								"type": {
    									Type: "string",
    									Enum: []extv1.JSON{
    										{
    											Raw: []byte(`"configmap"`),
    										},
    										{
    											Raw: []byte(`"secret"`),
    										},
    										{
    											Raw: []byte(`"url"`),
    										},
    									},
    								},
    							},
    							Required: []string{
    								"type",
    								"name",
    							},
    						},
    						"ops": {
    							Type: "array",
    							Items: &extv1.JSONSchemaPropsOrArray{
    								Schema: &extv1.JSONSchemaProps{
    									Type: "object",
    									Properties: map[string]extv1.JSONSchemaProps{
    										"name": {
    											Type:      "string",
    											MinLength: pointers.Int64(1),
    										},
    										"type": {
    											Type: "string",
    											Enum: []extv1.JSON{
    												{
    													Raw: []byte(`"configmap"`),
    												},
    												{
    													Raw: []byte(`"secret"`),
    												},
    												{
    													Raw: []byte(`"url"`),
    												},
    											},
    										},
    									},
    									Required: []string{
    										"type",
    										"name",
    									},
    								},
    							},
    						},
    					},
    					Required: []string{
    						"manifest",
    					},
    				},
    			},
    		},
    	}
    
    	// BOSHDeploymentResourceName is the resource name of BOSHDeployment
    	BOSHDeploymentResourceName = fmt.Sprintf("%s.%s", BOSHDeploymentResourcePlural, apis.GroupName)
    
    	// SchemeGroupVersion is group version used to register these objects
    	SchemeGroupVersion = schema.GroupVersion{Group: apis.GroupName, Version: "v1alpha1"}
    )
    View Source
    var (
    	// LabelDeploymentName is the label key for manifest name
    	LabelDeploymentName = fmt.Sprintf("%s/deployment-name", apis.GroupName)
    	// LabelDeploymentSecretType is the label key for secret type
    	LabelDeploymentSecretType = fmt.Sprintf("%s/secret-type", apis.GroupName)
    	// AnnotationLinkProviderName is the annotation key for link provider name
    	AnnotationLinkProviderName = fmt.Sprintf("%s/link-provider-name", apis.GroupName)
    	// AnnotationLinkProviderType is the annotation key for link provider type
    	AnnotationLinkProviderType = fmt.Sprintf("%s/link-provider-type", apis.GroupName)
    )

    Functions

    func Kind

    func Kind(kind string) schema.GroupKind

      Kind takes an unqualified kind and returns back a Group qualified GroupKind

      func Resource

      func Resource(resource string) schema.GroupResource

        Resource takes an unqualified resource and returns a Group qualified GroupResource

        Types

        type BOSHDeployment

        type BOSHDeployment struct {
        	metav1.TypeMeta   `json:",inline"`
        	metav1.ObjectMeta `json:"metadata,omitempty"`
        
        	Spec   BOSHDeploymentSpec   `json:"spec,omitempty"`
        	Status BOSHDeploymentStatus `json:"status,omitempty"`
        }

          BOSHDeployment is the Schema for the boshdeployments API +k8s:openapi-gen=true

          func (*BOSHDeployment) DeepCopy

          func (in *BOSHDeployment) DeepCopy() *BOSHDeployment

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

            func (*BOSHDeployment) DeepCopyInto

            func (in *BOSHDeployment) DeepCopyInto(out *BOSHDeployment)

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

              func (*BOSHDeployment) DeepCopyObject

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

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

                type BOSHDeploymentList

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

                  BOSHDeploymentList contains a list of BOSHDeployment

                  func (*BOSHDeploymentList) DeepCopy

                  func (in *BOSHDeploymentList) DeepCopy() *BOSHDeploymentList

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

                    func (*BOSHDeploymentList) DeepCopyInto

                    func (in *BOSHDeploymentList) DeepCopyInto(out *BOSHDeploymentList)

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

                      func (*BOSHDeploymentList) DeepCopyObject

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

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

                        type BOSHDeploymentSpec

                        type BOSHDeploymentSpec struct {
                        	Manifest ResourceReference   `json:"manifest"`
                        	Ops      []ResourceReference `json:"ops,omitempty"`
                        }

                          BOSHDeploymentSpec defines the desired state of BOSHDeployment

                          func (*BOSHDeploymentSpec) DeepCopy

                          func (in *BOSHDeploymentSpec) DeepCopy() *BOSHDeploymentSpec

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

                            func (*BOSHDeploymentSpec) DeepCopyInto

                            func (in *BOSHDeploymentSpec) DeepCopyInto(out *BOSHDeploymentSpec)

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

                              type BOSHDeploymentStatus

                              type BOSHDeploymentStatus struct {
                              	// Timestamp for the last reconcile
                              	LastReconcile *metav1.Time `json:"lastReconcile"`
                              }

                                BOSHDeploymentStatus defines the observed state of BOSHDeployment

                                func (*BOSHDeploymentStatus) DeepCopy

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

                                  func (*BOSHDeploymentStatus) DeepCopyInto

                                  func (in *BOSHDeploymentStatus) DeepCopyInto(out *BOSHDeploymentStatus)

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

                                    type ReferenceType

                                    type ReferenceType = string

                                      ReferenceType lists all the types of Reference we can supports

                                      type ResourceReference

                                      type ResourceReference struct {
                                      	Name string        `json:"name"`
                                      	Type ReferenceType `json:"type"`
                                      }

                                        ResourceReference defines the resource reference type and location

                                        func (*ResourceReference) DeepCopy

                                        func (in *ResourceReference) DeepCopy() *ResourceReference

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

                                          func (*ResourceReference) DeepCopyInto

                                          func (in *ResourceReference) DeepCopyInto(out *ResourceReference)

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