utils

Documentation

Index

• Constants
• Variables
• func ApplyFilters(ocmClient *sdk.Connection, filters []string) ([]*v1.Cluster, error)
• func ConfirmSend() error
• func Contains(list []string, key string) bool
• func CreateConnection() *sdk.Connection
• func GenerateQuery(clusterIdentifier string) string
• func GetAWSAccountIdForCluster(ocmClient *sdk.Connection, clusterID string) (string, error)
• func GetAccount(connection *sdk.Connection, key string) (account *amv1.Account, err error)
• func GetBackplaneURL(clusterID string) (string, error)
• func GetCluster(connection *sdk.Connection, key string) (cluster *cmv1.Cluster, err error)
• func GetClusterAnyStatus(conn *sdk.Connection, clusterId string) (*v1.Cluster, error)
• func GetClusters(ocmClient *sdk.Connection, clusterIds []string) []*v1.Cluster
• func GetCurrentOCMEnv(connection *sdk.Connection) string
• func GetHiveShard(clusterID string) (string, error)
• func GetLatestVersion() (latest string, err error)
• func GetOCMApiServerToken() (*string, error)
• func GetOrgfromClusterID(ocmClient *sdk.Connection, cluster v1.Cluster) (string, error)
• func GetSubscription(connection *sdk.Connection, key string) (subscription *amv1.Subscription, err error)
• func GetSupportRoleArnForCluster(ocmClient *sdk.Connection, clusterID string) (string, error)
• func IsClusterCCS(ocmClient *sdk.Connection, clusterID string) (bool, error)
• func IsValidClusterKey(clusterKey string) (err error)
• func IsValidKey(clusterKey string) bool
• func StreamErrorln(stream genericclioptions.IOStreams, msg string)
• func StreamPrint(stream genericclioptions.IOStreams, msg string)
• func StreamPrintln(stream genericclioptions.IOStreams, msg string)
• func StreamRead(stream genericclioptions.IOStreams, delim byte) (string, error)
• type LimitedSupportReasonItem
  • func GetClusterLimitedSupportReasons(connection *sdk.Connection, clusterID string) ([]*LimitedSupportReasonItem, error)

Constants

const (
	VersionAPIEndpoint     = "https://api.github.com/repos/openshift/osdctl/releases/latest"
	VersionAddressTemplate = "https://github.com/openshift/osdctl/releases/download/v%s/osdctl_%s_%s_%s.tar.gz" // version, version, GOOS, GOARCH
)

const ClusterServiceClusterSearch = "id = '%s' or name = '%s' or external_id = '%s'"

Variables

var (
	// GitCommit is the short git commit hash from the environment
	// Will be set during build process via GoReleaser
	// See also: https://pkg.go.dev/cmd/link
	GitCommit string

	// Version is the tag version from the environment
	// Will be set during build process via GoReleaser
	// See also: https://pkg.go.dev/cmd/link
	Version string
)

Functions

func ApplyFilters

func ApplyFilters(ocmClient *sdk.Connection, filters []string) ([]*v1.Cluster, error)

ApplyFilters retrieves clusters in OCM which match the filters given

func ConfirmSend

func ConfirmSend() error

func Contains

func Contains(list []string, key string) bool

Contains returns true if the given key is present in the provided list

func CreateConnection

func CreateConnection() *sdk.Connection

func GenerateQuery

func GenerateQuery(clusterIdentifier string) string

GenerateQuery returns an OCM search query to retrieve all clusters matching an expression (ie- "foo%")

func GetAWSAccountIdForCluster

func GetAWSAccountIdForCluster(ocmClient *sdk.Connection, clusterID string) (string, error)

func GetAccount

func GetAccount(connection *sdk.Connection, key string) (account *amv1.Account, err error)

GetAccount Function allows to get a single account with any identifier (username, ID)

func GetBackplaneURL

func GetBackplaneURL(clusterID string) (string, error)

Returns the backplane url corresponding to a cluster e.g. https://api-backplane.apps.<hive_cluster>.p1.openshiftapps.com/backplane/cloud/credentials/<cluster_id>

func GetCluster

func GetCluster(connection *sdk.Connection, key string) (cluster *cmv1.Cluster, err error)

GetCluster Function allows to get a single cluster with any identifier (displayname, ID, or external ID)

func GetClusterAnyStatus

func GetClusterAnyStatus(conn *sdk.Connection, clusterId string) (*v1.Cluster, error)

GetClusterAnyStatus returns an OCM cluster object given an OCM connection and cluster id (internal and external ids both supported).

func GetClusters

func GetClusters(ocmClient *sdk.Connection, clusterIds []string) []*v1.Cluster

func GetCurrentOCMEnv

func GetCurrentOCMEnv(connection *sdk.Connection) string

func GetHiveShard

func GetHiveShard(clusterID string) (string, error)

Returns the hive shard corresponding to a cluster e.g. https://api.<hive_cluster>.byo5.p1.openshiftapps.com:6443

func GetLatestVersion

func GetLatestVersion() (latest string, err error)

getLatestVersion connects to the GitHub API and returns the latest osdctl tag name Interesting Note: GitHub only shows the latest "stable" tag. This means, that tags with a suffix like *-rc.1 are not returned. We will always show the latest stable on master branch.

func GetOCMApiServerToken

func GetOCMApiServerToken() (*string, error)

Returns the token created from ocm login to the api server

func GetOrgfromClusterID

func GetOrgfromClusterID(ocmClient *sdk.Connection, cluster v1.Cluster) (string, error)

func GetSubscription

func GetSubscription(connection *sdk.Connection, key string) (subscription *amv1.Subscription, err error)

GetSubscription Function allows to get a single subscription with any identifier (displayname, ID, internal or external ID)

func GetSupportRoleArnForCluster

func GetSupportRoleArnForCluster(ocmClient *sdk.Connection, clusterID string) (string, error)

func IsClusterCCS

func IsClusterCCS(ocmClient *sdk.Connection, clusterID string) (bool, error)

func IsValidClusterKey

func IsValidClusterKey(clusterKey string) (err error)

func IsValidKey

func IsValidKey(clusterKey string) bool

func StreamErrorln

func StreamErrorln(stream genericclioptions.IOStreams, msg string)

streamPrint prints the given error msg using the provided IOStreams

func StreamPrint

func StreamPrint(stream genericclioptions.IOStreams, msg string)

streamPrint prints the given msg using the provided IOStreams

func StreamPrintln

func StreamPrintln(stream genericclioptions.IOStreams, msg string)

streamPrintln appends a newline then prints the given msg using the provided IOStreams

func StreamRead

func StreamRead(stream genericclioptions.IOStreams, delim byte) (string, error)

StreamRead retrieves input from the provided IOStreams up to (and including) the delimiter given

Types

type LimitedSupportReasonItem

type LimitedSupportReasonItem struct {
	ID      string
	Summary string
	Details string
}

func GetClusterLimitedSupportReasons

func GetClusterLimitedSupportReasons(connection *sdk.Connection, clusterID string) ([]*LimitedSupportReasonItem, error)