cloud

Documentation

Index

• Constants
• Variables
• type ConsoleResponse
  • func (r *ConsoleResponse) String() string
• type QueryConfig
  • func (cfg *QueryConfig) GetAWSV2Config() (aws.Config, error)
  • func (cfg *QueryConfig) GetCloudConsole() (*ConsoleResponse, error)
  • func (cfg *QueryConfig) GetCloudCredentials() (bpCredentials.Response, error)

Constants

const (
	OldFlowSupportRole  = "role/RH-Technical-Support-Access"
	CustomerRoleArnName = "Target-Role-Arn"
	OrgRoleArnName      = "Org-Role-Arn"
)

const EnvBrowserDefault = "BACKPLANE_DEFAULT_OPEN_BROWSER"

EnvBrowserDefault environment variable that indicates if open by browser is set as default

Variables

var AssumeRoleSequence = awsutil.AssumeRoleSequence

var AssumeRoleWithJWT = awsutil.AssumeRoleWithJWT

var CloudCmd = &cobra.Command{
	Use:               "cloud",
	Short:             "Cluster cloud provider access",
	Args:              cobra.NoArgs,
	DisableAutoGenTag: true,
	Run:               help,
}

var ConsoleCmd = &cobra.Command{
	Use:   "console [CLUSTERID|EXTERNAL_ID|CLUSTER_NAME|CLUSTER_NAME_SEARCH]",
	Short: "Requests a link to cluster's cloud provider's console",
	Long: `Requests a link that utilizes temporary cloud credentials for the cluster's cloud provider's web console.
	This allows us to be able to perform operations such as debugging an issue, troubleshooting a customer
	misconfiguration, or directly access the underlying cloud infrastructure. If no cluster identifier is provided, the
	currently logged in cluster will be used.`,
	Example:      " backplane cloud console\n backplane cloud console <id>\n backplane cloud console %test%\n backplane cloud console <external_id>",
	Args:         cobra.RangeArgs(0, 1),
	Aliases:      []string{"link", "web"},
	RunE:         runConsole,
	SilenceUsage: true,
}

ConsoleCmd represents the cloud credentials command

var CredentialsCmd = &cobra.Command{
	Use:   "credentials [CLUSTERID|EXTERNAL_ID|CLUSTER_NAME|CLUSTER_NAME_SEARCH]",
	Short: "Requests a set of temporary cloud credentials for the cluster's cloud provider",
	Long: `Requests a set of temporary cloud credentials for the cluster's cloud provider. This allows us to be able to
	perform operations such as debugging an issue, troubleshooting a customer misconfiguration, or directly access the
	underlying cloud infrastructure. If no cluster identifier is provided, the currently logged in cluster will be used.`,
	Example:      " backplane cloud credentials\n backplane cloud credentials <id>\n backplane cloud credentials %test%\n backplane cloud credentials <external_id>",
	Args:         cobra.RangeArgs(0, 1),
	Aliases:      []string{"creds", "cred"},
	RunE:         runCredentials,
	SilenceUsage: true,
}

CredentialsCmd represents the cloud credentials command

var GetBackplaneClusterFromConfig = utils.DefaultClusterUtils.GetBackplaneClusterFromConfig

var GetBackplaneConfiguration = bpconfig.GetBackplaneConfiguration

var NewStaticCredentialsProvider = credentials.NewStaticCredentialsProvider

var StsClient = awsutil.StsClient

Types

type ConsoleResponse

type ConsoleResponse struct {
	ConsoleLink string `json:"ConsoleLink" yaml:"ConsoleLink"`
}

func (*ConsoleResponse) String

func (r *ConsoleResponse) String() string

type QueryConfig

type QueryConfig struct {
	config.BackplaneConfiguration
	OcmConnection *ocmsdk.Connection
	Cluster       *cmv1.Cluster
}

QueryConfig Wrapper for the configuration needed for cloud requests

func (*QueryConfig) GetAWSV2Config

func (cfg *QueryConfig) GetAWSV2Config() (aws.Config, error)

GetAWSV2Config allows consumers to get an aws-sdk-go-v2 Config to programmatically access the AWS API

func (*QueryConfig) GetCloudConsole

func (cfg *QueryConfig) GetCloudConsole() (*ConsoleResponse, error)

GetCloudConsole returns Cloud Credentials Response

func (*QueryConfig) GetCloudCredentials

func (cfg *QueryConfig) GetCloudCredentials() (bpCredentials.Response, error)

GetCloudCredentials returns Cloud Credentials Response