Documentation ¶
Index ¶
- Constants
- Variables
- func AddClusterFlag(cmd *cobra.Command)
- func AddOptionalClusterFlag(cmd *cobra.Command)
- func CheckAndParseVersion(availableUpgrades []string, version string) (string, error)
- func CheckSupportedVersion(clusterVersion string, operatorVersion string) (bool, error)
- func ClusterNameValidator(name interface{}) error
- func GetClusterKey() (string, error)
- func GetEnv() (string, error)
- func GetVersionID(cluster *cmv1.Cluster) string
- func GetVersionMinor(ver string) string
- func GetVersionMinorList(ocmClient *Client) (versionList []string, err error)
- func HasHostedCPSupport(rawVersion, channelGroup string) (bool, error)
- func HasSTSSupport(rawID string, channelGroup string) bool
- func HasSTSSupportMinor(minor string) bool
- func IdentityProviderType(idp *cmv1.IdentityProvider) string
- func IsEmptyCIDR(cidr net.IPNet) bool
- func IsValidClusterKey(clusterKey string) bool
- func IsValidClusterName(clusterName string) bool
- func IsValidUsername(username string) bool
- func IsValidVersion(userRequestedVersion string, supportedVersion string, clusterVersion string) (bool, error)
- func ParseVersion(version string) (string, error)
- func SetClusterKey(key string)
- func ValidateAdditionalTrustBundle(val interface{}) error
- func ValidateAvailabilityZonesCount(multiAZ bool, availabilityZonesCount int) error
- func ValidateHTTPProxy(val interface{}) error
- func ValidateSubnetsCount(multiAZ bool, privateLink bool, subnetsInputCount int) error
- func ValidateVersion(version string, versionList []string) (string, error)
- type AddOnBilling
- type AddOnParam
- type AddOnResource
- type Client
- func (c *Client) AckVersionGate(clusterID string, gateID string) error
- func (c *Client) AcknowledgeGate(versionGates []*cmv1.VersionGate) (err error)
- func (c *Client) AddClusterOperatorRole(cluster *cmv1.Cluster, role *cmv1.OperatorIAMRole) error
- func (c *Client) AddHTPasswdUser(username, password, clusterID, idpID string) error
- func (c *Client) CancelUpgrade(clusterID string) (bool, error)
- func (c *Client) CheckIfAWSAccountExists(orgID string, awsAccountID string) (bool, string, string, error)
- func (c *Client) CheckRoleExists(orgID string, roleName string, awsAccountID string) (bool, string, string, error)
- func (c *Client) CheckUpgradeClusterVersion(availableUpgrades []string, clusterUpgradeVersion string, ...) (err error)
- func (c *Client) Close() error
- func (c *Client) CreateCluster(config Spec) (*cmv1.Cluster, error)
- func (c *Client) CreateIdentityProvider(clusterID string, idp *cmv1.IdentityProvider) (*cmv1.IdentityProvider, error)
- func (c *Client) CreateIngress(clusterID string, ingress *cmv1.Ingress) (*cmv1.Ingress, error)
- func (c *Client) CreateMachinePool(clusterID string, machinePool *cmv1.MachinePool) (*cmv1.MachinePool, error)
- func (c *Client) CreateManagedService(args CreateManagedServiceArgs) (*msv1.ManagedService, error)
- func (c *Client) CreateUser(clusterID string, group string, user *cmv1.User) (*cmv1.User, error)
- func (c *Client) DeleteCluster(clusterKey string, creator *aws.Creator) (*cmv1.Cluster, error)
- func (c *Client) DeleteHTPasswdUser(username, clusterID string, htpasswdIDP *cmv1.IdentityProvider) error
- func (c *Client) DeleteIdentityProvider(clusterID string, idpID string) error
- func (c *Client) DeleteIngress(clusterID string, ingressID string) error
- func (c *Client) DeleteMachinePool(clusterID string, machinePoolID string) error
- func (c *Client) DeleteManagedService(args DeleteManagedServiceArgs) (*msv1.ManagedServiceDeleteResponse, error)
- func (c *Client) DeleteUser(clusterID string, group string, username string) error
- func (c *Client) FindMissingOperatorRolesForUpgrade(cluster *cmv1.Cluster, newMinorVersion string) (map[string]*cmv1.STSOperator, error)
- func (c *Client) GetAccountLinkedUserRoles(accountID string) ([]string, error)
- func (c *Client) GetAddOn(id string) (*cmv1.AddOn, error)
- func (c *Client) GetAddOnInstallation(clusterID, addOnID string) (*cmv1.AddOnInstallation, error)
- func (c *Client) GetAddOnParameters(clusterID, addOnID string) (*cmv1.AddOnParameterList, error)
- func (c *Client) GetAllClusters(creator *aws.Creator) (clusters []*cmv1.Cluster, err error)
- func (c *Client) GetAvailableAddOns() ([]*AddOnResource, error)
- func (c *Client) GetAvailableMachineTypes() (MachineTypeList, error)
- func (c *Client) GetAvailableMachineTypesInRegion(region string, availabilityZones []string, roleARN string, ...) (MachineTypeList, error)
- func (c *Client) GetAvailableUpgrades(versionID string) ([]string, error)
- func (c *Client) GetCluster(clusterKey string, creator *aws.Creator) (*cmv1.Cluster, error)
- func (c *Client) GetClusterAddOns(cluster *cmv1.Cluster) ([]*ClusterAddOn, error)
- func (c *Client) GetClusterByID(clusterKey string, creator *aws.Creator) (*cmv1.Cluster, error)
- func (c *Client) GetClusterState(clusterID string) (cmv1.ClusterState, error)
- func (c *Client) GetClusterStatus(clusterID string) (*cmv1.ClusterStatus, error)
- func (c *Client) GetClusterUsingSubscription(clusterKey string, creator *aws.Creator) (*amv1.Subscription, error)
- func (c *Client) GetClusters(creator *aws.Creator, count int) (clusters []*cmv1.Cluster, err error)
- func (c *Client) GetConnectionTokens() (string, string, error)
- func (c *Client) GetConnectionURL() string
- func (c *Client) GetCredRequests(isHypershift bool) (map[string]*cmv1.STSOperator, error)
- func (c *Client) GetCurrentAccount() (*amsv1.Account, error)
- func (c *Client) GetCurrentOrganization() (id string, externalID string, err error)
- func (c *Client) GetDatabaseRegionList() ([]string, error)
- func (c *Client) GetDefaultClusterFlavors(flavour string) (dMachinecidr *net.IPNet, dPodcidr *net.IPNet, dServicecidr *net.IPNet, ...)
- func (c *Client) GetDefaultVersion() (version string, err error)
- func (c *Client) GetFilteredRegionsByVersion(roleARN string, version string, awsClient aws.Client, externalID string) (regions []*cmv1.CloudRegion, err error)
- func (c *Client) GetHTPasswdUserList(clusterID, htpasswdIDPId string) (*cmv1.HTPasswdUserList, error)
- func (c *Client) GetIdentityProviders(clusterID string) ([]*cmv1.IdentityProvider, error)
- func (c *Client) GetIngresses(clusterID string) ([]*cmv1.Ingress, error)
- func (c *Client) GetInstallLogs(clusterID string, tail int) (logs *cmv1.Log, err error)
- func (c *Client) GetLimitedSupportReasons(clusterID string) (limitedSupportReasons []*cmv1.LimitedSupportReason, err error)
- func (c *Client) GetMachinePools(clusterID string) ([]*cmv1.MachinePool, error)
- func (c *Client) GetMachineTypes() (machineTypes MachineTypeList, err error)
- func (c *Client) GetMachineTypesInRegion(cloudProviderData *cmv1.CloudProviderData) (MachineTypeList, error)
- func (c *Client) GetManagedService(args DescribeManagedServiceArgs) (*msv1.ManagedService, error)
- func (c *Client) GetMissingGateAgreements(clusterID string, upgradePolicy *cmv1.UpgradePolicy) ([]*cmv1.VersionGate, error)
- func (c *Client) GetOrganizationLinkedOCMRoles(orgID string) ([]string, error)
- func (c *Client) GetPendingClusterForARN(creator *aws.Creator) (cluster *cmv1.Cluster, err error)
- func (c *Client) GetPolicies(policyType string) (map[string]string, error)
- func (c *Client) GetPolicyVersion(userRequestedVersion string, channelGroup string) (string, error)
- func (c *Client) GetRegionList(multiAZ bool, roleARN string, externalID string, version string, ...) (regionList []string, regionAZ map[string]bool, err error)
- func (c *Client) GetRegions(roleARN string, externalID string) (regions []*cmv1.CloudRegion, err error)
- func (c *Client) GetScheduledUpgrade(clusterID string) (*cmv1.UpgradePolicy, *cmv1.UpgradePolicyState, error)
- func (c *Client) GetUninstallLogs(clusterID string, tail int) (logs *cmv1.Log, err error)
- func (c *Client) GetUpgradePolicies(clusterID string) (upgradePolicies []*cmv1.UpgradePolicy, err error)
- func (c *Client) GetUser(clusterID string, group string, username string) (*cmv1.User, error)
- func (c *Client) GetUsers(clusterID string, group string) ([]*cmv1.User, error)
- func (c *Client) GetVersions(channelGroup string) (versions []*cmv1.Version, err error)
- func (c *Client) GetVersionsList(channelGroup string) ([]string, error)
- func (c *Client) HasClusters(creator *aws.Creator) (bool, error)
- func (c *Client) HibernateCluster(clusterID string) error
- func (c *Client) InstallAddOn(clusterID, addOnID string, params []AddOnParam, billing AddOnBilling) error
- func (c *Client) IsCapabilityEnabled(capability string) (enabled bool, err error)
- func (c *Client) IsSTSClusterExists(creator *aws.Creator, count int, roleARN string) (exists bool, err error)
- func (c *Client) LinkAccountRole(accountID string, roleARN string) error
- func (c *Client) LinkOrgToRole(orgID string, roleARN string) (bool, error)
- func (c *Client) ListAllOcpGates(version string) (versionGates []*cmv1.VersionGate, err error)
- func (c *Client) ListManagedServices(count int) (*msv1.ManagedServiceList, error)
- func (c *Client) ListOcpGates(version string) (stsVersionGates []*cmv1.VersionGate, err error)
- func (c *Client) ListStsGates(version string) (stsVersionGates []*cmv1.VersionGate, err error)
- func (c *Client) LogEvent(key string, body map[string]string)
- func (c *Client) PollInstallLogs(clusterID string, cb func(*cmv1.LogGetResponse) bool) (logs *cmv1.Log, err error)
- func (c *Client) PollUninstallLogs(clusterID string, cb func(*cmv1.LogGetResponse) bool) (logs *cmv1.Log, err error)
- func (c *Client) ResumeCluster(clusterID string) error
- func (c *Client) ScheduleUpgrade(clusterID string, upgradePolicy *cmv1.UpgradePolicy) error
- func (c *Client) UninstallAddOn(clusterID, addOnID string) error
- func (c *Client) UnlinkOCMRoleFromOrg(orgID string, roleARN string) error
- func (c *Client) UnlinkUserRoleFromAccount(accountID string, roleARN string) error
- func (c *Client) UpdateAddOnInstallation(clusterID, addOnID string, params []AddOnParam) error
- func (c *Client) UpdateCluster(clusterKey string, creator *aws.Creator, config Spec) error
- func (c *Client) UpdateIngress(clusterID string, ingress *cmv1.Ingress) (*cmv1.Ingress, error)
- func (c *Client) UpdateMachinePool(clusterID string, machinePool *cmv1.MachinePool) (*cmv1.MachinePool, error)
- func (c *Client) UpdateManagedService(args UpdateManagedServiceArgs) error
- type ClientBuilder
- type ClusterAddOn
- type CreateManagedServiceArgs
- type DeleteManagedServiceArgs
- type DescribeManagedServiceArgs
- type Hypershift
- type MachineType
- type MachineTypeList
- func (mtl *MachineTypeList) Filter(fn func(*MachineType) bool) MachineTypeList
- func (mtl *MachineTypeList) Find(id string) *MachineType
- func (mtl *MachineTypeList) GetAvailableIDs(multiAZ bool) (machineTypeList []string)
- func (mtl *MachineTypeList) IDs() []string
- func (mtl *MachineTypeList) UpdateAvailableQuota(quotaCosts *amsv1.QuotaCostList)
- func (mtl *MachineTypeList) ValidateMachineType(machineType string, multiAZ bool) error
- type OperatorIAMRole
- type Spec
- type UpdateManagedServiceArgs
Constants ¶
const ( ANY = "any" HibernateCapability = "capability.organization.hibernate_cluster" HypershiftCapability = "capability.organization.hypershift" //Pendo Events Success = "Success" Failure = "Failure" Response = "Response" ClusterID = "ClusterID" Version = "Version" Username = "Username" URL = "URL" IsThrottle = "IsThrottle" OCMRoleLabel = "sts_ocm_role" USERRoleLabel = "sts_user_role" )
const ( BYOVPCSingleAZSubnetsCount = 2 BYOVPCMultiAZSubnetsCount = 6 )
const ( HTPasswdIDPType = "HTPasswd" GithubIDPType = "GitHub" GitlabIDPType = "GitLab" GoogleIDPType = "Google" LDAPIDPType = "LDAP" OpenIDIDPType = "OpenID" )
const ( DefaultChannelGroup = "stable" NightlyChannelGroup = "nightly" LowestSTSSupport = "4.7.11" LowestSTSMinor = "4.7" LowestHostedCPSupport = "4.11.6" )
const AcceleratedComputing = "accelerated_computing"
const (
MultiAZCount = 3
)
Variables ¶
var BillingModels = map[string]cmv1.BillingModel{ string(amsv1.BillingModelMarketplace): cmv1.BillingModelMarketplace, string(amsv1.BillingModelStandard): cmv1.BillingModelStandard, string(amsv1.BillingModelMarketplaceAWS): cmv1.BillingModelMarketplaceAWS, string(amsv1.BillingModelMarketplaceAzure): cmv1.BillingModelMarketplaceAzure, string(amsv1.BillingModelMarketplaceRHM): cmv1.BillingModelMarketplaceRHM, }
var BillingOptions = []string{ string(amsv1.BillingModelMarketplace), string(amsv1.BillingModelStandard), string(amsv1.BillingModelMarketplaceAWS), string(amsv1.BillingModelMarketplaceAzure), string(amsv1.BillingModelMarketplaceRHM), }
var NetworkTypes = []string{"OpenShiftSDN", "OVNKubernetes"}
var URLAliases = map[string]string{
"production": "https://api.openshift.com",
"staging": "https://api.stage.openshift.com",
"integration": "https://api.integration.openshift.com",
"local": "http://localhost:8000",
"local-proxy": "http://localhost:9000",
"crc": "https://clusters-service.apps-crc.testing",
}
URLAliases allows the value of the `--env` option to map to the various API URLs.
Functions ¶
func AddClusterFlag ¶ added in v1.1.5
func AddOptionalClusterFlag ¶ added in v1.2.9
func CheckAndParseVersion ¶ added in v1.2.4
func CheckSupportedVersion ¶ added in v1.1.11
func ClusterNameValidator ¶ added in v1.1.1
func ClusterNameValidator(name interface{}) error
func GetClusterKey ¶ added in v1.1.5
func GetVersionID ¶ added in v1.1.0
func GetVersionMinor ¶ added in v1.1.10
func GetVersionMinorList ¶ added in v1.1.3
Get a list of all STS-supported minor versions
func HasHostedCPSupport ¶ added in v1.2.8
func HasSTSSupport ¶ added in v1.1.0
func HasSTSSupportMinor ¶ added in v1.1.0
func IdentityProviderType ¶
func IdentityProviderType(idp *cmv1.IdentityProvider) string
func IsEmptyCIDR ¶ added in v1.1.0
func IsValidClusterKey ¶
func IsValidClusterName ¶ added in v1.1.0
func IsValidUsername ¶
func IsValidVersion ¶ added in v1.2.4
func ParseVersion ¶ added in v1.2.7
func SetClusterKey ¶ added in v1.1.5
func SetClusterKey(key string)
func ValidateAdditionalTrustBundle ¶ added in v1.1.6
func ValidateAdditionalTrustBundle(val interface{}) error
func ValidateAvailabilityZonesCount ¶ added in v1.2.5
func ValidateHTTPProxy ¶ added in v1.1.6
func ValidateHTTPProxy(val interface{}) error
func ValidateSubnetsCount ¶ added in v1.2.5
Types ¶
type AddOnBilling ¶ added in v1.2.7
type AddOnParam ¶ added in v1.1.0
type AddOnResource ¶ added in v0.1.10
type Client ¶ added in v1.1.0
type Client struct {
// contains filtered or unexported fields
}
func CreateNewClientOrExit ¶ added in v1.1.10
func (*Client) AckVersionGate ¶ added in v1.1.8
func (*Client) AcknowledgeGate ¶ added in v1.1.8
func (c *Client) AcknowledgeGate(versionGates []*cmv1.VersionGate) (err error)
func (*Client) AddClusterOperatorRole ¶ added in v1.2.3
func (*Client) AddHTPasswdUser ¶ added in v1.1.12
func (*Client) CancelUpgrade ¶ added in v1.1.0
func (*Client) CheckIfAWSAccountExists ¶ added in v1.1.7
func (*Client) CheckRoleExists ¶ added in v1.1.7
func (c *Client) CheckRoleExists(orgID string, roleName string, awsAccountID string) (bool, string, string, error)
We should allow only one role per aws account per organization If the user request same ocm role we should let them proceed to ensure they can add admin role if not exists or attach policies or link etc if the user request diff ocm role name we error out
func (*Client) CheckUpgradeClusterVersion ¶ added in v1.2.9
func (*Client) CreateCluster ¶ added in v1.1.0
func (*Client) CreateIdentityProvider ¶ added in v1.1.0
func (c *Client) CreateIdentityProvider(clusterID string, idp *cmv1.IdentityProvider) (*cmv1.IdentityProvider, error)
func (*Client) CreateIngress ¶ added in v1.1.0
func (*Client) CreateMachinePool ¶ added in v1.1.0
func (c *Client) CreateMachinePool(clusterID string, machinePool *cmv1.MachinePool) (*cmv1.MachinePool, error)
func (*Client) CreateManagedService ¶ added in v1.2.0
func (c *Client) CreateManagedService(args CreateManagedServiceArgs) (*msv1.ManagedService, error)
func (*Client) CreateUser ¶ added in v1.1.0
func (*Client) DeleteCluster ¶ added in v1.1.0
func (*Client) DeleteHTPasswdUser ¶ added in v1.1.12
func (c *Client) DeleteHTPasswdUser(username, clusterID string, htpasswdIDP *cmv1.IdentityProvider) error
func (*Client) DeleteIdentityProvider ¶ added in v1.1.0
func (*Client) DeleteIngress ¶ added in v1.1.0
func (*Client) DeleteMachinePool ¶ added in v1.1.0
func (*Client) DeleteManagedService ¶ added in v1.2.0
func (c *Client) DeleteManagedService(args DeleteManagedServiceArgs) (*msv1.ManagedServiceDeleteResponse, error)
func (*Client) DeleteUser ¶ added in v1.1.0
func (*Client) FindMissingOperatorRolesForUpgrade ¶ added in v1.2.3
func (*Client) GetAccountLinkedUserRoles ¶ added in v1.1.10
func (*Client) GetAddOnInstallation ¶ added in v1.1.0
func (c *Client) GetAddOnInstallation(clusterID, addOnID string) (*cmv1.AddOnInstallation, error)
func (*Client) GetAddOnParameters ¶ added in v1.1.0
func (c *Client) GetAddOnParameters(clusterID, addOnID string) (*cmv1.AddOnParameterList, error)
func (*Client) GetAllClusters ¶ added in v1.1.5
func (*Client) GetAvailableAddOns ¶ added in v1.1.0
func (c *Client) GetAvailableAddOns() ([]*AddOnResource, error)
Get complete list of available add-ons for the current organization
func (*Client) GetAvailableMachineTypes ¶ added in v1.1.0
func (c *Client) GetAvailableMachineTypes() (MachineTypeList, error)
func (*Client) GetAvailableMachineTypesInRegion ¶ added in v1.2.7
func (c *Client) GetAvailableMachineTypesInRegion(region string, availabilityZones []string, roleARN string, awsClient aws.Client) (MachineTypeList, error)
GetAvailableMachineTypesInRegion get the supported machine type in the region. The function triggers the 'api/clusters_mgmt/v1/aws_inquiries/machine_types' and passes a role ARN for STS clusters or access keys for non-STS clusters.
func (*Client) GetAvailableUpgrades ¶ added in v1.1.0
func (*Client) GetCluster ¶ added in v1.1.0
GetCluster gets a cluster key that can be either 'id', 'name' or 'external_id'
func (*Client) GetClusterAddOns ¶ added in v1.1.0
func (c *Client) GetClusterAddOns(cluster *cmv1.Cluster) ([]*ClusterAddOn, error)
Get all add-ons available for a cluster
func (*Client) GetClusterByID ¶ added in v1.1.5
func (*Client) GetClusterState ¶ added in v1.1.0
func (c *Client) GetClusterState(clusterID string) (cmv1.ClusterState, error)
func (*Client) GetClusterStatus ¶ added in v1.1.0
func (c *Client) GetClusterStatus(clusterID string) (*cmv1.ClusterStatus, error)
func (*Client) GetClusterUsingSubscription ¶ added in v1.1.6
func (*Client) GetClusters ¶ added in v1.1.0
Pass 0 to get all clusters
func (*Client) GetConnectionTokens ¶ added in v1.1.0
func (*Client) GetConnectionURL ¶ added in v1.1.0
func (*Client) GetCredRequests ¶ added in v1.2.3
func (*Client) GetCurrentAccount ¶ added in v1.1.0
func (*Client) GetCurrentOrganization ¶ added in v1.1.0
func (*Client) GetDatabaseRegionList ¶ added in v1.2.9
func (*Client) GetDefaultClusterFlavors ¶ added in v1.1.0
func (*Client) GetDefaultVersion ¶ added in v1.2.3
func (*Client) GetFilteredRegionsByVersion ¶ added in v1.2.7
func (c *Client) GetFilteredRegionsByVersion(roleARN string, version string, awsClient aws.Client, externalID string) (regions []*cmv1.CloudRegion, err error)
GetFilteredRegionsByVersion fetches a list of regions. The 'version' argument is optional for filtering.
func (*Client) GetHTPasswdUserList ¶ added in v1.1.12
func (c *Client) GetHTPasswdUserList(clusterID, htpasswdIDPId string) (*cmv1.HTPasswdUserList, error)
func (*Client) GetIdentityProviders ¶ added in v1.1.0
func (c *Client) GetIdentityProviders(clusterID string) ([]*cmv1.IdentityProvider, error)
func (*Client) GetIngresses ¶ added in v1.1.0
func (*Client) GetInstallLogs ¶ added in v1.1.0
func (*Client) GetLimitedSupportReasons ¶ added in v1.2.9
func (c *Client) GetLimitedSupportReasons(clusterID string) ( limitedSupportReasons []*cmv1.LimitedSupportReason, err error)
func (*Client) GetMachinePools ¶ added in v1.1.0
func (c *Client) GetMachinePools(clusterID string) ([]*cmv1.MachinePool, error)
func (*Client) GetMachineTypes ¶ added in v1.1.0
func (c *Client) GetMachineTypes() (machineTypes MachineTypeList, err error)
func (*Client) GetMachineTypesInRegion ¶ added in v1.2.7
func (c *Client) GetMachineTypesInRegion(cloudProviderData *cmv1.CloudProviderData) (MachineTypeList, error)
func (*Client) GetManagedService ¶ added in v1.2.0
func (c *Client) GetManagedService(args DescribeManagedServiceArgs) (*msv1.ManagedService, error)
func (*Client) GetMissingGateAgreements ¶ added in v1.1.8
func (c *Client) GetMissingGateAgreements( clusterID string, upgradePolicy *cmv1.UpgradePolicy) ([]*cmv1.VersionGate, error)
func (*Client) GetOrganizationLinkedOCMRoles ¶ added in v1.1.10
func (*Client) GetPendingClusterForARN ¶ added in v1.1.0
Gets only pending non-STS clusters that are installed in the same AWS account
func (*Client) GetPolicies ¶ added in v1.2.0
func (*Client) GetPolicyVersion ¶ added in v1.2.9
func (*Client) GetRegionList ¶ added in v1.1.0
func (*Client) GetRegions ¶ added in v1.1.0
func (*Client) GetScheduledUpgrade ¶ added in v1.1.0
func (c *Client) GetScheduledUpgrade(clusterID string) (*cmv1.UpgradePolicy, *cmv1.UpgradePolicyState, error)
func (*Client) GetUninstallLogs ¶ added in v1.1.0
func (*Client) GetUpgradePolicies ¶ added in v1.1.0
func (c *Client) GetUpgradePolicies(clusterID string) (upgradePolicies []*cmv1.UpgradePolicy, err error)
func (*Client) GetVersions ¶ added in v1.1.0
func (*Client) GetVersionsList ¶ added in v1.2.7
func (*Client) HasClusters ¶ added in v1.1.0
func (*Client) HibernateCluster ¶ added in v1.1.0
func (*Client) InstallAddOn ¶ added in v1.1.0
func (c *Client) InstallAddOn(clusterID, addOnID string, params []AddOnParam, billing AddOnBilling) error
func (*Client) IsCapabilityEnabled ¶ added in v1.1.0
func (*Client) IsSTSClusterExists ¶ added in v1.1.5
func (*Client) LinkAccountRole ¶ added in v1.1.6
func (*Client) LinkOrgToRole ¶ added in v1.1.6
func (*Client) ListAllOcpGates ¶ added in v1.1.8
func (c *Client) ListAllOcpGates(version string) (versionGates []*cmv1.VersionGate, err error)
func (*Client) ListManagedServices ¶ added in v1.2.0
func (c *Client) ListManagedServices(count int) (*msv1.ManagedServiceList, error)
func (*Client) ListOcpGates ¶ added in v1.1.8
func (c *Client) ListOcpGates(version string) (stsVersionGates []*cmv1.VersionGate, err error)
func (*Client) ListStsGates ¶ added in v1.1.8
func (c *Client) ListStsGates(version string) (stsVersionGates []*cmv1.VersionGate, err error)
func (*Client) PollInstallLogs ¶ added in v1.1.0
func (*Client) PollUninstallLogs ¶ added in v1.1.0
func (*Client) ResumeCluster ¶ added in v1.1.0
func (*Client) ScheduleUpgrade ¶ added in v1.1.0
func (c *Client) ScheduleUpgrade(clusterID string, upgradePolicy *cmv1.UpgradePolicy) error
func (*Client) UninstallAddOn ¶ added in v1.1.0
func (*Client) UnlinkOCMRoleFromOrg ¶ added in v1.1.10
func (*Client) UnlinkUserRoleFromAccount ¶ added in v1.1.10
func (*Client) UpdateAddOnInstallation ¶ added in v1.1.0
func (c *Client) UpdateAddOnInstallation(clusterID, addOnID string, params []AddOnParam) error
func (*Client) UpdateCluster ¶ added in v1.1.0
func (*Client) UpdateIngress ¶ added in v1.1.0
func (*Client) UpdateMachinePool ¶ added in v1.1.0
func (c *Client) UpdateMachinePool(clusterID string, machinePool *cmv1.MachinePool) (*cmv1.MachinePool, error)
func (*Client) UpdateManagedService ¶ added in v1.2.3
func (c *Client) UpdateManagedService(args UpdateManagedServiceArgs) error
type ClientBuilder ¶ added in v1.1.0
type ClientBuilder struct {
// contains filtered or unexported fields
}
ClientBuilder contains the information and logic needed to build a connection to OCM. Don't create instances of this type directly; use the NewClient function instead.
func NewClient ¶ added in v1.1.0
func NewClient() *ClientBuilder
NewClient creates a builder that can then be used to configure and build an OCM connection.
func (*ClientBuilder) Build ¶ added in v1.1.0
func (b *ClientBuilder) Build() (result *Client, err error)
Build uses the information stored in the builder to create a new OCM connection.
func (*ClientBuilder) Config ¶ added in v1.1.0
func (b *ClientBuilder) Config(value *config.Config) *ClientBuilder
Config sets the configuration that the connection will use to authenticate the user
func (*ClientBuilder) Logger ¶ added in v1.1.0
func (b *ClientBuilder) Logger(value *logrus.Logger) *ClientBuilder
Logger sets the logger that the connection will use to send messages to the log. This is mandatory.
type ClusterAddOn ¶
type CreateManagedServiceArgs ¶ added in v1.2.0
type CreateManagedServiceArgs struct { ServiceType string ClusterName string Parameters map[string]string Properties map[string]string AwsAccountID string AwsRoleARN string AwsSupportRoleARN string AwsControlPlaneRoleARN string AwsWorkerRoleARN string AwsRegion string AwsOperatorIamRoleList []OperatorIAMRole // Custom network configuration MultiAZ bool Privatelink bool AvailabilityZones []string SubnetIDs []string MachineCIDR net.IPNet PodCIDR net.IPNet ServiceCIDR net.IPNet HostPrefix int // create a fake cluster with no aws resources FakeCluster bool }
type DeleteManagedServiceArgs ¶ added in v1.2.0
type DeleteManagedServiceArgs struct {
ID string
}
type DescribeManagedServiceArgs ¶ added in v1.2.0
type DescribeManagedServiceArgs struct {
ID string
}
type Hypershift ¶ added in v1.2.7
type Hypershift struct {
Enabled bool
}
type MachineType ¶ added in v1.1.0
type MachineType struct { MachineType *cmv1.MachineType Available bool // contains filtered or unexported fields }
func (MachineType) HasQuota ¶ added in v1.1.10
func (mt MachineType) HasQuota(multiAZ bool) bool
type MachineTypeList ¶ added in v1.1.10
type MachineTypeList []*MachineType
A list of MachineTypes with additional information
func (*MachineTypeList) Filter ¶ added in v1.1.10
func (mtl *MachineTypeList) Filter(fn func(*MachineType) bool) MachineTypeList
Filter returns a new MachineTypeList with only elements for which fn returned true
func (*MachineTypeList) Find ¶ added in v1.1.10
func (mtl *MachineTypeList) Find(id string) *MachineType
Find returns the first MachineType matching the ID
func (*MachineTypeList) GetAvailableIDs ¶ added in v1.1.10
func (mtl *MachineTypeList) GetAvailableIDs(multiAZ bool) (machineTypeList []string)
func (*MachineTypeList) IDs ¶ added in v1.1.10
func (mtl *MachineTypeList) IDs() []string
IDs extracts list of IDs from a MachineTypeList
func (*MachineTypeList) UpdateAvailableQuota ¶ added in v1.1.10
func (mtl *MachineTypeList) UpdateAvailableQuota(quotaCosts *amsv1.QuotaCostList)
func (*MachineTypeList) ValidateMachineType ¶ added in v1.1.10
func (mtl *MachineTypeList) ValidateMachineType(machineType string, multiAZ bool) error
Validate AWS machine type is available with enough quota in the list
type OperatorIAMRole ¶ added in v1.1.0
type Spec ¶ added in v1.1.0
type Spec struct { // Basic configs Name string Region string MultiAZ bool Version string ChannelGroup string Expiration time.Time Flavour string DisableWorkloadMonitoring *bool //Encryption FIPS bool EtcdEncryption bool KMSKeyArn string // Scaling config ComputeMachineType string ComputeNodes int Autoscaling bool MinReplicas int MaxReplicas int // SubnetIDs SubnetIds []string // AvailabilityZones AvailabilityZones []string // Network config NetworkType string MachineCIDR net.IPNet ServiceCIDR net.IPNet PodCIDR net.IPNet HostPrefix int Private *bool PrivateLink *bool // Properties CustomProperties map[string]string // User-defined tags for AWS resources Tags map[string]string // Simulate creating a cluster but don't actually create it DryRun *bool // Disable SCP checks in the installer by setting credentials mode as mint DisableSCPChecks *bool // STS IsSTS bool RoleARN string ExternalID string SupportRoleARN string OperatorIAMRoles []OperatorIAMRole ControlPlaneRoleARN string WorkerRoleARN string Mode string NodeDrainGracePeriodInMinutes float64 EnableProxy bool HTTPProxy *string HTTPSProxy *string NoProxy *string AdditionalTrustBundleFile *string AdditionalTrustBundle *string // HyperShift options: Hypershift Hypershift }
Spec is the configuration for a cluster spec.