api

Documentation

Index

• Constants
• func GetToken(ctx context.Context, issuerURL, clientID string, usePKCE bool, out io.Writer) error
• func GetTokenFromConfig(ctx context.Context, cfg *rest.Config) (string, error)
• func GetTokenFromExecConfig(ctx context.Context, execConfig *api.ExecConfig) (string, error)
• func LoadingRules() (*clientcmd.ClientConfigLoadingRules, error)
• func NamespacedName(name, project string) types.NamespacedName
• func NewScheme() (*runtime.Scheme, error)
• func ObjectName(obj runtimeclient.Object) types.NamespacedName
• type Client
  • func New(ctx context.Context, apiClusterContext, project string, opts ...ClientOpt) (*Client, error)
  • func (c *Client) GetConnectionSecret(ctx context.Context, mg resource.Managed) (*corev1.Secret, error)
  • func (c *Client) Name(name string) types.NamespacedName
• type ClientOpt
  • func LogClient(address string, insecure bool) ClientOpt
• type DefaultTokenGetter
  • func (t *DefaultTokenGetter) GetTokenString(ctx context.Context, issuerURL, clientID string, usePKCE bool) (string, error)
• type TokenGetter
• type UserInfo
  • func GetUserInfoFromToken(tokenString string) (*UserInfo, error)

Constants

const (
	DefaultTokenCachePath = ".kube/cache/oidc-login"
	IssuerURLArg          = "--issuer-url="
	ClientIDArg           = "--client-id="
	UsePKCEArg            = "--use-pkce"
	CustomersPrefix       = "/Customers/"
)

Functions

func GetToken

func GetToken(ctx context.Context, issuerURL, clientID string, usePKCE bool, out io.Writer) error

GetToken executes the OIDC login flow using the kubelogin with the provided OIDC parameters writes the raw JSON ExecCredential result to out.

func GetTokenFromConfig

func GetTokenFromConfig(ctx context.Context, cfg *rest.Config) (string, error)

GetTokenFromConfig takes a rest.Config and returns a valid OIDC access token or the static bearer token if it's set in the config.

func GetTokenFromExecConfig

func GetTokenFromExecConfig(ctx context.Context, execConfig *api.ExecConfig) (string, error)

GetTokenFromExecConfig takes the provided execConfig, parses out the args and gets the token by executing the login flow.

func LoadingRules

func LoadingRules() (*clientcmd.ClientConfigLoadingRules, error)

func NamespacedName

func NamespacedName(name, project string) types.NamespacedName

func NewScheme

func NewScheme() (*runtime.Scheme, error)

NewScheme returns a *runtime.Scheme with all the relevant types registered.

func ObjectName

func ObjectName(obj runtimeclient.Object) types.NamespacedName

Types

type Client

type Client struct {
	runtimeclient.WithWatch
	Config            *rest.Config
	KubeconfigPath    string
	Project           string
	Log               *log.Client
	Token             string
	KubeconfigContext string
}

func New

func New(ctx context.Context, apiClusterContext, project string, opts ...ClientOpt) (*Client, error)

New returns a new Client by loading a kubeconfig with the supplied context and project. The kubeconfig is discovered like this: * KUBECONFIG environment variable pointing at a file * $HOME/.kube/config if exists

func (*Client) GetConnectionSecret

func (c *Client) GetConnectionSecret(ctx context.Context, mg resource.Managed) (*corev1.Secret, error)

func (*Client) Name

func (c *Client) Name(name string) types.NamespacedName

type ClientOpt

type ClientOpt func(c *Client) error

func LogClient

func LogClient(address string, insecure bool) ClientOpt

LogClient sets up a log client connected to the provided address.

type DefaultTokenGetter

type DefaultTokenGetter struct{}

func (*DefaultTokenGetter) GetTokenString

func (t *DefaultTokenGetter) GetTokenString(ctx context.Context, issuerURL, clientID string, usePKCE bool) (string, error)

type TokenGetter

type TokenGetter interface {
	GetTokenString(ctx context.Context, issuerURL, clientID string, usePKCE bool) (string, error)
}

type UserInfo

type UserInfo struct {
	User string
	Orgs []string
}

func GetUserInfoFromToken

func GetUserInfoFromToken(tokenString string) (*UserInfo, error)