ibm

README

IBM Plugin

Authentication

To use IBM services include the API key of the resource group in ~/.ibm/credentials.yaml:

iam_api_key: <KEY>

To create a new API key, run the following command:

mkdir -p ~/.ibm
ibmcloud iam api-key-create pgkey | grep "API Key" | { echo -n "iam_api_key: " & grep -o '[^ ]\+$'; } > ~/.ibm/credentials.yaml

Instance Keys

Upon invoking CreateResource, local SSH keys will be created automatically in ~/.ibm/keys and be registered on the IBM VPC platform in the specified region. The keys will be associated with the newly launched instance.
New invocations of CreateResource will reuse the created keys and register the public key only if a key matching its value doesn't already exist in the region.

Quotas

To maximize flexibility in the deployment's scale we recommend increasing the quota of the following resources by opening a ticket with cloud support:

• VPCs.
• Global Transit Gateway connections by disabling (setting to 0) all non VPC connections.
  A user may further increase the number of connections by reducing the number of Global Transit Gateways per region. e.g., currently reducing the quota for TGW per region from 5 to 3 will raise max connections quota from 25 to 43.

Documentation

Index

• func AreStructsEqual(s1, s2 interface{}, fieldsToExclude []string) bool
• func DoesSliceContain[T comparable](slice []T, target T) bool
• func GetStructHash(s interface{}, fieldsToExclude []string) (uint64, error)
• func IsRegionValid(region string) (bool, error)
• func ZoneToRegion(zone string) (string, error)

Functions

func AreStructsEqual

func AreStructsEqual(s1, s2 interface{}, fieldsToExclude []string) bool

AreStructsEqual returns true if two given structs of the same type have matching fields values on all types except those listed in fieldsToExclude

func DoesSliceContain

func DoesSliceContain[T comparable](slice []T, target T) bool

DoesSliceContain returns true if a slice contains an item

func GetStructHash

func GetStructHash(s interface{}, fieldsToExclude []string) (uint64, error)

returns hash value of any struct containing primitives, or slices of primitives. fieldsToExclude contains field names to be excluded from hash calculation.

func IsRegionValid

func IsRegionValid(region string) (bool, error)

IsRegionValid returns true if region is a valid IBM region

func ZoneToRegion

func ZoneToRegion(zone string) (string, error)

returns region of string with region validation