Documentation ¶
Index ¶
- func ReadSecret(key string) (string, error)
- type BasicAuth
- type Client
- func (s *Client) CreateNamespace(ctx context.Context, spec types.FunctionNamespace) (int, error)
- func (s *Client) CreateSecret(ctx context.Context, spec types.Secret) (int, error)
- func (s *Client) DeleteFunction(ctx context.Context, functionName, namespace string) error
- func (s *Client) DeleteNamespace(ctx context.Context, namespace string) error
- func (s *Client) DeleteSecret(ctx context.Context, secretName, namespace string) error
- func (s *Client) Deploy(ctx context.Context, spec types.FunctionDeployment) (int, error)
- func (s *Client) GetFunction(ctx context.Context, name, namespace string) (types.FunctionStatus, error)
- func (s *Client) GetFunctions(ctx context.Context, namespace string) ([]types.FunctionStatus, error)
- func (s *Client) GetInfo(ctx context.Context) (SystemInfo, error)
- func (s *Client) GetLogs(ctx context.Context, functionName, namespace string, follow bool, tail int, ...) (<-chan logs.Message, error)
- func (s *Client) GetNamespace(ctx context.Context, namespace string) (types.FunctionNamespace, error)
- func (s *Client) GetNamespaces(ctx context.Context) ([]string, error)
- func (s *Client) GetSecrets(ctx context.Context, namespace string) ([]types.Secret, error)
- func (s *Client) ScaleFunction(ctx context.Context, functionName, namespace string, replicas uint64) error
- func (s *Client) Update(ctx context.Context, spec types.FunctionDeployment) (int, error)
- func (s *Client) UpdateNamespace(ctx context.Context, spec types.FunctionNamespace) (int, error)
- func (s *Client) UpdateSecret(ctx context.Context, spec types.Secret) (int, error)
- type ClientAuth
- type ClientCredentialsAuth
- type ClientCredentialsToken
- type ClientCredentialsTokenSource
- type Provider
- type SecretMap
- type ServiceAccountTokenSource
- type SystemInfo
- type Token
- type TokenAuth
- type TokenSource
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadSecret ¶
ReadSecrets reads a single secrets from /var/openfaas/secrets or from the environment "secret_mount_path" if set.
Types ¶
type Client ¶
type Client struct { GatewayURL *url.URL ClientAuth ClientAuth // contains filtered or unexported fields }
Client is used to manage OpenFaaS functions
func (*Client) CreateNamespace ¶ added in v0.2.5
CreateNamespace creates a namespace
func (*Client) CreateSecret ¶ added in v0.2.9
CreateSecret creates a secret
func (*Client) DeleteFunction ¶ added in v0.2.1
DeleteFunction deletes a function
func (*Client) DeleteNamespace ¶ added in v0.2.5
DeleteNamespace deletes a namespace
func (*Client) DeleteSecret ¶ added in v0.2.9
DeleteSecret deletes a secret
func (*Client) GetFunction ¶ added in v0.0.2
func (s *Client) GetFunction(ctx context.Context, name, namespace string) (types.FunctionStatus, error)
GetFunction gives a richer payload than GetFunctions, but for a specific function
func (*Client) GetFunctions ¶
func (s *Client) GetFunctions(ctx context.Context, namespace string) ([]types.FunctionStatus, error)
GetFunctions lists all functions
func (*Client) GetInfo ¶ added in v0.0.2
func (s *Client) GetInfo(ctx context.Context) (SystemInfo, error)
func (*Client) GetNamespace ¶ added in v0.2.5
func (s *Client) GetNamespace(ctx context.Context, namespace string) (types.FunctionNamespace, error)
GetNamespaces get openfaas namespaces
func (*Client) GetNamespaces ¶
GetNamespaces get openfaas namespaces
func (*Client) GetSecrets ¶ added in v0.2.9
GetSecrets list all secrets
func (*Client) ScaleFunction ¶
func (s *Client) ScaleFunction(ctx context.Context, functionName, namespace string, replicas uint64) error
ScaleFunction scales a function to a number of replicas
func (*Client) UpdateNamespace ¶ added in v0.2.5
UpdateNamespace updates a namespace
type ClientAuth ¶ added in v0.1.0
ClientAuth an interface for client authentication. to add authentication to the client implement this interface
type ClientCredentialsAuth ¶ added in v0.2.3
type ClientCredentialsAuth struct {
// contains filtered or unexported fields
}
func NewClientCredentialsAuth ¶ added in v0.2.3
func NewClientCredentialsAuth(ts TokenSource) *ClientCredentialsAuth
type ClientCredentialsToken ¶ added in v0.2.3
type ClientCredentialsToken struct { AccessToken string `json:"access_token"` TokenType string `json:"token_type"` ExpiresIn int `json:"expires_in"` ObtainedAt time.Time }
ClientCredentialsToken represents an access_token obtained through the client credentials grant type. This token is not associated with a human user.
func (*ClientCredentialsToken) Expired ¶ added in v0.2.3
func (t *ClientCredentialsToken) Expired() bool
Expired returns true if the token is expired or if the expiry time is not known. The token will always expire 10s early to avoid clock skew.
type ClientCredentialsTokenSource ¶ added in v0.2.3
type ClientCredentialsTokenSource struct {
// contains filtered or unexported fields
}
ClientCredentialsTokenSource can be used to obtain an access token using the client credentials grant type. Tested with Keycloak's token endpoint, additional changes may be required for additional OIDC token endpoints.
func (*ClientCredentialsTokenSource) Token ¶ added in v0.2.3
func (ts *ClientCredentialsTokenSource) Token() (string, error)
type Provider ¶ added in v0.0.2
type Provider struct { Provider string `json:"provider,omitempty"` Version types.VersionInfo `json:"version,omitempty"` Orchestration string `json:"orchestration,omitempty"` }
type SecretMap ¶
type SecretMap struct {
// contains filtered or unexported fields
}
func ReadSecrets ¶
ReadSecrets reads all secrets from /var/openfaas/secrets or from the environment "secret_mount_path" if set. The results are returned in a map of key/value pairs.
type ServiceAccountTokenSource ¶ added in v0.2.2
type ServiceAccountTokenSource struct{}
A TokenSource to get ID token by reading a Kubernetes projected service account token from /var/secrets/tokens/openfaas-token or the path set by the token_mount_path environment variable.
func (*ServiceAccountTokenSource) Token ¶ added in v0.2.2
func (ts *ServiceAccountTokenSource) Token() (string, error)
Token returns a Kubernetes projected service account token read from /var/secrets/tokens/openfaas-token or the path set by the token_mount_path environment variable.
type SystemInfo ¶ added in v0.0.2
type SystemInfo struct { Arch string `json:"arch,omitempty"` Provider Provider `json:"provider,omitempty"` Version types.VersionInfo `json:"version,omitempty"` }
type Token ¶ added in v0.1.0
type Token struct { // IDToken is the OIDC access token that authorizes and authenticates // the requests. IDToken string // Expiry is the expiration time of the access token. // // A zero value means the token never expires. Expiry time.Time }
Token represents an OpenFaaS ID token
func ExchangeIDToken ¶ added in v0.1.0
Exchange an OIDC ID Token from an IdP for OpenFaaS token using the token exchange grant type. tokenURL should be the OpenFaaS token endpoint within the internal OIDC service
type TokenAuth ¶ added in v0.1.0
type TokenAuth struct { // TokenURL represents the OpenFaaS gateways token endpoint URL. TokenURL string // TokenSource used to get an ID token that can be exchanged for an OpenFaaS ID token. TokenSource TokenSource // contains filtered or unexported fields }
TokenAuth bearer token authentication for OpenFaaS deployments with OpenFaaS IAM enabled.
type TokenSource ¶ added in v0.1.0
A TokenSource is anything that can return an OIDC ID token that can be exchanged for an OpenFaaS token.
func NewClientCredentialsTokenSource ¶ added in v0.2.3
func NewClientCredentialsTokenSource(clientID, clientSecret, tokenURL, scope, grantType, audience string) TokenSource