Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeployFunctionOptions ¶
type DeployFunctionOptions struct {
deployment.DeployServiceOptions `yaml:",inline"`
}
DeployFunctionOptions contains the options for the DeployFunction call
type DeploySecretOptions ¶
type DeploySecretOptions struct {
deployment.DeploySecretOptions `yaml:",inline"`
}
DeploySecretOptions contains the options for the DeploySecret call
type FaaS ¶
type FaaS interface {
// Init initializes the FaaS
Init(ctx context.Context, options *InitOptions) error
// Invoke performs a function call against the faas
Invoke(ctx context.Context, options *InvokeOptions) error
// Teardown cleans the FaaS completely
Teardown(ctx context.Context, options *TeardownOptions) error
// DeployFunction deploys a service in an environment
DeployFunction(ctx context.Context, options *DeployFunctionOptions) error
// UndeployFunction unddeploys a service from an environment
UndeployFunction(ctx context.Context, options *UndeployFunctionOptions) error
// ListFunctions returns a list of all deployed services
ListFunctions(ctx context.Context, options *ListFunctionsOptions) ([]*FunctionInfo, error)
// ScaleFunction scales the service
ScaleFunction(ctx context.Context, options *ScaleFunctionOptions) error
// DeploySecret deploys a secret in an environment
DeploySecret(ctx context.Context, options *DeploySecretOptions) error
// UndeploySecret unddeploys a secret from an environment
UndeploySecret(ctx context.Context, options *UndeploySecretOptions) error
// ListSecrets returns a list of all deployed secrets
ListSecrets(ctx context.Context, options *ListSecretsOptions) ([]*SecretInfo, error)
}
FaaS is the interface for a function-as-a-service platform
type FunctionInfo ¶
type FunctionInfo struct {
deployment.ServiceInfo `yaml:",inline"`
}
FunctionInfo contains infos about a running function service
type InitOptions ¶
type InitOptions struct {
deployment.PrepareEnvironmentOptions `yaml:",inline"`
GatewayImage string
}
InitOptions contain the options for the init call
type InvokeOptions ¶
type InvokeOptions struct {
EnvironmentID string
GatewayAddress string
FunctionExpression string
Input io.Reader
Output io.Writer
}
InvokeOptions are the options for the Invoke call
type ListFunctionsOptions ¶
type ListFunctionsOptions struct {
deployment.ListServicesOptions `yaml:",inline"`
}
ListFunctionsOptions contains the options for the ListFunctions call
type ListSecretsOptions ¶
type ListSecretsOptions struct {
deployment.ListSecretsOptions `yaml:",inline"`
}
ListSecretsOptions contains the options for the ListSecrets call
type ScaleFunctionOptions ¶
type ScaleFunctionOptions struct {
deployment.ScaleServiceOptions `yaml:",inline"`
}
ScaleFunctionOptions are the options for the ScaleFunction call
type SecretInfo ¶
type SecretInfo struct {
deployment.SecretInfo `yaml:",inline"`
}
SecretInfo is the (inner) response type for ListSecrets calls
type TeardownOptions ¶
type TeardownOptions struct {
deployment.TeardownEnvironmentOptions `yaml:",inline"`
}
TeardownOptions contain the options for the teardown call
type UndeployFunctionOptions ¶
type UndeployFunctionOptions struct {
deployment.UndeployServiceOptions `yaml:",inline"`
}
UndeployFunctionOptions contains the options for the UndeployFunction call
type UndeploySecretOptions ¶
type UndeploySecretOptions struct {
deployment.UndeploySecretOptions `yaml:",inline"`
}
UndeploySecretOptions contains the options for the UndeploySecret call
Source Files
Directories