package
4.16.15+incompatible
Repository: https://github.com/openshift/installer.git
Documentation: pkg.go.dev
# Packages
Package mock is a generated GoMock package.
# Functions
DescribePublicIpv4Pool returns the ec2 public IPv4 Pool attributes from the given ID.
DescribeSecurityGroups returns the list of ec2 Security Groups that contain the group id and vpc id.
GetBaseDomain returns a base domain chosen from among the account's public routes.
GetPublicZone returns a public route53 zone that matches the name.
GetR53ClientCfg creates a config for the route53 client by determining whether it is needed to obtain STS assume role credentials.
GetSession returns an AWS session by checking credentials and, if no creds are found, asks for them and stores them on disk in a config file.
GetSessionWithOptions returns an AWS session by checking credentials and, if no creds are found, asks for them and stores them on disk in a config file.
IsForbidden returns true if and only if the input error is an HTTP 403 error from the AWS API.
IsKnownPublicRegion returns true if a specified region is Known to the installer.
IsStaticCredentials returns whether the credentials value provider are static credentials safe for installer to transfer to cluster for use as-is.
NewClient initializes a client with a session.
NewMetadata initializes a new Metadata object.
PermissionsList compiles a list of permissions based on the permission groups provided.
Platform collects AWS-specific configuration.
PresignedS3URL returns a presigned S3 URL for a bucket/object pair.
RequiredPermissionGroups returns a set of required permissions for a given cluster configuration.
Validate executes platform-specific validation.
ValidateCreds will try to create an AWS session, and also verify that the current credentials are sufficient to perform an installation, and that they can be used for cluster runtime as either capable of creating new credentials for components that interact with the cloud or being able to be passed through as-is to the components that need cloud credentials.
ValidateForProvisioning validates if the install config is valid for provisioning the cluster.
WithRegion configures the session.Option to set the AWS region.
WithServiceEndpoints configures the session.Option to use provides services for AWS endpoints.
# Constants
PermissionCreateBase is a base set of permissions required in all installs where the installer creates resources.
PermissionCreateHostedZone is a set of permissions required when the installer creates a route53 hosted zone.
PermissionCreateInstanceRole is a set of permissions required when the installer creates instance roles.
PermissionCreateNetworking is an additional set of permissions required when the installer creates networking resources.
PermissionDeleteBase is a base set of permissions required in all installs where the installer deletes resources.
PermissionDeleteHostedZone is a set of permissions required when the installer destroys a route53 hosted zone.
PermissionDeleteIgnitionObjects is a permission set required when `preserveBootstrapIgnition` is not set.
PermissionDeleteNetworking is a set of permissions required when the installer destroys networking resources.
PermissionDeleteSharedInstanceRole is a set of permissions required when the installer destroys resources from a cluster with user-supplied IAM roles for instances.
PermissionDeleteSharedNetworking is a set of permissions required when the installer destroys resources from a shared-network cluster.
PermissionKMSEncryptionKeys is an additional set of permissions required when the installer uses user provided kms encryption keys.
PermissionPublicIpv4Pool is an additional set of permissions required when the installer uses public IPv4 pools.
# Variables
HostedZoneIDPerRegionNLBMap maps HostedZoneIDs from known regions.
# Structs
Client makes calls to the AWS Route53 API.
HostedZoneInput defines the input parameters for hosted zone creation.
InstanceType holds metadata for an instance type.
Metadata holds additional metadata for InstallConfig resources that does not need to be user-supplied (e.g.
Subnet holds metadata for a subnet.
SubnetGroups is the group of subnets used by installer.
Zone stores the Availability or Local Zone attributes used to set machine attributes, and to feed VPC resources as a source for for terraform variables.
# Interfaces
API represents the calls made to the API.
# Type aliases
PermissionGroup is the group of permissions needed by cluster creation, operation, or teardown.
SessionOptions is a function that modifies the provided session.Option.
Subnets is the map for the Subnet metadata indexed by zone.
Zones stores the map of Zone attributes indexed by Zone Name.