vpc

Documentation

Index

• Constants
• Variables
• func CreateAuthenticator(apiKey string, isIAMApiEndpoint string) (core.Authenticator, error)
• func CreateAuthenticatorFromEnv(env E.Environment) (core.Authenticator, error)
• func CreateGlobalSearchService(auth core.Authenticator, globalSearchEndpoint string) (*globalsearchv2.GlobalSearchV2, error)
• func CreateGlobalSearchServiceFromEnv(auth core.Authenticator, env E.Environment) (*globalsearchv2.GlobalSearchV2, error)
• func CreateGlobalTaggingService(auth core.Authenticator, globalTaggingEndpoint string) (*globaltaggingv1.GlobalTaggingV1, error)
• func CreateTaggingServiceFromEnv(auth core.Authenticator, env E.Environment) (*globaltaggingv1.GlobalTaggingV1, error)
• func CreateVpcService(auth core.Authenticator, isApiEndpoint string) (*vpcv1.VpcV1, error)
• func CreateVpcServiceFromEnv(auth core.Authenticator, env E.Environment) (*vpcv1.VpcV1, error)
• func CreateVpcServiceFromEnvAndRegion(auth core.Authenticator, region string, env E.Environment) (*vpcv1.VpcV1, error)
• func EnvFromDotEnv(root string) (env.Environment, error)
• func FindInstance(service *vpcv1.VpcV1, name string) (*vpcv1.Instance, error)
• func FindLatestStockImage(service *vpcv1.VpcV1) (string, error)
• func FindRegionFromSubnet(search *globalsearchv2.GlobalSearchV2) func(subnetID string) (string, error)
• func Findimage(service *vpcv1.VpcV1, name string) (string, error)
• func GetDefaultIBMCloudApiEndpoint(region string) string
• func GetGlobalSearchEndpoint(env E.Environment) string
• func GetIBMCloudApiEndpoint(env E.Environment, defEndpoint string) string
• func GetIBMCloudApiKey(env E.Environment) (string, error)
• func GetIBMCloudGtApiEndpoint(env E.Environment) string
• func GetIBMCloudIAMApiEndpoint(env E.Environment) string
• func GetRegion(env E.Environment) string
• type Image
  • func FindStockImages(service *vpcv1.VpcV1) ([]Image, error)

Constants

const (
	DefaultIBMCloudIAMApiEndpoint = "https://iam.cloud.ibm.com"
	KeyIBMCloudIAMApiEndpoint     = "IBMCLOUD_IAM_API_ENDPOINT"
	KeyIBMCloudApiKey             = "IBMCLOUD_API_KEY" // #nosec
)

const (
	DefaultRegion     = "us-south"
	KeyIBMCloudRegion = "IBMCLOUD_REGION"
)

const (
	KeyIBMCloudGsApiEndpoint     = "IBMCLOUD_GS_API_ENDPOINT"
	DefaultIBMCloudGsApiEndpoint = globalsearchv2.DefaultServiceURL
)

const (
	KeyIBMCloudGtApiEndpoint     = "IBMCLOUD_GT_API_ENDPOINT"
	DefaultIBMCloudGtApiEndpoint = globaltaggingv1.DefaultServiceURL
)

const (
	KeyIBMCloudIsApiEndpoint = "IBMCLOUD_IS_API_ENDPOINT"
)

Variables

var ErrorStockImageNotFound = errors.New("stock image was not found")

var InstanceNotFound = errors.New("instance was not found")

Functions

func CreateAuthenticator

func CreateAuthenticator(apiKey string, isIAMApiEndpoint string) (core.Authenticator, error)

func CreateAuthenticatorFromEnv

func CreateAuthenticatorFromEnv(env E.Environment) (core.Authenticator, error)

func CreateGlobalSearchService

func CreateGlobalSearchService(auth core.Authenticator, globalSearchEndpoint string) (*globalsearchv2.GlobalSearchV2, error)

func CreateGlobalSearchServiceFromEnv

func CreateGlobalSearchServiceFromEnv(auth core.Authenticator, env E.Environment) (*globalsearchv2.GlobalSearchV2, error)

func CreateGlobalTaggingService

func CreateGlobalTaggingService(auth core.Authenticator, globalTaggingEndpoint string) (*globaltaggingv1.GlobalTaggingV1, error)

func CreateTaggingServiceFromEnv

func CreateTaggingServiceFromEnv(auth core.Authenticator, env E.Environment) (*globaltaggingv1.GlobalTaggingV1, error)

func CreateVpcService

func CreateVpcService(auth core.Authenticator, isApiEndpoint string) (*vpcv1.VpcV1, error)

func CreateVpcServiceFromEnv

func CreateVpcServiceFromEnv(auth core.Authenticator, env E.Environment) (*vpcv1.VpcV1, error)

func CreateVpcServiceFromEnvAndRegion

func CreateVpcServiceFromEnvAndRegion(auth core.Authenticator, region string, env E.Environment) (*vpcv1.VpcV1, error)

func EnvFromDotEnv

func EnvFromDotEnv(root string) (env.Environment, error)

func FindInstance

func FindInstance(service *vpcv1.VpcV1, name string) (*vpcv1.Instance, error)

func FindLatestStockImage

func FindLatestStockImage(service *vpcv1.VpcV1) (string, error)

func FindRegionFromSubnet

func FindRegionFromSubnet(search *globalsearchv2.GlobalSearchV2) func(subnetID string) (string, error)

FindRegionFromSubnet locates the region from a subnet

func Findimage

func Findimage(service *vpcv1.VpcV1, name string) (string, error)

func GetDefaultIBMCloudApiEndpoint

func GetDefaultIBMCloudApiEndpoint(region string) string

func GetGlobalSearchEndpoint

func GetGlobalSearchEndpoint(env E.Environment) string

GetGlobalSearchEndpoint returns the configured endpoint URL for the search API

func GetIBMCloudApiEndpoint

func GetIBMCloudApiEndpoint(env E.Environment, defEndpoint string) string

GetIBMCloudApiEndpoint returns the configured endpoint URL for the VPC APIs

func GetIBMCloudApiKey

func GetIBMCloudApiKey(env E.Environment) (string, error)

func GetIBMCloudGtApiEndpoint

func GetIBMCloudGtApiEndpoint(env E.Environment) string

func GetIBMCloudIAMApiEndpoint

func GetIBMCloudIAMApiEndpoint(env E.Environment) string

func GetRegion

func GetRegion(env E.Environment) string

Types

type Image

type Image struct {
	ID      string
	Version *semver.Version
}

func FindStockImages

func FindStockImages(service *vpcv1.VpcV1) ([]Image, error)