Documentation
¶
Overview ¶
+groupName=appstudio.redhat.com Package v1alpha1 is the v1alpha1 version of the API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( GroupName = "appstudio.redhat.com" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type Build ¶
type Build struct {
// The container image that is created during the component build.
ContainerImage string `json:"containerImage"`
}
Build describes the various build artifacts associated with a given component
func (*Build) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Build.
func (*Build) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Component ¶
type Component struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ComponentSpec `json:"spec,omitempty"`
Status ComponentStatus `json:"status,omitempty"`
}
Component is the Schema for the components API +kubebuilder:resource:path=components,shortName=hascmp;hc;comp
func (*Component) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Component.
func (*Component) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Component) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ComponentList ¶
type ComponentList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Component `json:"items"`
}
ComponentList contains a list of Component
func (*ComponentList) DeepCopy ¶
func (in *ComponentList) DeepCopy() *ComponentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentList.
func (*ComponentList) DeepCopyInto ¶
func (in *ComponentList) DeepCopyInto(out *ComponentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ComponentList) DeepCopyObject ¶
func (in *ComponentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ComponentSource ¶
type ComponentSource struct {
ComponentSourceUnion `json:",inline"`
}
ComponentSource describes the Component source
func (*ComponentSource) DeepCopy ¶
func (in *ComponentSource) DeepCopy() *ComponentSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentSource.
func (*ComponentSource) DeepCopyInto ¶
func (in *ComponentSource) DeepCopyInto(out *ComponentSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentSourceUnion ¶
type ComponentSourceUnion struct {
// Git Source for a Component
GitSource *GitSource `json:"git,omitempty"`
// Image Source for a Component
ImageSource *ImageSource `json:"image,omitempty"`
}
+union
func (*ComponentSourceUnion) DeepCopy ¶
func (in *ComponentSourceUnion) DeepCopy() *ComponentSourceUnion
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentSourceUnion.
func (*ComponentSourceUnion) DeepCopyInto ¶
func (in *ComponentSourceUnion) DeepCopyInto(out *ComponentSourceUnion)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentSpec ¶
type ComponentSpec struct {
// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
// +kubebuilder:validation:MaxLength=63
// ComponentName is name of the component to be added to the HASApplication
ComponentName string `json:"componentName"`
// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
// Application to add the component to
Application string `json:"application"`
// Source describes the Component source
Source ComponentSource `json:"source"`
// A relative path inside the git repo containing the component
Context string `json:"context,omitempty"`
// List of references to ReleaseStrategies to use when releasing the component
ReleaseStrategies []string `json:"releaseStrategies,omitempty"`
// Compute Resources required by this component
Resources corev1.ResourceRequirements `json:"resources,omitempty"`
// The number of replicas to deploy the component with
Replicas int `json:"replicas,omitempty"`
// The port to expose the component over
TargetPort int `json:"targetPort,omitempty"`
// The route to expose the component with
Route string `json:"route,omitempty"`
// An array of environment variables to add to the component
Env []corev1.EnvVar `json:"env,omitempty"`
// The build artifacts associated with the component
Build Build `json:"build,omitempty"`
}
ComponentSpec defines the desired state of Component
func (*ComponentSpec) DeepCopy ¶
func (in *ComponentSpec) DeepCopy() *ComponentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentSpec.
func (*ComponentSpec) DeepCopyInto ¶
func (in *ComponentSpec) DeepCopyInto(out *ComponentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentSrcType ¶
type ComponentSrcType string
ComponentSrcType describes the type of the src for the Component. Only one of the following location type may be specified. +kubebuilder:validation:Enum=Git;Image
const ( GitComponentSrcType ComponentSrcType = "Git" ImageComponentSrcType ComponentSrcType = "Image" )
type ComponentStatus ¶
type ComponentStatus struct {
// Condition about the Component CR
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Webhook URL generated by Builds
Webhook string `json:"webhook,omitempty"`
// ContainerImage stores the associated built container image for the component
ContainerImage string `json:"containerImage,omitempty"`
// The devfile model for the Component CR
Devfile string `json:"devfile,omitempty"`
// GitOps specific status for the Component CR
GitOps GitOpsStatus `json:"gitops,omitempty"`
}
ComponentStatus defines the observed state of Component
func (*ComponentStatus) DeepCopy ¶
func (in *ComponentStatus) DeepCopy() *ComponentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentStatus.
func (*ComponentStatus) DeepCopyInto ¶
func (in *ComponentStatus) DeepCopyInto(out *ComponentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitOpsStatus ¶
type GitOpsStatus struct {
// RepositoryURL is the gitops repository URL for the component
RepositoryURL string `json:"repositoryURL,omitempty"`
// Branch is the branch used for the gitops repository
Branch string `json:"branch,omitempty"`
// Context is the path within the gitops repository used for the gitops resources
Context string `json:"context,omitempty"`
}
GitOpsStatus contains GitOps repository-specific status for the component
func (*GitOpsStatus) DeepCopy ¶
func (in *GitOpsStatus) DeepCopy() *GitOpsStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsStatus.
func (*GitOpsStatus) DeepCopyInto ¶
func (in *GitOpsStatus) DeepCopyInto(out *GitOpsStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitSource ¶
type GitSource struct {
// If importing from git, the repository to create the component from
URL string `json:"url1"`
// Secret containing a Person Access Token to clone a sample, if using private repository
Secret string `json:"secret,omitempty"`
// If specified, the devfile at the URL will be used for the component.
DevfileURL string `json:"devfileUrl,omitempty"`
}
func (*GitSource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitSource.
func (*GitSource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageSource ¶
type ImageSource struct {
// If importing from git, container image to create the component from
ContainerImage string `json:"containerImage"`
}
func (*ImageSource) DeepCopy ¶
func (in *ImageSource) DeepCopy() *ImageSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSource.
func (*ImageSource) DeepCopyInto ¶
func (in *ImageSource) DeepCopyInto(out *ImageSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.