client

Documentation

Index

• Constants
• Variables
• func SaveConfig(config *Config, path string) error
• type Client
  • func NewClient(host string, serverCAs ...string) Client
• type Config
  • func LoadConfig(path string) (*Config, error)
  • func NewConfig() *Config
  • func (c *Config) GroupOrDefault(group string) string
  • func (c *Config) TargetsByGroup() map[string]map[string]*Osprey
  • func (c *Config) TargetsInGroup(group string) map[string]*Osprey
• type ConfigSnapshot
  • func GetSnapshot(config *Config) ConfigSnapshot
  • func (t *ConfigSnapshot) DefaultGroup() Group
  • func (t *ConfigSnapshot) GetGroup(name string) (Group, bool)
  • func (t *ConfigSnapshot) Groups() []Group
  • func (t *ConfigSnapshot) HaveGroups() bool
  • func (t *ConfigSnapshot) Targets() []Target
• type Group
  • func (g *Group) Contains(target Target) bool
  • func (g *Group) IsDefault() bool
  • func (g *Group) Name() string
  • func (g *Group) Targets() []Target
• type LoginCredentials
  • func GetCredentials() (*LoginCredentials, error)
• type Osprey
  • func (o *Osprey) IsInGroup(value string) bool
• type Target
  • func (m *Target) Aliases() []string
  • func (m *Target) CertificateAuthorityData() string
  • func (m *Target) HasAliases() bool
  • func (m *Target) Name() string
  • func (m *Target) Server() string

Constants

const (
	// RecommendedHomeDir is the default name for the osprey home directory.
	RecommendedHomeDir = ".osprey"
	// RecommendedFileName is the default name for the osprey config file.
	RecommendedFileName = "config"
)

Variables

var (
	// HomeDir is the user's home directory.
	HomeDir = homeDir()
	// RecommendedOspreyHomeDir is the default full path for the osprey home.
	RecommendedOspreyHomeDir = path.Join(HomeDir, RecommendedHomeDir)
	// RecommendedOspreyConfigFile is the default full path for the osprey config file.
	RecommendedOspreyConfigFile = path.Join(RecommendedOspreyHomeDir, RecommendedFileName)
)

Functions

func SaveConfig

func SaveConfig(config *Config, path string) error

SaveConfig serializes the osprey config to the specified path.

Types

type Client

type Client interface {
	// GetAccessToken returns an access token that is required to authenticate user access against a kubernetes cluster
	GetAccessToken(*LoginCredentials) (*kubeconfig.TokenInfo, error)
}

Client is used to authenticate and generate the configuration

func NewClient

func NewClient(host string, serverCAs ...string) Client

NewClient creates a new Client

type Config

type Config struct {
	// CertificateAuthority is the path to a cert file for the certificate authority.
	// +optional
	CertificateAuthority string `yaml:"certificate-authority,omitempty"`
	// CertificateAuthorityData is base64-encoded CA cert data.
	// This will override any cert file specified in CertificateAuthority.
	// +optional
	CertificateAuthorityData string `yaml:"certificate-authority-data,omitempty"`
	// Kubeconfig specifies the path to read/write the kubeconfig file.
	// +optional
	Kubeconfig string `yaml:"kubeconfig,omitempty"`
	// DefaultGroup specifies the group to log in to if none provided.
	// +optional
	DefaultGroup string `yaml:"default-group,omitempty"`
	// Targets is a map of referenceable names to osprey configs
	Targets map[string]*Osprey `yaml:"targets"`
}

Config holds the information needed to connect to remote osprey servers as a given user

func LoadConfig

func LoadConfig(path string) (*Config, error)

LoadConfig reads an osprey Config from the specified path.

func NewConfig

func NewConfig() *Config

NewConfig is a convenience function that returns a new Config object with non-nil maps

func (*Config) GroupOrDefault

func (c *Config) GroupOrDefault(group string) string

GroupOrDefault returns the group if it is not empty, or the Config.DefaultGroup if it is.

func (*Config) TargetsByGroup

func (c *Config) TargetsByGroup() map[string]map[string]*Osprey

TargetsByGroup returns the Config targets organized by groups. One target may appear in multiple groups.

func (*Config) TargetsInGroup

func (c *Config) TargetsInGroup(group string) map[string]*Osprey

TargetsInGroup retrieves the Osprey targets that match the group. If the group is not provided the DefaultGroup for this configuration will be used.

type ConfigSnapshot

type ConfigSnapshot struct {
	// contains filtered or unexported fields
}

ConfigSnapshot is a snapshot view of the configuration to organize the targets per group. It does not reflect changes to the configuration after it has been taken.

func GetSnapshot

func GetSnapshot(config *Config) ConfigSnapshot

GetSnapshot creates a snapshot view of the provided Config

func (*ConfigSnapshot) DefaultGroup

func (t *ConfigSnapshot) DefaultGroup() Group

DefaultGroup returns the default group in the configuration. If no specific group is set as default, it will return the special ungrouped ("") group

func (*ConfigSnapshot) GetGroup

func (t *ConfigSnapshot) GetGroup(name string) (Group, bool)

GetGroup returns a valid group and true if it exists, an empty group and false if it doesn't.

func (*ConfigSnapshot) Groups

func (t *ConfigSnapshot) Groups() []Group

Groups returns all defined groups sorted alphabetically by name.

func (*ConfigSnapshot) HaveGroups

func (t *ConfigSnapshot) HaveGroups() bool

HaveGroups returns true if there is at least one defined group.

func (*ConfigSnapshot) Targets

func (t *ConfigSnapshot) Targets() []Target

Targets returns all the targets in the configuration in alphabetical order.

type Group

type Group struct {
	// contains filtered or unexported fields
}

Group organizes the osprey targets

func (*Group) Contains

func (g *Group) Contains(target Target) bool

Contains returns true if it contains the target

func (*Group) IsDefault

func (g *Group) IsDefault() bool

IsDefault returns true if this is the default group in the configuration

func (*Group) Name

func (g *Group) Name() string

Name returns the name of the group

func (*Group) Targets

func (g *Group) Targets() []Target

Targets returns the list of targets belonging to this group

type LoginCredentials

type LoginCredentials struct {
	// Username username of user intending to login
	Username string
	// Password the password for user
	Password string
}

LoginCredentials represents user credentials

func GetCredentials

func GetCredentials() (*LoginCredentials, error)

GetCredentials loads the credentials from the terminal or stdin.

type Osprey

type Osprey struct {
	// Server is the address of the osprey server (hostname:port).
	Server string `yaml:"server"`
	// CertificateAuthority is the path to a cert file for the certificate authority.
	// +optional
	CertificateAuthority string `yaml:"certificate-authority,omitempty"`
	// CertificateAuthorityData is base64-encoded CA cert data.
	// This will override any cert file specified in CertificateAuthority.
	// +optional
	CertificateAuthorityData string `yaml:"certificate-authority-data,omitempty"`
	// Aliases is a list of names that the osprey server can be called.
	// +optional
	Aliases []string `yaml:"aliases,omitempty"`
	// Groups is a list of names that can be used to group different osprey servers.
	// +optional
	Groups []string `yaml:"groups,omitempty"`
}

Osprey contains information about how to communicate with an osprey server

func (*Osprey) IsInGroup

func (o *Osprey) IsInGroup(value string) bool

IsInGroup returns true if the Osprey target belongs to the given group

type Target

type Target struct {
	// contains filtered or unexported fields
}

Target has the information of an Osprey target server

func (*Target) Aliases

func (m *Target) Aliases() []string

Aliases returns the list of aliases of the Target alphabetically sorted

func (*Target) CertificateAuthorityData

func (m *Target) CertificateAuthorityData() string

CertificateAuthorityData returns the CertificateAuthorityData of the Target

func (*Target) HasAliases

func (m *Target) HasAliases() bool

HasAliases returns true if the Target has at least one alias

func (*Target) Name

func (m *Target) Name() string

Name returns the main name of the Target

func (*Target) Server

func (m *Target) Server() string

Server returns the server of the Target