v1

Documentation

Overview

Package v1 contains API Schema definitions for the control-api v1 API group +kubebuilder:object:generate=true +kubebuilder:skip +groupName=organization.appuio.io

Index

• Constants
• Variables
• type Organization
  • func NewOrganizationFromNS(ns *corev1.Namespace) *Organization
  • func (in *Organization) DeepCopy() *Organization
  • func (in *Organization) DeepCopyInto(out *Organization)
  • func (in *Organization) DeepCopyObject() runtime.Object
  • func (o *Organization) GetGroupVersionResource() schema.GroupVersionResource
  • func (o *Organization) GetObjectMeta() *metav1.ObjectMeta
  • func (o *Organization) IsStorageVersion() bool
  • func (o *Organization) NamespaceScoped() bool
  • func (o *Organization) New() runtime.Object
  • func (o *Organization) NewList() runtime.Object
  • func (o *Organization) ToNamespace() *corev1.Namespace
• type OrganizationList
  • func (in *OrganizationList) DeepCopy() *OrganizationList
  • func (in *OrganizationList) DeepCopyInto(out *OrganizationList)
  • func (in *OrganizationList) DeepCopyObject() runtime.Object
  • func (in *OrganizationList) GetListMeta() *metav1.ListMeta
• type OrganizationSpec
  • func (in *OrganizationSpec) DeepCopy() *OrganizationSpec
  • func (in *OrganizationSpec) DeepCopyInto(out *OrganizationSpec)
• type OrganizationStatus
  • func (in *OrganizationStatus) DeepCopy() *OrganizationStatus
  • func (in *OrganizationStatus) DeepCopyInto(out *OrganizationStatus)

Constants

const (
	// SaleOrderCreated is set when the Sale Order has been created
	ConditionSaleOrderCreated = "SaleOrderCreated"

	// SaleOrderNameUpdated is set when the Sale Order's name has been added to the Status
	ConditionSaleOrderNameUpdated = "SaleOrderNameUpdated"

	ConditionReasonCreateFailed = "CreateFailed"

	ConditionReasonGetNameFailed = "GetNameFailed"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "organization.appuio.io", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var (
	// TypeKey is the label key to identify organization namespaces
	TypeKey = "appuio.io/resource.type"
	// OrgType is the label value to identify organization namespaces
	OrgType = "organization"
	// DisplayNameKey is the annotation key that stores the display name
	DisplayNameKey = "organization.appuio.io/display-name"
	// BillingEntityRefKey is the annotation key that stores the billing entity reference
	BillingEntityRefKey = "organization.appuio.io/billing-entity-ref"
	// BillingEntityNameKey is the annotation key that stores the billing entity name
	BillingEntityNameKey = "status.organization.appuio.io/billing-entity-name"
	// SalesOrderIdKey is the annotation key that stores the sale order ID
	SalesOrderIdKey = "status.organization.appuio.io/sales-order-id"
	// SalesOrderNameKey is the annotation key that stores the sale order name
	SalesOrderNameKey = "status.organization.appuio.io/sales-order-name"
	// StatusConditionsKey is the annotation key that stores the serialized status conditions
	StatusConditionsKey = "status.organization.appuio.io/conditions"
)

Types

type Organization

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

	// Spec holds the cluster specific metadata.
	Spec OrganizationSpec `json:"spec,omitempty"`
	// Status holds the organization specific status
	Status OrganizationStatus `json:"status,omitempty"`
}

Organization is a representation of an APPUiO Cloud Organization

func NewOrganizationFromNS

func NewOrganizationFromNS(ns *corev1.Namespace) *Organization

NewOrganizationFromNS returns an Organization based on the given namespace If the namespace does not represent an organization it will return nil

func (*Organization) DeepCopy

func (in *Organization) DeepCopy() *Organization

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

func (*Organization) DeepCopyInto

func (in *Organization) DeepCopyInto(out *Organization)

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

func (*Organization) DeepCopyObject

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

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

func (*Organization) GetGroupVersionResource

func (o *Organization) GetGroupVersionResource() schema.GroupVersionResource

GetGroupVersionResource returns the GroupVersionResource for this resource. The resource should be the all lowercase and pluralized kind

func (*Organization) GetObjectMeta

func (o *Organization) GetObjectMeta() *metav1.ObjectMeta

GetObjectMeta returns the objects meta reference.

func (*Organization) IsStorageVersion

func (o *Organization) IsStorageVersion() bool

IsStorageVersion returns true if the object is also the internal version -- i.e. is the type defined for the API group or an alias to this object. If false, the resource is expected to implement MultiVersionObject interface.

func (*Organization) NamespaceScoped

func (o *Organization) NamespaceScoped() bool

NamespaceScoped returns true if the object is namespaced

func (*Organization) New

func (o *Organization) New() runtime.Object

New returns a new instance of the resource

func (*Organization) NewList

func (o *Organization) NewList() runtime.Object

NewList return a new list instance of the resource

func (*Organization) ToNamespace

func (o *Organization) ToNamespace() *corev1.Namespace

ToNamespace translates an Organization to the underlying namespace representation

type OrganizationList

type OrganizationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

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

OrganizationList contains a list of Organizations

func (*OrganizationList) DeepCopy

func (in *OrganizationList) DeepCopy() *OrganizationList

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

func (*OrganizationList) DeepCopyInto

func (in *OrganizationList) DeepCopyInto(out *OrganizationList)

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

func (*OrganizationList) DeepCopyObject

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

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

func (*OrganizationList) GetListMeta

func (in *OrganizationList) GetListMeta() *metav1.ListMeta

GetListMeta returns the list meta reference.

type OrganizationSpec

type OrganizationSpec struct {
	// DisplayName is a human-friendly name
	DisplayName string `json:"displayName,omitempty"`

	// BillingEntityRef is the reference to the billing entity
	BillingEntityRef string `json:"billingEntityRef,omitempty"`
}

OrganizationSpec defines the desired state of the Organization

func (*OrganizationSpec) DeepCopy

func (in *OrganizationSpec) DeepCopy() *OrganizationSpec

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

func (*OrganizationSpec) DeepCopyInto

func (in *OrganizationSpec) DeepCopyInto(out *OrganizationSpec)

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

type OrganizationStatus

type OrganizationStatus struct {
	// BillingEntityName is the name of the billing entity
	BillingEntityName string `json:"billingEntityName,omitempty"`

	// SalesOrderID is the ID of the sale order
	SalesOrderID string `json:"salesOrderId,omitempty"`

	// SalesOrderName is the name of the sale order
	SalesOrderName string `json:"salesOrderName,omitempty"`

	// Conditions is a list of conditions for the invitation
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

func (*OrganizationStatus) DeepCopy

func (in *OrganizationStatus) DeepCopy() *OrganizationStatus

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

func (*OrganizationStatus) DeepCopyInto

func (in *OrganizationStatus) DeepCopyInto(out *OrganizationStatus)

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