store

Documentation

Overview

Package store provides a generic way to store credentials to connect to virtually any kind of remote system. The term `context` comes from the similar feature in Kubernetes kubectl config files.

Conceptually, a context is a set of metadata and TLS data, that can be used to connect to various endpoints of a remote system. TLS data and metadata are stored separately, so that in the future, we will be able to store sensitive information in a more secure way, depending on the os we are running on (e.g.: on Windows we could use the user Certificate Store, on Mac OS the user Keychain...).

Current implementation is purely file based with the following structure: ${CONTEXT_ROOT}

• meta/
• <context id>/meta.json: contains context medata (key/value pairs) as well as a list of endpoints (themselves containing key/value pair metadata)
• tls/
• <context id>/endpoint1/: directory containing TLS data for the endpoint1 in the corresponding context

The context store itself has absolutely no knowledge about what a docker or a kubernetes endpoint should contain in term of metadata or TLS config. Client code is responsible for generating and parsing endpoint metadata and TLS files. The multi-endpoints approach of this package allows to combine many different endpoints in the same "context" (e.g., the Docker CLI is able for a single context to define both a docker endpoint and a Kubernetes endpoint for the same cluster, and also specify which orchestrator to use by default when deploying a compose stack on this cluster).

Context IDs are actually SHA256 hashes of the context name, and are there only to avoid dealing with special characters in context names.

Index

• func Export(name string, s Store) io.ReadCloser
• func Import(name string, s Store, reader io.Reader) error
• func IsErrContextDoesNotExist(err error) bool
• func IsErrTLSDataDoesNotExist(err error) bool
• type Config
  • func NewConfig(contextType TypeGetter, endpoints ...NamedTypeGetter) Config
  • func (c Config) SetEndpoint(name string, getter TypeGetter)
• type ContextMetadata
• type ContextStorageInfo
• type ContextTLSData
• type EndpointFiles
• type EndpointTLSData
• type NamedTypeGetter
  • func EndpointTypeGetter(name string, getter TypeGetter) NamedTypeGetter
• type Store
  • func New(dir string, cfg Config) Store
• type TypeGetter

Functions

func Export

func Export(name string, s Store) io.ReadCloser

Export exports an existing namespace into an opaque data stream This stream is actually a tarball containing context metadata and TLS materials, but it does not map 1:1 the layout of the context store (don't try to restore it manually without calling store.Import)

func Import

func Import(name string, s Store, reader io.Reader) error

Import imports an exported context into a store

func IsErrContextDoesNotExist

func IsErrContextDoesNotExist(err error) bool

IsErrContextDoesNotExist checks if the given error is a "context does not exist" condition

func IsErrTLSDataDoesNotExist

func IsErrTLSDataDoesNotExist(err error) bool

IsErrTLSDataDoesNotExist checks if the given error is a "context does not exist" condition

Types

type Config

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

Config is used to configure the metadata marshaler of the context store

func NewConfig

func NewConfig(contextType TypeGetter, endpoints ...NamedTypeGetter) Config

NewConfig creates a config object

func (Config) SetEndpoint

func (c Config) SetEndpoint(name string, getter TypeGetter)

SetEndpoint set an endpoint typing information

type ContextMetadata

type ContextMetadata struct {
	Name      string                 `json:",omitempty"`
	Metadata  interface{}            `json:",omitempty"`
	Endpoints map[string]interface{} `json:",omitempty"`
}

ContextMetadata contains metadata about a context and its endpoints

type ContextStorageInfo

type ContextStorageInfo struct {
	MetadataPath string
	TLSPath      string
}

ContextStorageInfo contains data about where a given context is stored

type ContextTLSData

type ContextTLSData struct {
	Endpoints map[string]EndpointTLSData
}

ContextTLSData represents tls data for a whole context

type EndpointFiles

type EndpointFiles []string

EndpointFiles is a slice of strings representing file names

type EndpointTLSData

type EndpointTLSData struct {
	Files map[string][]byte
}

EndpointTLSData represents tls data for a given endpoint

type NamedTypeGetter

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

NamedTypeGetter is a TypeGetter associated with a name

func EndpointTypeGetter

func EndpointTypeGetter(name string, getter TypeGetter) NamedTypeGetter

EndpointTypeGetter returns a NamedTypeGetter with the spcecified name and getter

type Store

type Store interface {
	ListContexts() ([]ContextMetadata, error)
	CreateOrUpdateContext(meta ContextMetadata) error
	RemoveContext(name string) error
	GetContextMetadata(name string) (ContextMetadata, error)
	ResetContextTLSMaterial(name string, data *ContextTLSData) error
	ResetContextEndpointTLSMaterial(contextName string, endpointName string, data *EndpointTLSData) error
	ListContextTLSFiles(name string) (map[string]EndpointFiles, error)
	GetContextTLSData(contextName, endpointName, fileName string) ([]byte, error)
	GetContextStorageInfo(contextName string) ContextStorageInfo
}

Store provides a context store for easily remembering endpoints configuration

func New

func New(dir string, cfg Config) Store

New creates a store from a given directory. If the directory does not exist or is empty, initialize it

type TypeGetter

type TypeGetter func() interface{}

TypeGetter is a func used to determine the concrete type of a context or endpoint metadata by returning a pointer to an instance of the object eg: for a context of type DockerContext, the corresponding TypeGetter should return new(DockerContext)