v1

Documentation

Overview

Package v1 defines all of the versioned (v1) definitions of the Formation layer model. +groupName=formation.voyager.atl-paas.net

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• type LocationDescriptor
  • func (in *LocationDescriptor) DeepCopy() *LocationDescriptor
  • func (in *LocationDescriptor) DeepCopyInto(out *LocationDescriptor)
  • func (in *LocationDescriptor) DeepCopyObject() runtime.Object
• type LocationDescriptorConfigMapNames
  • func (in *LocationDescriptorConfigMapNames) DeepCopy() *LocationDescriptorConfigMapNames
  • func (in *LocationDescriptorConfigMapNames) DeepCopyInto(out *LocationDescriptorConfigMapNames)
• type LocationDescriptorDependency
  • func (in *LocationDescriptorDependency) DeepCopy() *LocationDescriptorDependency
  • func (ldd *LocationDescriptorDependency) DeepCopyInto(out *LocationDescriptorDependency)
  • func (ldd *LocationDescriptorDependency) UnmarshalJSON(data []byte) error
• type LocationDescriptorList
  • func (in *LocationDescriptorList) DeepCopy() *LocationDescriptorList
  • func (in *LocationDescriptorList) DeepCopyInto(out *LocationDescriptorList)
  • func (in *LocationDescriptorList) DeepCopyObject() runtime.Object
• type LocationDescriptorResource
  • func (in *LocationDescriptorResource) DeepCopy() *LocationDescriptorResource
  • func (in *LocationDescriptorResource) DeepCopyInto(out *LocationDescriptorResource)
  • func (ldr *LocationDescriptorResource) SpecIntoTyped(obj interface{}) error
• type LocationDescriptorSpec
  • func (in *LocationDescriptorSpec) DeepCopy() *LocationDescriptorSpec
  • func (in *LocationDescriptorSpec) DeepCopyInto(out *LocationDescriptorSpec)
• type LocationDescriptorStatus
  • func (in *LocationDescriptorStatus) DeepCopy() *LocationDescriptorStatus
  • func (in *LocationDescriptorStatus) DeepCopyInto(out *LocationDescriptorStatus)
  • func (lds *LocationDescriptorStatus) String() string
• type ResourceStatus
  • func (in *ResourceStatus) DeepCopy() *ResourceStatus
  • func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)

Constants

const (
	LocationDescriptorResourceSingular = "locationdescriptor"
	LocationDescriptorResourcePlural   = "locationdescriptors"
	LocationDescriptorResourceVersion  = "v1"
	LocationDescriptorResourceKind     = "LocationDescriptor"

	LocationDescriptorResourceAPIVersion = formation.GroupName + "/" + LocationDescriptorResourceVersion

	LocationDescriptorResourceName = LocationDescriptorResourcePlural + "." + formation.GroupName
)

Variables

var (
	// SchemeBuilder needs to be exported as `SchemeBuilder` so
	// the code-generation can find it.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is exposed for API installation
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: formation.GroupName, Version: LocationDescriptorResourceVersion}

SchemeGroupVersion is group version used to register these objects.

Functions

func Kind

func Kind(kind string) schema.GroupKind

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

Types

type LocationDescriptor

type LocationDescriptor struct {
	meta_v1.TypeMeta   `json:",inline"`
	meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the LocationDescriptor.
	Spec LocationDescriptorSpec `json:"spec,omitempty"`

	// Most recently observed status of the LocationDescriptor.
	Status LocationDescriptorStatus `json:"status,omitempty"`
}

LocationDescriptor is handled by LocationDescriptor controller. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*LocationDescriptor) DeepCopy

func (in *LocationDescriptor) DeepCopy() *LocationDescriptor

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

func (*LocationDescriptor) DeepCopyInto

func (in *LocationDescriptor) DeepCopyInto(out *LocationDescriptor)

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

func (*LocationDescriptor) DeepCopyObject

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

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

type LocationDescriptorConfigMapNames

type LocationDescriptorConfigMapNames struct {
	// The name of the ConfigMap containing the "release" data for variable expansion in formation processing
	Release string `json:"release"`
}

+k8s:deepcopy-gen=true

func (*LocationDescriptorConfigMapNames) DeepCopy

func (in *LocationDescriptorConfigMapNames) DeepCopy() *LocationDescriptorConfigMapNames

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

func (*LocationDescriptorConfigMapNames) DeepCopyInto

func (in *LocationDescriptorConfigMapNames) DeepCopyInto(out *LocationDescriptorConfigMapNames)

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

type LocationDescriptorDependency

type LocationDescriptorDependency struct {
	Name       voyager.ResourceName   `json:"name"`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
}

+k8s:deepcopy-gen=true

func (*LocationDescriptorDependency) DeepCopy

func (in *LocationDescriptorDependency) DeepCopy() *LocationDescriptorDependency

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

func (*LocationDescriptorDependency) DeepCopyInto

func (ldd *LocationDescriptorDependency) DeepCopyInto(out *LocationDescriptorDependency)

DeepCopyInto handle the interface{} deepcopy (which k8s can't autogen, since it doesn't know it's JSON).

func (*LocationDescriptorDependency) UnmarshalJSON

func (ldd *LocationDescriptorDependency) UnmarshalJSON(data []byte) error

UnmarshalJSON for LocationDescriptorDependency handles them being either a single resource name, or an object containing name and attributes.

type LocationDescriptorList

type LocationDescriptorList struct {
	meta_v1.TypeMeta `json:",inline"`
	meta_v1.ListMeta `json:"metadata,omitempty"`

	Items []LocationDescriptor `json:"items"`
}

LocationDescriptorList is a list of LocationDescriptors. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*LocationDescriptorList) DeepCopy

func (in *LocationDescriptorList) DeepCopy() *LocationDescriptorList

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

func (*LocationDescriptorList) DeepCopyInto

func (in *LocationDescriptorList) DeepCopyInto(out *LocationDescriptorList)

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

func (*LocationDescriptorList) DeepCopyObject

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

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

type LocationDescriptorResource

type LocationDescriptorResource struct {
	Name voyager.ResourceName `json:"name"`
	Type voyager.ResourceType `json:"type"`
	// Explicit dependencies.
	DependsOn []LocationDescriptorDependency `json:"dependsOn,omitempty"`
	// Specification of the desired behavior of the Resource.
	Spec *runtime.RawExtension `json:"spec,omitempty"`
}

+k8s:deepcopy-gen=true

func (*LocationDescriptorResource) DeepCopy

func (in *LocationDescriptorResource) DeepCopy() *LocationDescriptorResource

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

func (*LocationDescriptorResource) DeepCopyInto

func (in *LocationDescriptorResource) DeepCopyInto(out *LocationDescriptorResource)

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

func (*LocationDescriptorResource) SpecIntoTyped

func (ldr *LocationDescriptorResource) SpecIntoTyped(obj interface{}) error

SpecIntoTyped converts Raw representation of the object into a typed representation.

type LocationDescriptorSpec

type LocationDescriptorSpec struct {
	// ConfigMapName is the name of the config map to read in the LocationDescriptor's
	// namespace that will hold the LocationDescriptor configuration, e.g. tags,
	// businessUnit, notificationEmail
	ConfigMapName string `json:"configMapName"` // TODO: rename and move this to the ConfigMaps structure below

	ConfigMapNames LocationDescriptorConfigMapNames `json:"configMapNames"`

	// Resources is a list of resources that will be autowired.
	Resources []LocationDescriptorResource `json:"resources,omitempty"`
}

+k8s:deepcopy-gen=true

func (*LocationDescriptorSpec) DeepCopy

func (in *LocationDescriptorSpec) DeepCopy() *LocationDescriptorSpec

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

func (*LocationDescriptorSpec) DeepCopyInto

func (in *LocationDescriptorSpec) DeepCopyInto(out *LocationDescriptorSpec)

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

type LocationDescriptorStatus

type LocationDescriptorStatus struct {
	// Represents the latest available observations of a LocationDescriptor's current LocationDescriptor.
	Conditions       []cond_v1.Condition `json:"conditions,omitempty"`
	ResourceStatuses []ResourceStatus    `json:"resourceStatuses,omitempty"`
}

+k8s:deepcopy-gen=true

func (*LocationDescriptorStatus) DeepCopy

func (in *LocationDescriptorStatus) DeepCopy() *LocationDescriptorStatus

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

func (*LocationDescriptorStatus) DeepCopyInto

func (in *LocationDescriptorStatus) DeepCopyInto(out *LocationDescriptorStatus)

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

func (*LocationDescriptorStatus) String

func (lds *LocationDescriptorStatus) String() string

type ResourceStatus

type ResourceStatus struct {
	Name       voyager.ResourceName `json:"name,omitempty"`
	Conditions []cond_v1.Condition  `json:"conditions,omitempty"`
}

+k8s:deepcopy-gen=true

func (*ResourceStatus) DeepCopy

func (in *ResourceStatus) DeepCopy() *ResourceStatus

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

func (*ResourceStatus) DeepCopyInto

func (in *ResourceStatus) DeepCopyInto(out *ResourceStatus)

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