cloud

Documentation

Index

• Constants
• Variables
• func GetAWSV2Config(backplaneURL string, clusterId string) (aws.Config, error)
• type AWSCredentialsResponse
  • func (r *AWSCredentialsResponse) AWSV2Config() (aws.Config, error)
  • func (r *AWSCredentialsResponse) String() string
• type ConsoleResponse
  • func (r *ConsoleResponse) String() string
• type CredentialsResponse
• type GCPCredentialsResponse
  • func (r *GCPCredentialsResponse) String() string

Constants

const EnvBrowserDefault = "BACKPLANE_DEFAULT_OPEN_BROWSER"

Environment variable that indicates if open by browser is set as default

Variables

var CloudCmd *cobra.Command = &cobra.Command{
	Use:               "cloud",
	Short:             "Cloud Access and Subcommands",
	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

Functions

func GetAWSV2Config

func GetAWSV2Config(backplaneURL string, clusterId string) (aws.Config, error)

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

Types

type AWSCredentialsResponse

type AWSCredentialsResponse struct {
	AccessKeyId     string `json:"AccessKeyId" yaml:"AccessKeyId"`
	SecretAccessKey string `json:"SecretAccessKey" yaml:"SecretAccessKey"`
	SessionToken    string `json:"SessionToken" yaml:"SessionToken"`
	Region          string `json:"Region" yaml:"Region"`
	Expiration      string `json:"Expiration" yaml:"Expiration"`
}

func (*AWSCredentialsResponse) AWSV2Config

func (r *AWSCredentialsResponse) AWSV2Config() (aws.Config, error)

AWSV2Config returns an aws-sdk-go-v2 config that can be used to programmatically access the AWS API

func (*AWSCredentialsResponse) String

func (r *AWSCredentialsResponse) String() string

type ConsoleResponse

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

func (*ConsoleResponse) String

func (r *ConsoleResponse) String() string

type CredentialsResponse

type CredentialsResponse interface {
	// String returns a friendly message outlining how users can setup cloud environment access
	String() string
	// contains filtered or unexported methods
}

type GCPCredentialsResponse

type GCPCredentialsResponse struct {
	ProjectId string `json:"project_id" yaml:"project_id"`
}

func (*GCPCredentialsResponse) String

func (r *GCPCredentialsResponse) String() string