sdk

Documentation

Overview

Package sdk provide an abstraction for communication with API.

Index

• Constants
• Variables
• func GetDefaultConfigPath() (string, error)
• type Client
  • func DefaultClient() (*Client, error)
  • func NewClient(config *Config) (*Client, error)
  • func (c *Client) ApplyObjects(ctx context.Context, objects []manifest.Object, dryRun bool) error
  • func (c *Client) CreateRequest(ctx context.Context, method, endpoint, project string, q url.Values, ...) (*http.Request, error)
  • func (c *Client) DeleteObjects(ctx context.Context, objects []manifest.Object, dryRun bool) error
  • func (c *Client) DeleteObjectsByName(ctx context.Context, project string, kind manifest.Kind, dryRun bool, ...) error
  • func (c *Client) GetAWSExternalID(ctx context.Context, project string) (string, error)
  • func (c *Client) GetAgentCredentials(ctx context.Context, project, agentsName string) (creds M2MAppCredentials, err error)
  • func (c *Client) GetObjects(ctx context.Context, project string, kind manifest.Kind, ...) ([]manifest.Object, error)
  • func (c *Client) GetObjectsWithParams(ctx context.Context, project string, kind manifest.Kind, q url.Values) (response Response, err error)
  • func (c *Client) GetOrganization(ctx context.Context) (string, error)
  • func (c *Client) SetUserAgent(userAgent string)
• type Config
  • func ReadConfig(options ...ConfigOption) (*Config, error)
  • func (c *Config) GetCurrentContext() string
  • func (c *Config) GetFileConfig() FileConfig
  • func (c *Config) Verify() error
• type ConfigOption
  • func ConfigOptionEnvPrefix(prefix string) ConfigOption
  • func ConfigOptionFilePath(path string) ConfigOption
  • func ConfigOptionNoConfigFile() ConfigOption
  • func ConfigOptionUseContext(context string) ConfigOption
  • func ConfigOptionWithCredentials(clientID, clientSecret string) ConfigOption
• type ContextConfig
• type ContextlessConfig
• type FileConfig
  • func (f *FileConfig) GetPath() string
  • func (f *FileConfig) Load(path string) error
  • func (f *FileConfig) Save(path string) (err error)
• type M2MAppCredentials
• type Response

Constants

const (
	HeaderOrganization      = "Organization"
	HeaderProject           = "Project"
	HeaderAuthorization     = "Authorization"
	HeaderUserAgent         = "User-Agent"
	HeaderTruncatedLimitMax = "Truncated-Limit-Max"
	HeaderTraceID           = "Trace-Id"
)

HTTP headers keys used across app

const (
	QueryKeyName              = "name"
	QueryKeyTime              = "t"
	QueryKeyFrom              = "from"
	QueryKeyTo                = "to"
	QueryKeySeries            = "series"
	QueryKeySteps             = "steps"
	QueryKeySlo               = "slo"
	QueryKeyTimeWindow        = "window"
	QueryKeyPercentiles       = "q"
	QueryKeyPermissionFilter  = "pf"
	QueryKeyLabelsFilter      = "labels"
	QueryKeyServiceName       = "service_name"
	QueryKeyDryRun            = "dry_run"
	QueryKeyTextSearch        = "text_search"
	QueryKeySystemAnnotations = "system_annotations"
	QueryKeyUserAnnotations   = "user_annotations"
	QueryKeyAlertPolicy       = "alert_policy"
	QueryKeyObjective         = "objective"
	QueryKeyObjectiveValue    = "objective_value"
	QueryKeyResolved          = "resolved"
	QueryKeyTriggered         = "triggered"
)

HTTP GET query keys used across app

const DefaultProject = "default"

DefaultProject is a value of the default project.

const (
	EnvPrefix = "NOBL9_SDK_"
)

const ProjectsWildcard = "*"

ProjectsWildcard is used in HeaderProject when requesting for all projects.

Variables

var ErrConcurrencyIssue = errors.New("operation failed due to concurrency issue but can be retried")

Functions

func GetDefaultConfigPath

func GetDefaultConfigPath() (string, error)

GetDefaultConfigPath returns the default path to Nobl9 configuration file, config.toml.

Types

type Client

type Client struct {
	Config *Config
	HTTP   *http.Client
	// contains filtered or unexported fields
}

Client represents API high level client.

func DefaultClient

func DefaultClient() (*Client, error)

DefaultClient returns fully configured instance of Client with default Config and HTTP client.

func NewClient

func NewClient(config *Config) (*Client, error)

NewClient creates a new Client instance with provided Config.

func (*Client) ApplyObjects

func (c *Client) ApplyObjects(ctx context.Context, objects []manifest.Object, dryRun bool) error

ApplyObjects applies (create or update) list of objects passed as argument via API.

func (*Client) CreateRequest

func (c *Client) CreateRequest(
	ctx context.Context,
	method, endpoint, project string,
	q url.Values,
	body io.Reader,
) (*http.Request, error)

CreateRequest creates a new http.Request pointing at the Nobl9 API URL. It also adds all the mandatory headers to the request and encodes query parameters.

func (*Client) DeleteObjects

func (c *Client) DeleteObjects(ctx context.Context, objects []manifest.Object, dryRun bool) error

DeleteObjects deletes list of objects passed as argument via API.

func (*Client) DeleteObjectsByName

func (c *Client) DeleteObjectsByName(
	ctx context.Context,
	project string,
	kind manifest.Kind,
	dryRun bool,
	names ...string,
) error

DeleteObjectsByName makes a call to endpoint for deleting objects with passed names and object types.

func (*Client) GetAWSExternalID

func (c *Client) GetAWSExternalID(ctx context.Context, project string) (string, error)

func (*Client) GetAgentCredentials

func (c *Client) GetAgentCredentials(
	ctx context.Context,
	project, agentsName string,
) (creds M2MAppCredentials, err error)

GetAgentCredentials retrieves manifest.KindAgent credentials.

func (*Client) GetObjects

func (c *Client) GetObjects(
	ctx context.Context,
	project string,
	kind manifest.Kind,
	filterLabel map[string][]string,
	names ...string,
) ([]manifest.Object, error)

GetObjects returns array of supported type of Objects, when names are passed - query for these names otherwise returns list of all available objects.

func (*Client) GetObjectsWithParams

func (c *Client) GetObjectsWithParams(
	ctx context.Context,
	project string,
	kind manifest.Kind,
	q url.Values,
) (response Response, err error)

func (*Client) GetOrganization

func (c *Client) GetOrganization(ctx context.Context) (string, error)

GetOrganization returns the organization read from JWT token claims.

func (*Client) SetUserAgent

func (c *Client) SetUserAgent(userAgent string)

SetUserAgent will set HeaderUserAgent to the provided value.

type Config

type Config struct {
	ClientID             string
	ClientSecret         string
	AccessToken          string
	Project              string
	URL                  *url.URL
	OktaOrgURL           *url.URL
	OktaAuthServer       string
	DisableOkta          bool
	Timeout              time.Duration
	FilesPromptEnabled   bool
	FilesPromptThreshold int
	// contains filtered or unexported fields
}

Config combines the ContextlessConfig and ContextConfig of the current, selected context.

func ReadConfig

func ReadConfig(options ...ConfigOption) (*Config, error)

ReadConfig reads the configuration from either (with precedence from top to bottom): - provided ConfigOption - environment variables - config file - default values where applicable

Detailed flow can be found in config_activity.png (generated from config_activity.puml).

func (*Config) GetCurrentContext

func (c *Config) GetCurrentContext() string

func (*Config) GetFileConfig

func (c *Config) GetFileConfig() FileConfig

GetFileConfig returns a copy of FileConfig.

func (*Config) Verify

func (c *Config) Verify() error

Verify checks if Config fulfills the minimum requirements.

type ConfigOption

type ConfigOption func(conf *Config)

ConfigOption conveys extra configuration details for ReadConfig function.

func ConfigOptionEnvPrefix

func ConfigOptionEnvPrefix(prefix string) ConfigOption

ConfigOptionEnvPrefix instructs Config to lookup environment variables with the provided prefix. Example:

ConfigOptionEnvPrefix("SLOCTL_") --> looks up SLOCTL_CLIENT_ID env and assigns it to Config.ClientID

func ConfigOptionFilePath

func ConfigOptionFilePath(path string) ConfigOption

ConfigOptionFilePath instructs Config to load config file from the provided path. It has no effect if ConfigOptionNoConfigFile is provided.

func ConfigOptionNoConfigFile

func ConfigOptionNoConfigFile() ConfigOption

ConfigOptionNoConfigFile instructs Config to not try reading config.toml file at all.

func ConfigOptionUseContext

func ConfigOptionUseContext(context string) ConfigOption

ConfigOptionUseContext instructs Config to use the provided context name. It has no effect if ConfigOptionNoConfigFile is provided.

func ConfigOptionWithCredentials

func ConfigOptionWithCredentials(clientID, clientSecret string) ConfigOption

ConfigOptionWithCredentials creates a minimal configuration using provided client id and secret.

type ContextConfig

type ContextConfig struct {
	ClientID       string         `toml:"clientId" env:"CLIENT_ID"`
	ClientSecret   string         `toml:"clientSecret" env:"CLIENT_SECRET"`
	AccessToken    string         `toml:"accessToken,omitempty" env:"ACCESS_TOKEN"`
	Project        string         `toml:"project,omitempty" env:"PROJECT"`
	URL            string         `toml:"url,omitempty" env:"URL"`
	OktaOrgURL     string         `toml:"oktaOrgURL,omitempty" env:"OKTA_ORG_URL"`
	OktaAuthServer string         `toml:"oktaAuthServer,omitempty" env:"OKTA_AUTH_SERVER"`
	DisableOkta    *bool          `toml:"disableOkta,omitempty" env:"DISABLE_OKTA"`
	Timeout        *time.Duration `toml:"timeout,omitempty" env:"TIMEOUT"`
}

ContextConfig stores context specific config.

type ContextlessConfig

type ContextlessConfig struct {
	DefaultContext string `toml:"defaultContext" env:"DEFAULT_CONTEXT"`
	// Sloctl exclusive.
	FilesPromptEnabled   *bool `toml:"filesPromptEnabled" env:"FILES_PROMPT_ENABLED"`
	FilesPromptThreshold *int  `toml:"filesPromptThreshold" env:"FILES_PROMPT_THRESHOLD"`
}

ContextlessConfig stores config not tied to any specific context.

type FileConfig

type FileConfig struct {
	ContextlessConfig `toml:",inline"`
	Contexts          map[string]ContextConfig `toml:"contexts"`
	// contains filtered or unexported fields
}

FileConfig contains fully parsed config file.

func (*FileConfig) GetPath

func (f *FileConfig) GetPath() string

GetPath retrieves the file path FileConfig was loaded from.

func (*FileConfig) Load

func (f *FileConfig) Load(path string) error

Load reads the config file from the provided path. If the file does not exist, it will create a default configuration file.

func (*FileConfig) Save

func (f *FileConfig) Save(path string) (err error)

Save saves FileConfig into provided path, encoding it in TOML format.

type M2MAppCredentials

type M2MAppCredentials struct {
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
}

M2MAppCredentials is used for storing client_id and client_secret.

type Response

type Response struct {
	Objects      []manifest.Object
	TruncatedMax int
}