osdCloud

Documentation

Index

• Constants
• func CreateAWSV2Config(conn *sdk.Connection, cluster *cmv1.Cluster) (awsSdk.Config, error)
• func GenerateAWSClientForCluster(awsProfile string, clusterID string) (aws.Client, error)
• func GenerateCCSClusterAWSClient(ocmClient *sdk.Connection, awsClient aws.Client, clusterID string, ...) (aws.Client, error)
• func GenerateGCPComputeInstancesClient() (*compute.InstancesClient, error)
• func GenerateJumpRoleCredentials(client aws.Client, region, sessionName string) (*stsTypes.Credentials, error)
• func GenerateNonCCSClusterAWSClient(ocmClient *sdk.Connection, awsClient aws.Client, clusterID string, ...) (aws.Client, error)
• func GenerateOrganizationAccountAccessCredentials(client aws.Client, accountId, sessionName, partition string) (*stsTypes.Credentials, error)
• func GenerateRoleSessionName(client aws.Client) (string, error)
• func GenerateSupportRoleCredentials(client aws.Client, region, sessionName, targetRole string) (*stsTypes.Credentials, error)
• func ListInstances(client *compute.InstancesClient, projectID, zone string) *compute.InstanceIterator
• type AwsCluster
  • func (a *AwsCluster) Close()
  • func (a *AwsCluster) GetAZs() []string
  • func (a *AwsCluster) GetAllVirtualMachines(string) ([]VirtualMachine, error)
  • func (a *AwsCluster) Login() error
• type BaseClient
  • func (b *BaseClient) GetCluster() *ocmv1.Cluster
• type ClusterHealthClient
  • func NewAwsCluster(ocmClient *sdk.Connection, clusterId string, awsProfile string) (ClusterHealthClient, error)
  • func NewGcpCluster(ocmClient *sdk.Connection, clusterId string) (ClusterHealthClient, error)
• type GcpCluster
  • func (g *GcpCluster) Close()
  • func (g *GcpCluster) GetAZs() []string
  • func (g *GcpCluster) GetAllVirtualMachines(region string) ([]VirtualMachine, error)
  • func (g *GcpCluster) Login() error
• type GcpProjectClaim
  • func ParseGcpProjectClaim(raw string) (*GcpProjectClaim, error)
• type GcpProjectClaimSpec
• type VirtualMachine

Constants

const (
	RhSreCcsAccessRolename        = "RH-SRE-CCS-Access"
	RhTechnicalSupportAccess      = "RH-Technical-Support-Access"
	OrganizationAccountAccessRole = "OrganizationAccountAccessRole"
	ProdJumproleConfigKey         = "prod_jumprole_account_id"
	StageJumproleConfigKey        = "stage_jumprole_account_id"
)

Functions

func CreateAWSV2Config

func CreateAWSV2Config(conn *sdk.Connection, cluster *cmv1.Cluster) (awsSdk.Config, error)

CreateAWSV2Config creates an aws-sdk-go-v2 config via Backplane given an internal cluster id

func GenerateAWSClientForCluster

func GenerateAWSClientForCluster(awsProfile string, clusterID string) (aws.Client, error)

GenerateAWSClientForCluster generates an AWS client given an OCM cluster id and AWS profile name. If an AWS profile name is not specified, this function will also read the AWS_PROFILE environment variable or use the default AWS profile.

func GenerateCCSClusterAWSClient

func GenerateCCSClusterAWSClient(ocmClient *sdk.Connection, awsClient aws.Client, clusterID string, clusterRegion string, partition string, sessionName string) (aws.Client, error)

func GenerateGCPComputeInstancesClient

func GenerateGCPComputeInstancesClient() (*compute.InstancesClient, error)

func GenerateJumpRoleCredentials

func GenerateJumpRoleCredentials(client aws.Client, region, sessionName string) (*stsTypes.Credentials, error)

GenerateJumpRoleCredentials performs the Assume Role chain from IAM User to the Jump role This sequence stays within the Red Hat account boundary, so a failure here indicates an internal misconfiguration

func GenerateNonCCSClusterAWSClient

func GenerateNonCCSClusterAWSClient(ocmClient *sdk.Connection, awsClient aws.Client, clusterID string, clusterRegion string, partition string, sessionName string) (aws.Client, error)

func GenerateOrganizationAccountAccessCredentials

func GenerateOrganizationAccountAccessCredentials(client aws.Client, accountId, sessionName, partition string) (*stsTypes.Credentials, error)

GenerateOrganizationAccountAccessCredentials Uses the provided IAM Client to try and assume OrganizationAccountAccessRole for the given AWS Account This only works when the provided client is a user from the root account of an organization and the AWS account provided is a linked accounts within that organization

func GenerateRoleSessionName

func GenerateRoleSessionName(client aws.Client) (string, error)

GenerateRoleSessionName Uses the current IAM ARN to generate a role name. This should end up being RH-SRE-$kerberosID

func GenerateSupportRoleCredentials

func GenerateSupportRoleCredentials(client aws.Client, region, sessionName, targetRole string) (*stsTypes.Credentials, error)

GenerateSupportRoleCredentials Uses the provided IAM Client to perform the Assume Role chain needed to get to a cluster's Support Role

func ListInstances

func ListInstances(client *compute.InstancesClient, projectID, zone string) *compute.InstanceIterator

Types

type AwsCluster

type AwsCluster struct {
	*BaseClient
	AZs        []string
	AwsProfile string
	AwsClient  aws.Client
}

AwsCluster Concrete struct with fields required only for interacting with the AWS cloud.

func (*AwsCluster) Close

func (a *AwsCluster) Close()

func (*AwsCluster) GetAZs

func (a *AwsCluster) GetAZs() []string

func (*AwsCluster) GetAllVirtualMachines

func (a *AwsCluster) GetAllVirtualMachines(string) ([]VirtualMachine, error)

func (*AwsCluster) Login

func (a *AwsCluster) Login() error

type BaseClient

type BaseClient struct {
	ClusterId string
	OcmClient *sdk.Connection
	Cluster   *ocmv1.Cluster
}

BaseClient A common struct used to not repeat fields used in the sub'classes' for AWS and GCP.

func (*BaseClient) GetCluster

func (b *BaseClient) GetCluster() *ocmv1.Cluster

type ClusterHealthClient

type ClusterHealthClient interface {
	Login() error
	GetCluster() *ocmv1.Cluster
	GetAZs() []string
	GetAllVirtualMachines(region string) ([]VirtualMachine, error)
	Close()
}

ClusterHealthClient This client is used to interface with AWS & GCP and provide common abstractions that are generated from the cloud-specific resources. Right now the client is only used by the `osdctl cluster health` command and only provides functions used in that command. It can and should be extended as seen fit if it seems useful.

func NewAwsCluster

func NewAwsCluster(ocmClient *sdk.Connection, clusterId string, awsProfile string) (ClusterHealthClient, error)

func NewGcpCluster

func NewGcpCluster(ocmClient *sdk.Connection, clusterId string) (ClusterHealthClient, error)

type GcpCluster

type GcpCluster struct {
	*BaseClient
	ComputeClient *compute.InstancesClient
	ProjectId     string
	Zones         []string
}

Concrete struct with fields required only for interacting with the GCP cloud.

func (*GcpCluster) Close

func (g *GcpCluster) Close()

func (*GcpCluster) GetAZs

func (g *GcpCluster) GetAZs() []string

func (*GcpCluster) GetAllVirtualMachines

func (g *GcpCluster) GetAllVirtualMachines(region string) ([]VirtualMachine, error)

func (*GcpCluster) Login

func (g *GcpCluster) Login() error

type GcpProjectClaim

type GcpProjectClaim struct {
	Spec GcpProjectClaimSpec `json:"spec"`
}

func ParseGcpProjectClaim

func ParseGcpProjectClaim(raw string) (*GcpProjectClaim, error)

type GcpProjectClaimSpec

type GcpProjectClaimSpec struct {
	GcpProjectID string `json:"gcpProjectID"`
}

type VirtualMachine

type VirtualMachine struct {
	Original interface{}
	Name     string
	Size     string
	State    string
	Labels   map[string]string
}

VirtualMachine Abstract the AWS instances and GCP instances into a common type. The Original field should store the data returned by the cloud directly, so it can be accessed via casting if needed.