client

Documentation

Index

• Constants
• Variables
• func NewConfig(ctx context.Context, kube client.Client, mg resource.Managed) (*up.Config, error)
• type CLIConfig
• type Profile
• type ProfileType
• type Upbound

Constants

const (
	// UserAgent is the default user agent to use to make requests to the
	// Upbound API.
	UserAgent = "provider-upbound"
	// CookieName is the default cookie name used to identify a session token.
	CookieName = "SID"
)

Variables

var (
	DefaultAPIEndpoint, _ = url.Parse("https://api.upbound.io")
)

Functions

func NewConfig

func NewConfig(ctx context.Context, kube client.Client, mg resource.Managed) (*up.Config, error)

Types

type CLIConfig

type CLIConfig struct {
	Upbound Upbound `json:"upbound"`
}

CLIConfig is format for the up configuration file.

type Profile

type Profile struct {
	// ID is either a username, email, or token.
	ID string `json:"id"`

	// Type is the type of the profile.
	Type ProfileType `json:"type"`

	// Session is a session token used to authenticate to Upbound.
	Session string `json:"session,omitempty"`

	// Account is the default account to use when this profile is selected.
	Account string `json:"account,omitempty"`

	// BaseConfig represent persisted settings for this profile.
	// For example:
	// * flags
	// * environment variables
	BaseConfig map[string]string `json:"base,omitempty"`
}

A Profile is a set of credentials

type ProfileType

type ProfileType string

ProfileType is a type of Upbound profile.

const (
	UserProfileType  ProfileType = "user"
	TokenProfileType ProfileType = "token"
)

Types of profiles.

type Upbound

type Upbound struct {
	// Default indicates the default profile.
	Default string `json:"default"`

	// Profiles contain sets of credentials for communicating with Upbound. Key
	// is name of the profile.
	Profiles map[string]Profile `json:"profiles,omitempty"`
}

Upbound contains configuration information for Upbound.