Documentation
¶
Index ¶
- Constants
- func ConfigMapName(cr *registryv1alpha1.DevfileRegistry) string
- func DeploymentName(cr *registryv1alpha1.DevfileRegistry) string
- func GenerateDeployment(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, ...) *appsv1.Deployment
- func GenerateIngress(cr *registryv1alpha1.DevfileRegistry, host string, scheme *runtime.Scheme, ...) *networkingv1.Ingress
- func GeneratePVC(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, ...) *corev1.PersistentVolumeClaim
- func GenerateRegistryConfigMap(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, ...) *corev1.ConfigMap
- func GenerateRoute(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, ...) *routev1.Route
- func GenerateService(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, ...) *corev1.Service
- func GenericResourceName(cr *registryv1alpha1.DevfileRegistry) string
- func GetDevfileIndexImage(cr *registryv1alpha1.DevfileRegistry) string
- func GetDevfileIndexImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
- func GetDevfileIndexMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
- func GetDevfileRegistryIngress(cr *registryv1alpha1.DevfileRegistry) string
- func GetDevfileRegistryVolumeSource(cr *registryv1alpha1.DevfileRegistry) corev1.VolumeSource
- func GetFullnameOverride(cr *registryv1alpha1.DevfileRegistry) string
- func GetHostname(cr *registryv1alpha1.DevfileRegistry) string
- func GetHostnameOverride(cr *registryv1alpha1.DevfileRegistry) string
- func GetK8sIngressClass(cr *registryv1alpha1.DevfileRegistry) string
- func GetNameOverride(cr *registryv1alpha1.DevfileRegistry) string
- func GetOCIRegistryImage(cr *registryv1alpha1.DevfileRegistry) string
- func GetOCIRegistryImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
- func GetOCIRegistryMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
- func GetRegistryViewerImage(cr *registryv1alpha1.DevfileRegistry) string
- func GetRegistryViewerImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
- func GetRegistryViewerMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
- func IngressName(cr *registryv1alpha1.DevfileRegistry) string
- func IsHeadlessEnabled(cr *registryv1alpha1.DevfileRegistry) bool
- func IsIngressSkipped(cr *registryv1alpha1.DevfileRegistry) bool
- func IsStorageEnabled(cr *registryv1alpha1.DevfileRegistry) bool
- func IsTLSEnabled(cr *registryv1alpha1.DevfileRegistry) bool
- func IsTelemetryEnabled(cr *registryv1alpha1.DevfileRegistry) bool
- func LabelsForDevfileRegistry(cr *registryv1alpha1.DevfileRegistry) map[string]string
- func PVCName(cr *registryv1alpha1.DevfileRegistry) string
- func ServiceName(cr *registryv1alpha1.DevfileRegistry) string
Constants ¶
const ( // Default image:tags DefaultDevfileIndexImage = "quay.io/devfile/devfile-index:next" DefaultRegistryViewerImage = "quay.io/devfile/registry-viewer:next" DefaultOCIRegistryImage = "quay.io/devfile/oci-registry:next" // Default image pull policies DefaultDevfileIndexImagePullPolicy = corev1.PullAlways DefaultRegistryViewerImagePullPolicy = corev1.PullAlways DefaultOCIRegistryImagePullPolicy = corev1.PullAlways // Default memory limits DefaultDevfileIndexMemoryLimit = "256Mi" DefaultRegistryViewerMemoryLimit = "256Mi" DefaultOCIRegistryMemoryLimit = "256Mi" // Defaults/constants for devfile registry storages DefaultDevfileRegistryVolumeSize = "1Gi" DevfileRegistryVolumeEnabled = false DevfileRegistryVolumeName = "devfile-registry-storage" DevfileRegistryTLSEnabled = true DevfileRegistryTelemetryEnabled = false DefaultDevfileRegistryHeadlessEnabled = false // Defaults/constants for devfile registry services DevfileIndexPortName = "devfile-registry-metadata" DevfileIndexPort = 8080 DevfileIndexMetricsPortName = "devfile-index-metrics" DevfileIndexMetricsPort = 7071 OCIMetricsPortName = "oci-registry-metrics" OCIMetricsPort = 5001 OCIServerPort = 5000 RegistryViewerPort = 3000 // Default kubernetes-only fields DefaultK8sIngressClass = "nginx" // Override defaults (should be empty) DefaultHostnameOverride = "" DefaultNameOverride = "" DefaultFullnameOverride = "" // App name default DefaultAppName = "devfile-registry" )
Variables ¶
This section is empty.
Functions ¶
func ConfigMapName ¶
func ConfigMapName(cr *registryv1alpha1.DevfileRegistry) string
ConfigMapName returns the name of the service object associated with the DevfileRegistry CR
func DeploymentName ¶
func DeploymentName(cr *registryv1alpha1.DevfileRegistry) string
DeploymentName returns the name of the deployment object associated with the DevfileRegistry CR Just returns the fully qualified app name right now, but extracting to a function to avoid relying on that assumption in the future
func GenerateDeployment ¶
func GenerateDeployment(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, labels map[string]string) *appsv1.Deployment
func GenerateIngress ¶
func GenerateIngress(cr *registryv1alpha1.DevfileRegistry, host string, scheme *runtime.Scheme, labels map[string]string) *networkingv1.Ingress
func GeneratePVC ¶
func GeneratePVC(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, labels map[string]string) *corev1.PersistentVolumeClaim
GenerateDevfileRegistryPVC returns a PVC for providing storage on the OCI registry container
func GenerateRegistryConfigMap ¶
func GenerateRegistryConfigMap(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, labels map[string]string) *corev1.ConfigMap
GenerateRegistryConfigMap returns a configmap that is used to configure the devfile registry
func GenerateRoute ¶
func GenerateRoute(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, labels map[string]string) *routev1.Route
GenerateRoute returns a route exposing the devfile registry index
func GenerateService ¶
func GenerateService(cr *registryv1alpha1.DevfileRegistry, scheme *runtime.Scheme, labels map[string]string) *corev1.Service
GenerateDevfileRegistryService returns a devfileregistry Service object
func GenericResourceName ¶
func GenericResourceName(cr *registryv1alpha1.DevfileRegistry) string
GenericResourceName returns just the fully qualified app name, to be used
func GetDevfileIndexImage ¶
func GetDevfileIndexImage(cr *registryv1alpha1.DevfileRegistry) string
GetDevfileIndexImage returns the container image for the devfile index server to be deployed on the Devfile Registry. Default: "quay.io/devfile/devfile-index:next"
func GetDevfileIndexImagePullPolicy ¶
func GetDevfileIndexImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
GetDevfileIndexImagePullPolicy returns the image pull policy for the devfile index container. Default: "Always"
func GetDevfileIndexMemoryLimit ¶ added in v0.3.0
func GetDevfileIndexMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
GetDevfileIndexMemoryLimit returns the memory limit for the devfile index container. In case of invalid quantity given, it returns the default value. Default: resource.Quantity{s: "256Mi"}
func GetDevfileRegistryIngress ¶
func GetDevfileRegistryIngress(cr *registryv1alpha1.DevfileRegistry) string
func GetDevfileRegistryVolumeSource ¶
func GetDevfileRegistryVolumeSource(cr *registryv1alpha1.DevfileRegistry) corev1.VolumeSource
func GetFullnameOverride ¶ added in v0.3.0
func GetFullnameOverride(cr *registryv1alpha1.DevfileRegistry) string
GetFullnameOverride returns full name override used to override the fully qualified app name of a devfile registry Default: ""
func GetHostname ¶ added in v0.3.0
func GetHostname(cr *registryv1alpha1.DevfileRegistry) string
func GetHostnameOverride ¶ added in v0.3.0
func GetHostnameOverride(cr *registryv1alpha1.DevfileRegistry) string
GetHostnameOverride returns hostname override used to override the hostname and domain of a devfile registry Default: ""
func GetK8sIngressClass ¶ added in v0.3.0
func GetK8sIngressClass(cr *registryv1alpha1.DevfileRegistry) string
GetK8sIngressClass returns ingress class used for the k8s ingress class field. Default: "nginx"
func GetNameOverride ¶ added in v0.3.0
func GetNameOverride(cr *registryv1alpha1.DevfileRegistry) string
GetNameOverride returns name override used to override the app name of a devfile registry Default: ""
func GetOCIRegistryImage ¶
func GetOCIRegistryImage(cr *registryv1alpha1.DevfileRegistry) string
GetOCIRegistryImage returns the container image for the OCI registry to be deployed on the Devfile Registry. Default: "quay.io/devfile/oci-registry:next"
func GetOCIRegistryImagePullPolicy ¶
func GetOCIRegistryImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
GetOCIRegistryImagePullPolicy returns the image pull policy for the OCI registry container. Default: "Always"
func GetOCIRegistryMemoryLimit ¶ added in v0.3.0
func GetOCIRegistryMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
GetOCIRegistryMemoryLimit returns the memory limit for the OCI registry container. In case of invalid quantity given, it returns the default value. Default: resource.Quantity{s: "256Mi"}
func GetRegistryViewerImage ¶
func GetRegistryViewerImage(cr *registryv1alpha1.DevfileRegistry) string
GetRegistryViewerImage returns the container image for the registry viewer to be deployed on the Devfile Registry. Default: "quay.io/devfile/registry-viewer:next"
func GetRegistryViewerImagePullPolicy ¶
func GetRegistryViewerImagePullPolicy(cr *registryv1alpha1.DevfileRegistry) corev1.PullPolicy
GetRegistryViewerImagePullPolicy returns the image pull policy for the registry viewer container. Default: "Always"
func GetRegistryViewerMemoryLimit ¶ added in v0.3.0
func GetRegistryViewerMemoryLimit(cr *registryv1alpha1.DevfileRegistry) resource.Quantity
GetRegistryViewerMemoryLimit returns the memory limit for the registry viewer container. In case of invalid quantity given, it returns the default value. Default: resource.Quantity{s: "256Mi"}
func IngressName ¶
func IngressName(cr *registryv1alpha1.DevfileRegistry) string
IngressName returns the name of the Ingress object associated with the DevfileRegistry CR Just returns the fully qualified app name right now, but extracting to a function to avoid relying on that assumption in the future
func IsHeadlessEnabled ¶
func IsHeadlessEnabled(cr *registryv1alpha1.DevfileRegistry) bool
IsHeadlessEnabled returns value (true/false) set under spec attribute headless If it's not set, it returns false by default
func IsIngressSkipped ¶ added in v0.3.0
func IsIngressSkipped(cr *registryv1alpha1.DevfileRegistry) bool
IsIngressSkipped returns true if no Ingress is set in the DevfileRegistry CR. If cr does not exist return true by default as no Ingress resource should be created
func IsStorageEnabled ¶
func IsStorageEnabled(cr *registryv1alpha1.DevfileRegistry) bool
IsStorageEnabled returns true if storage.enabled is set in the DevfileRegistry CR If it's not set, it returns false by default.
func IsTLSEnabled ¶
func IsTLSEnabled(cr *registryv1alpha1.DevfileRegistry) bool
IsTLSEnabled returns true if tls.enabled is set in the DevfileRegistry CR If it's not set, it returns true by default.
func IsTelemetryEnabled ¶
func IsTelemetryEnabled(cr *registryv1alpha1.DevfileRegistry) bool
IsTelemetryEnabled returns true if telemetry.key is set in the DevfileRegistry CR If it's not set, it returns false by default
func LabelsForDevfileRegistry ¶
func LabelsForDevfileRegistry(cr *registryv1alpha1.DevfileRegistry) map[string]string
LabelsForDevfileRegistry returns the labels for selecting the resources belonging to the given devfileregistry CR name.
func PVCName ¶
func PVCName(cr *registryv1alpha1.DevfileRegistry) string
PVCName returns the name of the PVC object associated with the DevfileRegistry CR Just returns the fully qualified app name right now, but extracting to a function to avoid relying on that assumption in the future
func ServiceName ¶
func ServiceName(cr *registryv1alpha1.DevfileRegistry) string
ServiceName returns the name of the service object associated with the DevfileRegistry CR Just returns the fully qualified app name right now, but extracting to a function to avoid relying on that assumption in the future
Types ¶
This section is empty.