config

Documentation

Index

• Constants
• func Delete() error
• func Exists(name string) bool
• func GetConfigDescription() map[string]string
• func GetString(name string) string
• func IsAccessSet() bool
• func List() []string
• func Load() error
• func Name() string
• func OpsManagerCACertificate() string
• func OpsManagerSkipVerify() string
• func OpsManagerURL() string
• func OrgID() string
• func PrivateAPIKey() string
• func ProjectID() string
• func Properties() []string
• func PublicAPIKey() string
• func Rename(newProfileName string) error
• func Save() error
• func Service() string
• func Set(name, value string)
• func SetName(name *string)
• func SetOpsManagerURL(v string)
• func SetOrgID(v string)
• func SetPrivateAPIKey(v string)
• func SetProjectID(v string)
• func SetPublicAPIKey(v string)
• func SetService(v string)
• type Config
  • func Default() Config
• type Getter
• type Saver
• type SetSaver
• type Setter

Constants

const (
	ToolName            = "mongocli"      // ToolName of the CLI
	EnvPrefix           = "mcli"          // Prefix for ENV variables
	DefaultProfile      = "default"       // DefaultProfile default
	CloudService        = "cloud"         // CloudService setting when using Atlas API
	CloudManagerService = "cloud-manager" // CloudManagerService settings when using CLoud Manager API
	OpsManagerService   = "ops-manager"   // OpsManagerService settings when using Ops Manager API

)

Functions

func Delete

func Delete() error

Delete deletes an existing configuration. The profiles are reloaded afterwards, as this edits the file directly.

func Exists

func Exists(name string) bool

Exists returns true if there are any set settings for the profile name.

func GetConfigDescription

func GetConfigDescription() map[string]string

GetConfigDescription returns a map describing the configuration

func GetString

func GetString(name string) string

func IsAccessSet

func IsAccessSet() bool

IsAccessSet return true if API keys have been set up. For Ops Manager we also check for the base URL.

func List

func List() []string

List returns the names of available profiles

func Load

func Load() error

Load loads the configuration from disk

func Name

func Name() string

func OpsManagerCACertificate

func OpsManagerCACertificate() string

OpsManagerCACertificate get configured ops manager CA certificate location

func OpsManagerSkipVerify

func OpsManagerSkipVerify() string

SkipVerify get configured ops manager CA certificate location

func OpsManagerURL

func OpsManagerURL() string

OpsManagerURL get configured ops manager base url

func OrgID

func OrgID() string

OrgID get configured organization ID

func PrivateAPIKey

func PrivateAPIKey() string

PrivateAPIKey get configured private api key

func ProjectID

func ProjectID() string

ProjectID get configured project ID

func Properties

func Properties() []string

func PublicAPIKey

func PublicAPIKey() string

PublicAPIKey get configured public api key

func Rename

func Rename(newProfileName string) error

Rename replaces the profile to a new profile name, overwriting any profile that existed before.

func Save

func Save() error

Save the configuration to disk

func Service

func Service() string

Service get configured service

func Set

func Set(name, value string)

func SetName

func SetName(name *string)

func SetOpsManagerURL

func SetOpsManagerURL(v string)

SetOpsManagerURL set configured ops manager base url

func SetOrgID

func SetOrgID(v string)

SetOrgID sets the global organization ID

func SetPrivateAPIKey

func SetPrivateAPIKey(v string)

SetPrivateAPIKey set configured private api key

func SetProjectID

func SetProjectID(v string)

SetProjectID sets the global project ID

func SetPublicAPIKey

func SetPublicAPIKey(v string)

SetPublicAPIKey set configured publicAPIKey

func SetService

func SetService(v string)

SetService set configured service

Types

type Config

type Config interface {
	Setter
	Getter
	Saver
	Service() string
	PublicAPIKey() string
	PrivateAPIKey() string
	OpsManagerURL() string
	OpsManagerCACertificate() string
	OpsManagerSkipVerify() string
}

func Default

func Default() Config

type Getter

type Getter interface {
	GetString(string) string
}

type Saver

type Saver interface {
	Save() error
}

type SetSaver

type SetSaver interface {
	Setter
	Saver
}

type Setter

type Setter interface {
	Set(string, string)
}