constants

Documentation

Index

• Constants
• Variables

Constants

const (
	FlagDatacenterId    = "datacenter-id"
	FlagSnapshotId      = "snapshot-id"
	FlagIdShort         = "i"
	FlagName            = "name"
	FlagNameShort       = "n"
	FlagTemplate        = "template"
	FlagTemplateId      = "template-id"
	FlagInstances       = "instances"
	FlagShards          = "shards"
	FlagMaintenanceTime = "maintenance-time"
	FlagMaintenanceDay  = "maintenance-day"
	FlagLocation        = "location"
	FlagLocationShort   = "l"
	FlagOffset          = "offset"
	// DescAuthenticationOrder explains auth order. Embed this in any auth-related commands
	DescAuthenticationOrder = `` /* 579-byte string literal not displayed */

	FlagMaxResults      = "max-results"
	FlagMaxResultsShort = "M"
	FlagCidr            = "cidr"
	FlagIp              = "ip"
	FlagIps             = "ips"
	FlagLanId           = "lan-id"
	FlagEdition         = "edition"

	FlagGatewayID      = "gateway-id"
	FlagTunnelID       = "tunnel-id"
	FlagPeerID         = "peer-id"
	FlagGatewayIP      = "gateway-ip"
	FlagInterfaceIP    = "interface-ip"
	FlagConnectionIP   = "connection-ip"
	FlagPrivateKey     = "private-key"
	FlagPrivateKeyPath = "private-key-path"
	FlagPublicKey      = "public-key"
	FlagHost           = "host"
	FlagPort           = "port"
	FlagAuthMethod     = "auth-method"
	FlagPSKKey         = "psk-key"

	FlagIKEDiffieHellmanGroup  = "ike-diffie-hellman-group"
	FlagIKEEncryptionAlgorithm = "ike-encryption-algorithm"
	FlagIKEIntegrityAlgorithm  = "ike-integrity-algorithm"
	FlagIKELifetime            = "ike-lifetime"

	FlagESPDiffieHellmanGroup  = "esp-diffie-hellman-group"
	FlagESPIntegrityAlgorithm  = "esp-integrity-algorithm"
	FlagESPEncryptionAlgorithm = "esp-encryption-algorithm"
	FlagESPLifetime            = "esp-lifetime"

	FlagCloudNetworkCIDRs = "cloud-network-cidrs"
	FlagPeerNetworkCIDRs  = "peer-network-cidrs"

	FlagCores                 = "cores"
	FlagRam                   = "ram"
	FlagAvailabilityZone      = "availability-zone"
	FlagAvailabilityZoneShort = "z"
	FlagCpuFamily             = "cpu-family"
	FlagStorageType           = "storage-type"
	FlagStorageSize           = "storage-size"

	FlagClusterId        = "cluster-id"
	FlagNodepoolId       = "nodepool-id"
	FlagBackupId         = "backup-id"
	FlagNodeCount        = "node-count"
	FlagNodeSubnet       = "node-subnet"
	FlagLabels           = "labels"
	FlagLabelsShort      = "L"
	FlagAnnotations      = "annotations"
	FlagAnnotationsShort = "A"
	FlagVersion          = "version"
	FlagSize             = "size"

	FlagZone          = "zone"
	FlagZoneShort     = "z"
	FlagRecord        = "record"
	FlagRecordShort   = "r"
	FlagState         = "state"
	FlagDescription   = "description"
	FlagEnabled       = "enabled"
	FlagContent       = "content"
	FlagTtl           = "ttl"
	FlagPriority      = "priority"
	FlagType          = "type"
	FlagPrimaryIPs    = "primary-ips"
	FlagZoneFile      = "zone-file"
	FlagSecondaryZone = "secondary-zone"

	FlagCloudInit                       = "cloud-init"
	FlagLoggingPipelineId               = "pipeline-id"
	FlagLoggingPipelineLogTag           = "log-tag"
	FlagLoggingPipelineLogSource        = "log-source"
	FlagLoggingPipelineLogProtocol      = "log-protocol"
	FlagLoggingPipelineLogLabels        = "log-labels"
	FlagLoggingPipelineLogType          = "log-type"
	FlagLoggingPipelineLogRetentionTime = "log-retention-time"

	FlagCDNDistributionFilterDomain        = "domain"
	FlagCDNDistributionFilterState         = "state"
	FlagCDNDistributionID                  = "distribution-id"
	FlagCDNDistributionDomain              = "domain"
	FlagCDNDistributionCertificateID       = "certificate-id"
	FlagCDNDistributionRoutingRules        = "routing-rules"
	FlagCDNDistributionRoutingRulesExample = "routing-rules-example"

	FlagFilterName  = "name"
	FlagFilterState = "state"

	FlagKafkaBrokerAddresses   = "broker-addresses"
	FlagKafkaPartitions        = "partitions"
	FlagKafkaReplicationFactor = "replication-factor"
	FlagKafkaRetentionTime     = "retention-time"
	FlagKafkaSegmentBytes      = "segment-bytes"
	FlagKafkaTopicId           = "topic-id"

	FlagGroupId  = "group-id"
	FlagServerId = "server-id"
	FlagActionId = "action-id"

	FlagRegistryId       = "registry-id"
	FlagRegistryIdShort  = "r"
	FlagArtifactId       = "artifact-id"
	FlagVulnerabilityId  = "vulnerability-id"
	FlagRegistryVulnScan = "vulnerability-scanning"

	FlagDatabase = "database"
	FlagOwner    = "owner"
)

flags

const (
	DescMaxResults = "The maximum number of elements to return"
	DescZone       = "The name or ID of the DNS zone"
)

Flag descriptions. Prefixed with "Desc" for easy find and replace

const (
	ArgOutput       = "output"
	ArgOutputShort  = "o"
	ArgQuiet        = "quiet"
	ArgQuietShort   = "q"
	ArgVerbose      = "verbose"
	ArgVerboseShort = "v"
	ArgDepth        = "depth"
	ArgDepthShort   = "D"

	ArgAll                 = "all"
	ArgAllShort            = "a"
	ArgForce               = "force"
	ArgForceShort          = "f"
	ArgWaitForRequest      = "wait-for-request"
	ArgWaitForRequestShort = "w"
	ArgWaitForState        = "wait-for-state"
	ArgWaitForDelete       = "wait-for-deletion"
	ArgWaitForStateShort   = "W"
	ArgTimeout             = "timeout"
	ArgTimeoutShort        = "t"
	ArgCols                = "cols"
	ArgUpdates             = "updates"
	ArgUser                = "user"
	ArgPassword            = "password"
	ArgPasswordShort       = "p"
	ArgNoHeaders           = "no-headers"
)

legacy flags. TODO: Arg should be renamed to Flag.

const (
	DefaultConfigFileName = "/config.json"
	DefaultOutputFormat   = "text"
	DefaultWait           = false
	DefaultTimeoutSeconds = int(60)
	DefaultParentIndex    = int(1)
)

Defaults

const (
	DefaultApiURL         = "https://api.ionos.com"
	DNSApiRegionalURL     = "https://dns.%s.ionos.com"
	LoggingApiRegionalURL = "https://logging.%s.ionos.com"
	CDNApiRegionalURL     = "https://cdn.%s.ionos.com"
	MariaDBApiRegionalURL = "https://mariadb.%s.ionos.com"
	VPNApiRegionalURL     = "https://vpn.%s.ionos.com"
	KafkaApiRegionalURL   = "https://kafka.%s.ionos.com"
)

const (
	MessageRequestInfo = "Request ID: %v Execution Time: %v"
	MessageRequestTime = "Request Execution Time: %v"
	MessageDeletingAll = "Status: Deleting %v with ID: %v..."
	MessageRemovingAll = "Status: Removing %v with ID: %v..." // TODO: cleanup constant. reduce duplication
)

Some legacy messages, which might need looking into

const (
	ErrDeleteAll     = "error occurred removing %v with ID: %v. error: %w"
	ErrWaitDeleteAll = "error occurred waiting on removing %v with ID: %v. error: %w" // TODO: cleanup constant. reduce duplication
)

const (
	FlagJsonProperties        = "json-properties"
	FlagJsonPropertiesExample = "json-properties-example"

	ArgConfig         = "config"
	ArgConfigShort    = "c"
	ArgServerUrl      = "api-url"
	ArgServerUrlShort = "u"
	ArgToken          = "token"
	ArgTokenShort     = "t"

	EnvUsername  = "IONOS_USERNAME"
	EnvPassword  = "IONOS_PASSWORD"
	EnvToken     = "IONOS_TOKEN"
	EnvServerUrl = "IONOS_API_URL"

	CfgToken     = "userdata.token"
	CfgServerUrl = "userdata.api-url"
	CfgUsername  = "userdata.name"
	CfgPassword  = "userdata.password"

	CLIHttpUserAgent = "cli-user-agent"

	FlagProvenance      = "provenance"
	FlagProvenanceShort = "p"
	FlagSkipVerify      = "skip-verify"
)

Config

const (
	FlagTargetDir       = "target-dir"
	FlagSkipCompression = "skip-compression"
)

Manpages

const (
	DatacenterId              = "Datacenter ID: %v"
	ApplicationLoadBalancerId = "Application Load Balancer ID: %v"
	TargetGroupId             = "Target Group ID: %v"
	ClusterId                 = "Cluster ID: %v"
	ForwardingRuleId          = "Forwarding Rule ID: %v"
)

Resource info

Variables

var (
	DNSLocations     = []string{"de/fra"}
	LoggingLocations = []string{"de/txl", "de/fra", "gb/lhr", "fr/par", "es/vit"}
	CDNLocations     = []string{"de/fra"}
	MariaDBLocations = []string{"de/txl", "de/fra", "es/vit", "fr/par", "gb/lhr", "us/ewr", "us/las", "us/mci"}
	VPNLocations     = []string{"de/fra", "de/txl", "es/vit", "fr/par", "gb/lhr", "gb/bhx", "us/ewr", "us/las", "us/mci"}
	KafkaLocations   = []string{
		"de/fra", "de/txl",
	}
)

var (
	EnumLicenceType      = []string{"LINUX", "RHEL", "WINDOWS", "WINDOWS2016", "UNKNOWN", "OTHER"}
	EnumLogProtocols     = []string{"http", "tcp"}
	EnumLogSources       = []string{"docker", "systemd", "generic", "kubernetes"}
	EnumLogRetentionTime = []string{"7", "14", "30"}
)

enum values. TODO: ideally i'd like these handled by the SDK