install

Documentation

Index

• Constants
• Variables
• func GetDeploymentCondition(status appsv1.DeploymentStatus, condType appsv1.DeploymentConditionType) *appsv1.DeploymentCondition
• func InstallHyperShiftOperator(ctx context.Context, out io.Writer, opts Options) error
• func NewCommand() *cobra.Command
• func NewHelmRenderCommand(opts *Options) *cobra.Command
• func NewRenderCommand(opts *Options) *cobra.Command
• func WaitUntilAvailable(ctx context.Context, opts Options) (*appsv1.Deployment, error)
• func WriteChartYaml(dir string) error
• func WriteValuesFile(dir string) error
• type ObjectPatch
  • func (p *ObjectPatch) CanBeAppliedTo(obj crclient.Object) bool
• type Options
  • func NewInstallOptionsWithDefaults() Options
  • func (o *Options) ApplyDefaults()
  • func (o *Options) Validate() error
  • func (o *Options) ValidateRender() error
• type Outputs
• type TemplateParams

Constants

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

var (
	RenderFormatYaml = "yaml"
	RenderFormatJson = "json"
)

Functions

func GetDeploymentCondition

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

GetDeploymentCondition returns the condition with the provided type.

func InstallHyperShiftOperator

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

func NewHelmRenderCommand(opts *Options) *cobra.Command

func NewRenderCommand

func NewRenderCommand(opts *Options) *cobra.Command

func WaitUntilAvailable

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

func WriteChartYaml

func WriteChartYaml(dir string) error

func WriteValuesFile

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
	OIDCStorageProviderS3Region               string
	OIDCStorageProviderS3BucketName           string
	OIDCStorageProviderS3Credentials          string
	OIDCStorageProviderS3CredentialsSecret    string
	OIDCStorageProviderS3CredentialsSecretKey string
	ExternalDNSProvider                       string
	ExternalDNSCredentials                    string
	ExternalDNSCredentialsSecret              string
	ExternalDNSDomainFilter                   string
	ExternalDNSTxtOwnerId                     string
	ExternalDNSImage                          string
	EnableAdminRBACGeneration                 bool
	EnableUWMTelemetryRemoteWrite             bool
	EnableCVOManagementClusterMetricsAccess   bool
	MetricsSet                                metrics.MetricsSet
	WaitUntilAvailable                        bool
	WaitUntilEstablished                      bool
	RHOBSMonitoring                           bool
	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
}

func NewInstallOptionsWithDefaults

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

type Outputs string

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

type TemplateParams

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
	RegistryOverrides           string
	AROHCPKeyVaultUsersClientID string
	TemplateNamespace           bool
	TemplateParamWrapper        func(string) string
}