Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package v1alpha3 contains API Schema definitions for the v1alpha3 API group +kubebuilder:object:generate=true +groupName=radapp.io
Index ¶
- Constants
 - Variables
 - type DeploymentResource
 - type DeploymentResourceList
 - type DeploymentResourcePhrase
 - type DeploymentResourceSpec
 - type DeploymentResourceStatus
 - type DeploymentTemplate
 - type DeploymentTemplateList
 - type DeploymentTemplatePhrase
 - type DeploymentTemplateSpec
 - type DeploymentTemplateStatus
 - type OperationKind
 - type Recipe
 - type RecipeList
 - type RecipePhrase
 - type RecipeSpec
 - type RecipeStatus
 - type 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 )
Functions ¶
This section is empty.
Types ¶
type DeploymentResource ¶ added in v0.43.0
type DeploymentResource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   DeploymentResourceSpec   `json:"spec,omitempty"`
	Status DeploymentResourceStatus `json:"status,omitempty"`
}
    DeploymentResource is the Schema for the DeploymentResources API
func (*DeploymentResource) DeepCopy ¶ added in v0.43.0
func (in *DeploymentResource) DeepCopy() *DeploymentResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentResource.
func (*DeploymentResource) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentResource) DeepCopyInto(out *DeploymentResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DeploymentResource) DeepCopyObject ¶ added in v0.43.0
func (in *DeploymentResource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentResourceList ¶ added in v0.43.0
type DeploymentResourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DeploymentResource `json:"items"`
}
    DeploymentResourceList contains a list of DeploymentResource
func (*DeploymentResourceList) DeepCopy ¶ added in v0.43.0
func (in *DeploymentResourceList) DeepCopy() *DeploymentResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentResourceList.
func (*DeploymentResourceList) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentResourceList) DeepCopyInto(out *DeploymentResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DeploymentResourceList) DeepCopyObject ¶ added in v0.43.0
func (in *DeploymentResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentResourcePhrase ¶ added in v0.43.0
type DeploymentResourcePhrase string
DeploymentResourcePhrase is a string representation of the current status of a Deployment Resource.
const ( // DeploymentResourcePhraseReady indicates that the Deployment Resource is ready. DeploymentResourcePhraseReady DeploymentResourcePhrase = "Ready" // DeploymentResourcePhraseFailed indicates that the Deployment Resource has failed. DeploymentResourcePhraseFailed DeploymentResourcePhrase = "Failed" // DeploymentResourcePhraseDeleting indicates that the Deployment Resource is being deleted. DeploymentResourcePhraseDeleting DeploymentResourcePhrase = "Deleting" // DeploymentResourcePhraseDeleted indicates that the Deployment Resource has been deleted. DeploymentResourcePhraseDeleted DeploymentResourcePhrase = "Deleted" )
type DeploymentResourceSpec ¶ added in v0.43.0
type DeploymentResourceSpec struct {
	// Id is the resource id of the Radius resource.
	Id string `json:"id,omitempty"`
}
    DeploymentResourceSpec defines the desired state of a DeploymentResource resource.
func (*DeploymentResourceSpec) DeepCopy ¶ added in v0.43.0
func (in *DeploymentResourceSpec) DeepCopy() *DeploymentResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentResourceSpec.
func (*DeploymentResourceSpec) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentResourceSpec) DeepCopyInto(out *DeploymentResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeploymentResourceStatus ¶ added in v0.43.0
type DeploymentResourceStatus struct {
	// Id is the resource id of the Radius resource.
	Id string `json:"id,omitempty"`
	// ObservedGeneration is the most recent generation observed for this DeploymentResource.
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"`
	// Operation tracks the status of an in-progress provisioning operation.
	Operation *ResourceOperation `json:"operation,omitempty"`
	// Phrase indicates the current status of the Deployment Resource.
	Phrase DeploymentResourcePhrase `json:"phrase,omitempty"`
}
    DeploymentResourceStatus defines the observed state of a DeploymentResource resource.
func (*DeploymentResourceStatus) DeepCopy ¶ added in v0.43.0
func (in *DeploymentResourceStatus) DeepCopy() *DeploymentResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentResourceStatus.
func (*DeploymentResourceStatus) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentResourceStatus) DeepCopyInto(out *DeploymentResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeploymentTemplate ¶ added in v0.43.0
type DeploymentTemplate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   DeploymentTemplateSpec   `json:"spec,omitempty"`
	Status DeploymentTemplateStatus `json:"status,omitempty"`
}
    DeploymentTemplate is the Schema for the deploymenttemplates API
func (*DeploymentTemplate) DeepCopy ¶ added in v0.43.0
func (in *DeploymentTemplate) DeepCopy() *DeploymentTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentTemplate.
func (*DeploymentTemplate) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentTemplate) DeepCopyInto(out *DeploymentTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DeploymentTemplate) DeepCopyObject ¶ added in v0.43.0
func (in *DeploymentTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentTemplateList ¶ added in v0.43.0
type DeploymentTemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DeploymentTemplate `json:"items"`
}
    DeploymentTemplateList contains a list of DeploymentTemplate
func (*DeploymentTemplateList) DeepCopy ¶ added in v0.43.0
func (in *DeploymentTemplateList) DeepCopy() *DeploymentTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentTemplateList.
func (*DeploymentTemplateList) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentTemplateList) DeepCopyInto(out *DeploymentTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DeploymentTemplateList) DeepCopyObject ¶ added in v0.43.0
func (in *DeploymentTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DeploymentTemplatePhrase ¶ added in v0.43.0
type DeploymentTemplatePhrase string
DeploymentTemplatePhrase is a string representation of the current status of a Deployment Template.
const ( // DeploymentTemplatePhraseUpdating indicates that the Deployment Template is being updated. DeploymentTemplatePhraseUpdating DeploymentTemplatePhrase = "Updating" // DeploymentTemplatePhraseReady indicates that the Deployment Template is ready. DeploymentTemplatePhraseReady DeploymentTemplatePhrase = "Ready" // DeploymentTemplatePhraseFailed indicates that the Deployment Template has failed. DeploymentTemplatePhraseFailed DeploymentTemplatePhrase = "Failed" // DeploymentTemplatePhraseDeleting indicates that the Deployment Template is being deleted. DeploymentTemplatePhraseDeleting DeploymentTemplatePhrase = "Deleting" // DeploymentTemplatePhraseDeleted indicates that the Deployment Template has been deleted. DeploymentTemplatePhraseDeleted DeploymentTemplatePhrase = "Deleted" )
type DeploymentTemplateSpec ¶ added in v0.43.0
type DeploymentTemplateSpec struct {
	// Template is the ARM JSON manifest that defines the resources to deploy.
	Template string `json:"template,omitempty"`
	// Parameters is the ARM JSON parameters for the template.
	Parameters map[string]string `json:"parameters,omitempty"`
	// ProviderConfig specifies the scopes for resources.
	ProviderConfig string `json:"providerConfig,omitempty"`
	// Repository is the git repository that the Bicep manifests are stored in.
	Repository string `json:"repository,omitempty"`
}
    DeploymentTemplateSpec defines the desired state of a DeploymentTemplate resource.
func (*DeploymentTemplateSpec) DeepCopy ¶ added in v0.43.0
func (in *DeploymentTemplateSpec) DeepCopy() *DeploymentTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentTemplateSpec.
func (*DeploymentTemplateSpec) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentTemplateSpec) DeepCopyInto(out *DeploymentTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DeploymentTemplateStatus ¶ added in v0.43.0
type DeploymentTemplateStatus struct {
	// ObservedGeneration is the most recent generation observed for this DeploymentTemplate.
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"`
	// StatusHash is a hash of the DeploymentTemplate's state (template, parameters, and provider config).
	StatusHash string `json:"statusHash,omitempty"`
	// OutputResources is a list of the resourceIDs that were created by the template on the last deployment.
	OutputResources []string `json:"outputResources,omitempty"`
	// Operation tracks the status of an in-progress provisioning operation.
	Operation *ResourceOperation `json:"operation,omitempty"`
	// Phrase indicates the current status of the Deployment Template.
	Phrase DeploymentTemplatePhrase `json:"phrase,omitempty"`
}
    DeploymentTemplateStatus defines the observed state of a DeploymentTemplate resource.
func (*DeploymentTemplateStatus) DeepCopy ¶ added in v0.43.0
func (in *DeploymentTemplateStatus) DeepCopy() *DeploymentTemplateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentTemplateStatus.
func (*DeploymentTemplateStatus) DeepCopyInto ¶ added in v0.43.0
func (in *DeploymentTemplateStatus) DeepCopyInto(out *DeploymentTemplateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Recipe.
func (*Recipe) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Recipe) DeepCopyObject ¶
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.