subnet

Documentation

Index

• Variables
• type Config
  • func LookupConfig(kvs config.KVS, transport http.RoundTripper) (cfg Config, err error)
  • func (c Config) Post(reqURL string, payload interface{}) (string, error)

Variables

var DefaultKVS = config.KVS{
	config.KV{
		Key:   config.License,
		Value: "",
	},
	config.KV{
		Key:   config.APIKey,
		Value: "",
	},
	config.KV{
		Key:   config.Proxy,
		Value: "",
	},
}

DefaultKVS - default KV config for subnet settings

var (

	// 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" + defaultHelpPostfix(config.License),
			Optional:    true,
		},
		config.HelpKV{
			Key:         config.APIKey,
			Type:        "string",
			Description: "Subnet api key for the cluster" + defaultHelpPostfix(config.APIKey),
			Optional:    true,
		},
		config.HelpKV{
			Key:         config.Proxy,
			Type:        "string",
			Description: "HTTP(S) proxy URL to use for connecting to SUBNET" + defaultHelpPostfix(config.Proxy),
			Optional:    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
	ProxyURL *xnet.URL `json:"proxy_url"`
	// contains filtered or unexported fields
}

Config represents the subnet related configuration

func LookupConfig

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

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

func (Config) Post

func (c Config) Post(reqURL string, payload interface{}) (string, error)

Post submit 'payload' to specified URL