install

package
v0.1.75 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 6, 2026 License: Apache-2.0 Imports: 40 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	// ExternalDNSImage - This is specifically tag 1.1.0-3 from https://catalog.redhat.com/software/containers/edo/external-dns-rhel8/61d4c35023156829b87a434a?container-tabs=overview&tag=1.1.0-3&push_date=1671131187000
	// TODO this needs to be updated to a multi-arch image including Arm - https://issues.redhat.com/browse/NE-1298
	ExternalDNSImage = "registry.redhat.io/edo/external-dns-rhel8@sha256:638fb6b5fc348f5cf52b9800d3d8e9f5315078fc9b1e57e800cb0a4a50f1b4b9"
)

Variables

View Source 
var (
	RenderFormatYaml = "yaml"
	RenderFormatJson = "json"
)
View Source 
var HyperShiftImage = fmt.Sprintf("%s:%s", config.HypershiftImageBase, config.HypershiftImageTag)
View Source 
var ValidPlatforms = set.New[string](
	"aws",
	"azure",
	"ibmcloud",
	"kubevirt",
	"agent",
	"openstack",
	"gcp",
)

ValidPlatforms should contain all the CAPI provider types we support; see also crds in assests.go https://github.com/openshift/hypershift/blob/3ea313694d386763578646b157a8d4d3d187e98e/cmd/install/assets/assets.go#L26

Functions

func GetDeploymentCondition added in v0.1.54 

func GetDeploymentCondition(status appsv1.DeploymentStatus, condType appsv1.DeploymentConditionType) *appsv1.DeploymentCondition

GetDeploymentCondition returns the condition with the provided type.

func InstallHyperShiftOperator added in v0.1.54 

func InstallHyperShiftOperator(ctx context.Context, out io.Writer, opts Options) error

InstallHyperShiftOperator generates and applies the manifests needed to install the HyperShift Operator starting with the all the HyperShift CRDs.

func NewCommand 

func NewCommand() *cobra.Command

func NewHelmRenderCommand added in v0.1.51 

func NewHelmRenderCommand(opts *Options) *cobra.Command

func NewRenderCommand 

func NewRenderCommand(opts *Options) *cobra.Command

func RenderHyperShiftOperator added in v0.1.70 

func RenderHyperShiftOperator(ctx context.Context, cmdOut io.Writer, opts *Options) error

func WaitUntilAvailable added in v0.1.54 

func WaitUntilAvailable(ctx context.Context, opts Options) (*appsv1.Deployment, error)

func WriteChartYaml added in v0.1.51 

func WriteChartYaml(dir string) error

func WriteValuesFile added in v0.1.51 

func WriteValuesFile(dir string) error

Types

type ObjectPatch 

type ObjectPatch struct {
	Kind  string
	Name  string
	Path  []string
	Value string
}

func (*ObjectPatch) CanBeAppliedTo 

func (p *ObjectPatch) CanBeAppliedTo(obj crclient.Object) bool

type Options 

type Options struct {
	AdditionalTrustBundle                     string
	Namespace                                 string
	HyperShiftImage                           string
	ImageRefsFile                             string
	HyperShiftOperatorReplicas                int32
	Development                               bool
	EnableDefaultingWebhook                   bool
	EnableValidatingWebhook                   bool
	EnableConversionWebhook                   bool
	Template                                  bool
	Format                                    string
	OutputFile                                string
	OutputTypes                               string
	ExcludeEtcdManifests                      bool
	PlatformMonitoring                        metrics.PlatformMonitoring
	EnableCIDebugOutput                       bool
	PrivatePlatform                           string
	AWSPrivateCreds                           string
	AWSPrivateCredentialsSecret               string
	AWSPrivateCredentialsSecretKey            string
	AWSPrivateRegion                          string
	AzurePrivateCreds                         string
	AzurePrivateCredentialsSecret             string
	AzurePrivateCredentialsSecretKey          string
	AzurePLSManagedIdentityClientID           string
	AzurePLSSubscriptionID                    string
	AzurePLSResourceGroup                     string
	GCPProject                                string
	GCPRegion                                 string
	OIDCStorageProviderS3Region               string
	OIDCStorageProviderS3BucketName           string
	OIDCStorageProviderS3Credentials          string
	OIDCStorageProviderS3CredentialsSecret    string
	OIDCStorageProviderS3CredentialsSecretKey string
	ExternalDNSProvider                       string
	ExternalDNSCredentials                    string
	ExternalDNSCredentialsSecret              string
	ExternalDNSDomainFilter                   string
	ExternalDNSTxtOwnerId                     string
	ExternalDNSImage                          string
	ExternalDNSGoogleProject                  string
	ExternalDNSInterval                       string
	ExternalDNSAWSZonesCacheDuration          string
	AdditionalOperatorEnvVars                 map[string]string
	EnableAdminRBACGeneration                 bool
	EnableUWMTelemetryRemoteWrite             bool
	EnableCVOManagementClusterMetricsAccess   bool
	MetricsSet                                metrics.MetricsSet
	WaitUntilAvailable                        bool
	WaitUntilEstablished                      bool
	RHOBSMonitoring                           bool
	CVOPrometheusURL                          string
	SLOsAlerts                                bool
	MonitoringDashboards                      bool
	CertRotationScale                         time.Duration
	EnableDedicatedRequestServingIsolation    bool
	PullSecretFile                            string
	ManagedService                            string
	EnableSizeTagging                         bool
	EnableEtcdRecovery                        bool
	EnableCPOOverrides                        bool
	AroHCPKeyVaultUsersClientID               string
	TechPreviewNoUpgrade                      bool
	RegistryOverrides                         string
	RenderNamespace                           bool
	PlatformsToInstall                        []string
	ImagePullPolicy                           string
	EnableAuditLogPersistence                 bool
	ScaleFromZeroProvider                     string
	ScaleFromZeroCreds                        string
	ScaleFromZeroCredentialsSecret            string
	ScaleFromZeroCredentialsSecretKey         string
}

func NewInstallOptionsWithDefaults added in v0.1.54 

func NewInstallOptionsWithDefaults() Options

NewInstallOptionsWithDefaults returns an Options instance with the default values sets.

func (*Options) ApplyDefaults 

func (o *Options) ApplyDefaults()

func (*Options) Validate 

func (o *Options) Validate() error

func (*Options) ValidateRender 

func (o *Options) ValidateRender() error

type Outputs added in v0.1.23 

type Outputs string
const (
	OutputAll       Outputs = "all"
	OutputCRDs      Outputs = "crds"
	OutputResources Outputs = "resources"
)

type TemplateParams added in v0.1.51 

type TemplateParams struct {
	HyperShiftImage                  string
	HyperShiftImageTag               string
	Namespace                        string
	HypershiftOperatorReplicas       string
	OIDCS3Name                       string
	OIDCS3Region                     string
	OIDCS3CredsSecret                string
	OIDCS3CredsSecretKey             string
	AWSPrivateRegion                 string
	AWSPrivateCredsSecret            string
	AWSPrivateCredsSecretKey         string
	ExternalDNSCredsSecret           string
	ExternalDNSDomainFilter          string
	ExternalDNSTxtOwnerID            string
	ExternalDNSImage                 string
	ExternalDNSGoogleProject         string
	ExternalDNSInterval              string
	ExternalDNSAWSZonesCacheDuration string
	RegistryOverrides                string
	AROHCPKeyVaultUsersClientID      string
	TemplateNamespace                bool
	TemplateParamWrapper             func(string) string
}

Source Files

View all Source files

Directories

Path Synopsis
hypershift-operator/zz_generated.crd-manifests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.