Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the crc v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=crc.developer.openshift.io
Package v1alpha1 contains API Schema definitions for the crc v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=crc.developer.openshift.io
Index ¶
Constants ¶
const ( // ConditionTypeVirtualMachineNotReady indicates if the VirtualMachine is not ready ConditionTypeVirtualMachineNotReady status.ConditionType = "VirtualMachineNotReady" // ConditionTypeNetworkingNotReady indicates if the networking // setup to route traffic into the cluster is not ready ConditionTypeNetworkingNotReady status.ConditionType = "NetworkingNotReady" // ConditionTypeKubeletNotReady indicates if kubelet has been // started in the cluster ConditionTypeKubeletNotReady status.ConditionType = "KubeletNotReady" // ConditionTypeClusterNotConfigured indicates if the OpenShift cluster // is not yet configured after first boot ConditionTypeClusterNotConfigured status.ConditionType = "ClusterNotConfigured" // ConditionTypeReady indicates if the OpenShift cluster is ready ConditionTypeReady status.ConditionType = "Ready" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "crc.developer.openshift.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type CrcBundle ¶ added in v0.1.0
type CrcBundle struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CrcBundleSpec `json:"spec,omitempty"`
Status CrcBundleStatus `json:"status,omitempty"`
}
CrcBundle is the Schema for the crcbundles API +kubebuilder:subresource:status +kubebuilder:resource:path=crcbundles,scope=Namespaced
func (*CrcBundle) DeepCopy ¶ added in v0.1.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcBundle.
func (*CrcBundle) DeepCopyInto ¶ added in v0.1.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CrcBundle) DeepCopyObject ¶ added in v0.1.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CrcBundleList ¶ added in v0.1.0
type CrcBundleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CrcBundle `json:"items"`
}
CrcBundleList contains a list of CrcBundle
func (*CrcBundleList) DeepCopy ¶ added in v0.1.0
func (in *CrcBundleList) DeepCopy() *CrcBundleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcBundleList.
func (*CrcBundleList) DeepCopyInto ¶ added in v0.1.0
func (in *CrcBundleList) DeepCopyInto(out *CrcBundleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CrcBundleList) DeepCopyObject ¶ added in v0.1.0
func (in *CrcBundleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CrcBundleSpec ¶ added in v0.1.0
type CrcBundleSpec struct {
// Image is the container image containing the VM image for this
// bundle
Image string `json:"image"`
// URL is the http/https URL containing the VM image for this
// bundle. This is not required and if provided should contain the
// same qcow2/raw VM image that's inside the container specified
// in the Image field. If given, persistent clusters will use this
// instead of the container image as it avoids the need for
// temporary scratch space to extract the VM image from the
// container image.
URL string `json:"url,omitempty"`
// DiskSize is the size of the disk in this bundle
DiskSize string `json:"diskSize"`
// SSHKey is the base64 encoded SSH key used to connect to the
// Node in this bundle
SSHKey string `json:"sshKey"`
// Kubeconfig is the base64 encoded initial kubeconfig to connect
// to this bundle
Kubeconfig string `json:"kubeconfig"`
}
CrcBundleSpec defines the desired state of CrcBundle
func (*CrcBundleSpec) DeepCopy ¶ added in v0.1.0
func (in *CrcBundleSpec) DeepCopy() *CrcBundleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcBundleSpec.
func (*CrcBundleSpec) DeepCopyInto ¶ added in v0.1.0
func (in *CrcBundleSpec) DeepCopyInto(out *CrcBundleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CrcBundleStatus ¶ added in v0.1.0
type CrcBundleStatus struct {
}
CrcBundleStatus defines the observed state of CrcBundle
func (*CrcBundleStatus) DeepCopy ¶ added in v0.1.0
func (in *CrcBundleStatus) DeepCopy() *CrcBundleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcBundleStatus.
func (*CrcBundleStatus) DeepCopyInto ¶ added in v0.1.0
func (in *CrcBundleStatus) DeepCopyInto(out *CrcBundleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CrcCluster ¶
type CrcCluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CrcClusterSpec `json:"spec,omitempty"`
Status CrcClusterStatus `json:"status,omitempty"`
}
CrcCluster is the Schema for the crcclusters API +kubebuilder:subresource:status +kubebuilder:resource:path=crcclusters,scope=Namespaced,shortName=crc
func (*CrcCluster) DeepCopy ¶
func (in *CrcCluster) DeepCopy() *CrcCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcCluster.
func (*CrcCluster) DeepCopyInto ¶
func (in *CrcCluster) DeepCopyInto(out *CrcCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CrcCluster) DeepCopyObject ¶
func (in *CrcCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*CrcCluster) SetConditionBool ¶
func (crc *CrcCluster) SetConditionBool(conditionType status.ConditionType, value bool)
SetConditionBool is a helper function to set boolean Conditions
type CrcClusterList ¶
type CrcClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CrcCluster `json:"items"`
}
CrcClusterList contains a list of CrcCluster
func (*CrcClusterList) DeepCopy ¶
func (in *CrcClusterList) DeepCopy() *CrcClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcClusterList.
func (*CrcClusterList) DeepCopyInto ¶
func (in *CrcClusterList) DeepCopyInto(out *CrcClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CrcClusterList) DeepCopyObject ¶
func (in *CrcClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CrcClusterSpec ¶
type CrcClusterSpec struct {
// CPU is the number of CPUs to allocate to the cluster
// +kubebuilder:default=4
CPU int `json:"cpu"`
// Memory is the amount of memory to allocate to the cluster
// +kubebuilder:default="16Gi"
Memory string `json:"memory"`
// PullSecret is your base64-encoded OpenShift pull secret
PullSecret string `json:"pullSecret"`
// BundleImage is the CRC bundle image to use. If not set, a
// default will be chosen based on the BundleName. This exists
// only to allow temporary overriding of new bundle images before
// a formal API gets created to allow dynamically creating new
// bundle images. The new bundle image will need to have the same
// SSH key and initial kubeconfig as the bundle specified in
// BundleName.
BundleImage string `json:"bundleImage,omitempty"`
// BundleName is the CRC bundle name to use. If not set, a default
// will be chosen by the CRC Operator.
BundleName string `json:"bundleName,omitempty"`
// Storage is the storage options to use. If not set, a default
// will be chosen by the CRC Operator.
Storage CrcStorageSpec `json:"storage,omitempty"`
// Stopped indicates if this cluster should be stopped or
// running. Stopped clusters with ephemeral storage will lose all
// when they're stopped and will come up as if they're a new
// cluster when restarted. Stopped clusters with persistent
// storage will retain their data between stops and starts.
Stopped bool `json:"stopped,omitempty"`
// EnableMonitoring indicates if this cluster should have
// OpenShift's cluster-monitoring-operator enabled by
// default. It's not suggested to enable this unless you assign at
// least 6 CPUs and 16GB of memory to this cluster. If set to true
// or false, the operator will enforce that choice every time the
// cluster is started. If left unset entirely, the operator will
// not enforce either way. Setting this to false will set the
// cluster-monitoring-operator to an unmanaged state but it will
// not actually delete the resources out of the
// openshift-monitoring namespace.
EnableMonitoring *bool `json:"enableMonitoring,omitempty"`
}
CrcClusterSpec defines the desired state of CrcCluster
func (*CrcClusterSpec) DeepCopy ¶
func (in *CrcClusterSpec) DeepCopy() *CrcClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcClusterSpec.
func (*CrcClusterSpec) DeepCopyInto ¶
func (in *CrcClusterSpec) DeepCopyInto(out *CrcClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CrcClusterStatus ¶
type CrcClusterStatus struct {
// BaseDomain is the base domain of the cluster's URLs
BaseDomain string `json:"baseDomain,omitempty"`
// APIURL is the URL of the cluster's API server
APIURL string `json:"apiURL,omitempty"`
// ConsoleURL is the URL of the cluster's web console
ConsoleURL string `json:"consoleURL,omitempty"`
// ClusterID is the ID of this cluster, only really used if
// connected cluster features are enabled
ClusterID string `json:"clusterID,omitempty"`
// Kubeconfig is the base64-encoded kubeconfig to connect to the
// cluster as an administrator
Kubeconfig string `json:"kubeconfig,omitempty"`
// KubeAdminClientKey is the base64-encoded client key to connect
// to the cluster as an administrator.
KubeAdminClientKey string `json:"kubeAdminClientKey,omitempty"`
// KubeAdminPassword is the password to connect to the cluster as an administrator
KubeAdminPassword string `json:"kubeAdminPassword,omitempty"`
// SSHKey is the unique base64 encoded SSH key used to connect to
// this Node after initial setup
SSHKey string `json:"sshKey,omitempty"`
// Stopped indicates whether this cluster is stopped or running
Stopped bool `json:"stopped,omitempty"`
// Conditions represent the latest available observations of an object's state
Conditions status.Conditions `json:"conditions"`
}
CrcClusterStatus defines the observed state of CrcCluster
func (*CrcClusterStatus) DeepCopy ¶
func (in *CrcClusterStatus) DeepCopy() *CrcClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcClusterStatus.
func (*CrcClusterStatus) DeepCopyInto ¶
func (in *CrcClusterStatus) DeepCopyInto(out *CrcClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CrcStorageSpec ¶ added in v0.1.0
type CrcStorageSpec struct {
// Persistent controls whether any data in this cluster should
// persist if the cluster gets rebooted. Persistent storage takes
// longer and costs more to provision. If this is false, the
// cluster will be reset to the original state if the Node its
// running on reboots or if the cluster itself gets shut
// down. Defaults to false.
// +kubebuilder:default=false
Persistent bool `json:"persistent"`
// Size is the amount of persistent disk space to allocate to the
// cluster. This is ignored unless Persistent is set to true.
Size string `json:"size,omitempty"`
}
CrcStorageSpec defines the desired storage of CrcCluster
func (*CrcStorageSpec) DeepCopy ¶ added in v0.1.0
func (in *CrcStorageSpec) DeepCopy() *CrcStorageSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrcStorageSpec.
func (*CrcStorageSpec) DeepCopyInto ¶ added in v0.1.0
func (in *CrcStorageSpec) DeepCopyInto(out *CrcStorageSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.