Documentation
¶
Index ¶
- func ResourceProfiles() []string
- func ResourceProfilesJoined() string
- type CentralDeploymentInfo
- type ClusterType
- func (ct ClusterType) IsAKS() bool
- func (ct ClusterType) IsEKS() bool
- func (ct ClusterType) IsGKE() bool
- func (ct ClusterType) IsLocal() bool
- func (ct ClusterType) IsOpenShift() bool
- func (ct ClusterType) NeedsDefaultRegistryPullSecrets() bool
- func (ct ClusterType) String() string
- func (ct ClusterType) SupportsLoadBalancer() bool
- func (ct *ClusterType) UnmarshalYAML(unmarshal func(any) error) error
- type Exposure
- type ResourceProfile
- type RoxieEnvironment
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ResourceProfiles ¶
func ResourceProfiles() []string
func ResourceProfilesJoined ¶
func ResourceProfilesJoined() string
Types ¶
type CentralDeploymentInfo ¶ added in v0.4.1
type CentralDeploymentInfo struct {
Endpoint string
Username string
Password string
KubeContext string
Exposure Exposure
CACertFile string
HAProxyPort int // If positive, HAProxy was started and listens on that port.
}
CentralDeploymentInfo holds the state of a Central deployment.
type ClusterType ¶
type ClusterType string
ClusterType represents different types of Kubernetes clusters
const ( // ClusterTypeUnknown represents an unidentified cluster type ClusterTypeUnknown ClusterType = "Unknown" // ClusterTypeGKE represents a generic GKE cluster. ClusterTypeGKE ClusterType = "GKE" // ClusterTypeInfraGKE represents a GKE cluster created via Infra. ClusterTypeInfraGKE ClusterType = "InfraGKE" // ClusterTypeInfraOpenShift4 represents an OpenShift 4 cluster ClusterTypeInfraOpenShift4 ClusterType = "InfraOpenShift4" // Generic OpenShift4 cluster (e.g. for prow CI) ClusterTypeOpenShift4 ClusterType = "OpenShift4" // ClusterTypeKind represents a Kind (Kubernetes in Docker) cluster ClusterTypeKind ClusterType = "Kind" // ClusterTypeMinikube represents a Minikube cluster ClusterTypeMinikube ClusterType = "Minikube" // ClusterTypeK3s represents a K3s cluster ClusterTypeK3s ClusterType = "K3s" // ClusterTypeCRC represents a CRC (CodeReady Containers) cluster ClusterTypeCRC ClusterType = "CRC" // ClusterTypeAKS represents a generic AKS (Azure Kubernetes Service) cluster. ClusterTypeAKS ClusterType = "AKS" // ClusterTypeEKS represents a generic EKS (Amazon Elastic Kubernetes Service) cluster. ClusterTypeEKS ClusterType = "EKS" )
func AllClusterTypes ¶
func AllClusterTypes() []ClusterType
func (ClusterType) IsAKS ¶ added in v0.4.13
func (ct ClusterType) IsAKS() bool
func (ClusterType) IsEKS ¶ added in v0.4.13
func (ct ClusterType) IsEKS() bool
func (ClusterType) IsGKE ¶ added in v0.4.5
func (ct ClusterType) IsGKE() bool
func (ClusterType) IsLocal ¶ added in v0.4.2
func (ct ClusterType) IsLocal() bool
func (ClusterType) IsOpenShift ¶
func (ct ClusterType) IsOpenShift() bool
func (ClusterType) NeedsDefaultRegistryPullSecrets ¶ added in v0.4.12
func (ct ClusterType) NeedsDefaultRegistryPullSecrets() bool
NeedsDefaultRegistryPullSecrets reports whether this cluster type lacks auto-configured credentials for the default image registry (quay.io/rhacs-eng).
func (ClusterType) String ¶
func (ct ClusterType) String() string
String returns the string representation of a ClusterType
func (ClusterType) SupportsLoadBalancer ¶ added in v0.4.13
func (ct ClusterType) SupportsLoadBalancer() bool
func (*ClusterType) UnmarshalYAML ¶ added in v0.4.1
func (ct *ClusterType) UnmarshalYAML(unmarshal func(any) error) error
type Exposure ¶
type Exposure int
func (Exposure) MarshalYAML ¶
func (*Exposure) ToUnstructuredConfig ¶
ToUnstructuredConfig returns the exposure configuration.
func (*Exposure) UnmarshalYAML ¶
type ResourceProfile ¶
type ResourceProfile int
const ( ResourceProfileAcsDefaults ResourceProfile = iota ResourceProfileAuto ResourceProfileSmall ResourceProfileMedium ResourceProfileCI )
func (ResourceProfile) MarshalYAML ¶
func (r ResourceProfile) MarshalYAML() (interface{}, error)
func (ResourceProfile) String ¶
func (r ResourceProfile) String() string
func (*ResourceProfile) UnmarshalYAML ¶
func (r *ResourceProfile) UnmarshalYAML(unmarshal func(interface{}) error) error
type RoxieEnvironment ¶ added in v0.4.1
type RoxieEnvironment struct {
APIEndpoint string `yaml:"API_ENDPOINT,omitempty"`
RoxAdminPassword string `yaml:"ROX_ADMIN_PASSWORD,omitempty"`
RoxBaseURL string `yaml:"ROX_BASE_URL,omitempty"`
RoxEndpoint string `yaml:"ROX_ENDPOINT,omitempty"`
RoxUsername string `yaml:"ROX_USERNAME,omitempty"`
RoxCaCertFile string `yaml:"ROX_CA_CERT_FILE,omitempty"`
}
RoxieEnvironment is the environment used during runtime. It includes another field, which shall not be stored on the cluster, since it is a local path.
func (RoxieEnvironment) Export ¶ added in v0.4.1
func (r RoxieEnvironment) Export() iter.Seq2[string, string]
Export() returns an iterator, which produces key,val pairs for the roxie environment. This includes local-only fields unlike YAML serialization, which only produces those values which shall actually be persisted.
func (RoxieEnvironment) MarshalYAML ¶ added in v0.4.1
func (r RoxieEnvironment) MarshalYAML() (any, error)
MarshalYAML skips local-only fields (ROX_CA_CERT_FILE).