v1alpha3

Documentation

Overview

Package v1alpha3 contains API Schema definitions for the v1alpha3 API group +kubebuilder:object:generate=true +groupName=radapp.io

Index

• Constants
• Variables
• type OperationKind
• type Recipe
  • func (in *Recipe) DeepCopy() *Recipe
  • func (in *Recipe) DeepCopyInto(out *Recipe)
  • func (in *Recipe) DeepCopyObject() runtime.Object
• type RecipeList
  • func (in *RecipeList) DeepCopy() *RecipeList
  • func (in *RecipeList) DeepCopyInto(out *RecipeList)
  • func (in *RecipeList) DeepCopyObject() runtime.Object
• type RecipePhrase
• type RecipeSpec
  • func (in *RecipeSpec) DeepCopy() *RecipeSpec
  • func (in *RecipeSpec) DeepCopyInto(out *RecipeSpec)
• type RecipeStatus
  • func (in *RecipeStatus) DeepCopy() *RecipeStatus
  • func (in *RecipeStatus) DeepCopyInto(out *RecipeStatus)
• type ResourceOperation
  • func (in *ResourceOperation) DeepCopy() *ResourceOperation
  • func (in *ResourceOperation) DeepCopyInto(out *ResourceOperation)

Constants

const (
	// OperationKindPut is a PUT (create or update) operation.
	OperationKindPut = http.MethodPut

	// OperationKindDelete is a DELETE operation.
	OperationKindDelete = http.MethodDelete
)

Variables

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

	// 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
)

Types

type OperationKind

type OperationKind string

OperationKind is the type of operation being performed.

type Recipe

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

	Spec   RecipeSpec   `json:"spec,omitempty"`
	Status RecipeStatus `json:"status,omitempty"`
}

Recipe is the Schema for the recipes API

func (*Recipe) DeepCopy

func (in *Recipe) DeepCopy() *Recipe

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

func (*Recipe) DeepCopyInto

func (in *Recipe) DeepCopyInto(out *Recipe)

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

func (*Recipe) DeepCopyObject

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

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

type RecipeList

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

RecipeList contains a list of Recipe

func (*RecipeList) DeepCopy

func (in *RecipeList) DeepCopy() *RecipeList

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

func (*RecipeList) DeepCopyInto

func (in *RecipeList) DeepCopyInto(out *RecipeList)

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

func (*RecipeList) DeepCopyObject

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

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

type RecipePhrase

type RecipePhrase string

RecipePhrase is a string representation of the current status of a Recipe.

const (
	// PhraseUpdating indicates that the Recipe is being updated.
	PhraseUpdating RecipePhrase = "Updating"

	// PhraseReady indicates that the Recipe is ready.
	PhraseReady RecipePhrase = "Ready"

	// PhraseFailed indicates that the Recipe has failed.
	PhraseFailed RecipePhrase = "Failed"

	// PhraseDeleting indicates that the Recipe is being deleted.
	PhraseDeleting RecipePhrase = "Deleting"

	// PhraseDeleted indicates that the Recipe has been deleted.
	PhraseDeleted RecipePhrase = "Deleted"
)

type RecipeSpec

type RecipeSpec struct {
	// Type is the type of resource to create. eg: 'Applications.Datastores/redisCaches'.
	// +kubebuilder:validation:Required
	Type string `json:"type,omitempty"`

	// SecretName is the name of a Kubernetes secret to create once the resource is created.
	// +kubebuilder:validation:Optional
	SecretName string `json:"secretName,omitempty"`

	// Environment is the name of the Radius environment to use. If unset the value 'default' will be
	// used as the environment name.
	Environment string `json:"environment,omitempty"`

	// Application is the name of the Radius application to use. If unset the namespace of the
	// Recipe will be used as the application name.
	Application string `json:"application,omitempty"`
}

RecipeSpec defines the desired state of Recipe

func (*RecipeSpec) DeepCopy

func (in *RecipeSpec) DeepCopy() *RecipeSpec

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

func (*RecipeSpec) DeepCopyInto

func (in *RecipeSpec) DeepCopyInto(out *RecipeSpec)

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

type RecipeStatus

type RecipeStatus struct {
	// ObservedGeneration is the most recent generation observed for this Recipe. It corresponds to the
	// Recipe's generation, which is updated on mutation by the API Server.
	// +kubebuilder:validation:Optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"`

	// Application is the resource ID of the application.
	// +kubebuilder:validation:Optional
	Application string `json:"application,omitempty"`

	// Environment is the resource ID of the environment.
	// +kubebuilder:validation:Optional
	Environment string `json:"environment,omitempty"`

	// Scope is the resource ID of the scope.
	// +kubebuilder:validation:Optional
	Scope string `json:"scope,omitempty"`

	// Resource is the resource ID of the resource.
	// +kubebuilder:validation:Optional
	Resource string `json:"resource,omitempty"`

	// Operation tracks the status of an in-progress provisioning operation.
	// +kubebuilder:validation:Optional
	Operation *ResourceOperation `json:"operation,omitempty"`

	// Phrase indicates the current status of the Recipe.
	// +kubebuilder:validation:Optional
	Phrase RecipePhrase `json:"phrase,omitempty"`

	// Secret specifies a reference to the secret being managed by this Recipe.
	// +kubebuilder:validation:Optional
	Secret corev1.ObjectReference `json:"secret,omitempty"`
}

RecipeStatus defines the observed state of Recipe

func (*RecipeStatus) DeepCopy

func (in *RecipeStatus) DeepCopy() *RecipeStatus

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

func (*RecipeStatus) DeepCopyInto

func (in *RecipeStatus) DeepCopyInto(out *RecipeStatus)

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

type ResourceOperation

type ResourceOperation struct {
	// ResumeToken is a token that can be used to resume an in-progress provisioning operation.
	ResumeToken string `json:"resumeToken,omitempty"`

	// OperationKind describes the type of operation being performed.
	OperationKind OperationKind `json:"operationKind,omitempty"`
}

ResourceOperation describes the status of an in-progress provisioning operation.

func (*ResourceOperation) DeepCopy

func (in *ResourceOperation) DeepCopy() *ResourceOperation

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

func (*ResourceOperation) DeepCopyInto

func (in *ResourceOperation) DeepCopyInto(out *ResourceOperation)

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