subnet

Documentation

Index

• Variables
• type Config
  • func LookupConfig(kvs config.KVS) (cfg Config, err error)

Variables

var (
	// DefaultKVS - default KV config for subnet settings
	DefaultKVS = config.KVS{
		config.KV{
			Key:   config.License,
			Value: "",
		},
		config.KV{
			Key:   config.APIKey,
			Value: "",
		},
		config.KV{
			Key:   config.Proxy,
			Value: "",
		},
	}

	// HelpSubnet - provides help for subnet api key config
	HelpSubnet = config.HelpKVS{
		config.HelpKV{
			Key:         config.License,
			Type:        "string",
			Description: "[DEPRECATED use api_key] Subnet license token for the cluster",
			Optional:    true,
			Sensitive:   true,
		},
		config.HelpKV{
			Key:         config.APIKey,
			Type:        "string",
			Description: "Subnet api key for the cluster",
			Optional:    true,
			Sensitive:   true,
		},
		config.HelpKV{
			Key:         config.Proxy,
			Type:        "string",
			Description: "HTTP(S) proxy URL to use for connecting to SUBNET",
			Optional:    true,
			Sensitive:   true,
		},
	}
)

Types

type Config

type Config struct {
	// The subnet license token - Deprecated Dec 2021
	License string `json:"license"`

	// The subnet api key
	APIKey string `json:"api_key"`

	// The HTTP(S) proxy URL to use for connecting to SUBNET
	Proxy string `json:"proxy"`
}

Config represents the subnet related configuration

func LookupConfig

func LookupConfig(kvs config.KVS) (cfg Config, err error)

LookupConfig - lookup config and override with valid environment settings if any.