Documentation
¶
Index ¶
- Constants
- func NewProjectsClient(platform *Platform, platformConfiguration *platformconfig.Config) (project.Client, error)
- type Platform
- func (p *Platform) CreateFunction(ctx context.Context, createFunctionOptions *platform.CreateFunctionOptions) (*platform.CreateFunctionResult, error)
- func (p *Platform) CreateFunctionEvent(ctx context.Context, ...) error
- func (p *Platform) CreateProject(ctx context.Context, createProjectOptions *platform.CreateProjectOptions) error
- func (p *Platform) DeleteFunction(ctx context.Context, deleteFunctionOptions *platform.DeleteFunctionOptions) error
- func (p *Platform) DeleteFunctionEvent(ctx context.Context, ...) error
- func (p *Platform) DeleteProject(ctx context.Context, deleteProjectOptions *platform.DeleteProjectOptions) error
- func (p *Platform) GetAPIGatewayScrubber() *platform.APIGatewayScrubber
- func (p *Platform) GetAPIGateways(ctx context.Context, getAPIGatewaysOptions *platform.GetAPIGatewaysOptions) ([]platform.APIGateway, error)
- func (p *Platform) GetDefaultInvokeIPAddresses() ([]string, error)
- func (p *Platform) GetExternalIPAddresses() ([]string, error)
- func (p *Platform) GetFunctionContainerName(functionConfig *functionconfig.Config) string
- func (p *Platform) GetFunctionEvents(ctx context.Context, ...) ([]platform.FunctionEvent, error)
- func (p *Platform) GetFunctionReplicaContainers(ctx context.Context, functionConfig *functionconfig.Config, replicaName string) ([]string, error)
- func (p *Platform) GetFunctionReplicaLogsStream(ctx context.Context, options *platform.GetFunctionReplicaLogsStreamOptions) (io.ReadCloser, error)
- func (p *Platform) GetFunctionReplicaNames(ctx context.Context, function platform.Function, ...) ([]string, error)
- func (p *Platform) GetFunctionScrubber() *functionconfig.Scrubber
- func (p *Platform) GetFunctionVolumeMountName(functionConfig *functionconfig.Config) string
- func (p *Platform) GetFunctions(ctx context.Context, getFunctionsOptions *platform.GetFunctionsOptions) ([]platform.Function, error)
- func (p *Platform) GetHealthCheckMode() platform.HealthCheckMode
- func (p *Platform) GetName() string
- func (p *Platform) GetNamespaces(ctx context.Context) ([]string, error)
- func (p *Platform) GetProjects(ctx context.Context, getProjectsOptions *platform.GetProjectsOptions) ([]platform.Project, error)
- func (p *Platform) Initialize(ctx context.Context) error
- func (p *Platform) InitializeContainerBuilder() error
- func (p *Platform) RedeployFunction(ctx context.Context, redeployFunctionOptions *platform.RedeployFunctionOptions) error
- func (p *Platform) SaveFunctionDeployLogs(ctx context.Context, functionName, namespace string) error
- func (p *Platform) UpdateFunction(ctx context.Context, updateFunctionOptions *platform.UpdateFunctionOptions) error
- func (p *Platform) UpdateFunctionEvent(ctx context.Context, ...) error
- func (p *Platform) UpdateProject(ctx context.Context, updateProjectOptions *platform.UpdateProjectOptions) error
- func (p *Platform) ValidateFunctionContainersHealthiness(ctx context.Context)
Constants ¶
const FunctionProcessorContainerDirPath = "/etc/nuclio/config/processor"
const Mib = 1048576
Variables ¶
This section is empty.
Functions ¶
func NewProjectsClient ¶
Types ¶
type Platform ¶
func NewPlatform ¶
func NewPlatform(ctx context.Context, parentLogger logger.Logger, platformConfiguration *platformconfig.Config, defaultNamespace string) (*Platform, error)
NewPlatform instantiates a new local platform
func (*Platform) CreateFunction ¶
func (p *Platform) CreateFunction(ctx context.Context, createFunctionOptions *platform.CreateFunctionOptions) ( *platform.CreateFunctionResult, error)
CreateFunction will simply run a docker image
func (*Platform) CreateFunctionEvent ¶
func (p *Platform) CreateFunctionEvent(ctx context.Context, createFunctionEventOptions *platform.CreateFunctionEventOptions) error
CreateFunctionEvent will create a new function event that can later be used as a template from which to invoke functions
func (*Platform) CreateProject ¶
func (p *Platform) CreateProject(ctx context.Context, createProjectOptions *platform.CreateProjectOptions) error
CreateProject will create a new project
func (*Platform) DeleteFunction ¶
func (p *Platform) DeleteFunction(ctx context.Context, deleteFunctionOptions *platform.DeleteFunctionOptions) error
DeleteFunction will delete a previously deployed function
func (*Platform) DeleteFunctionEvent ¶
func (p *Platform) DeleteFunctionEvent(ctx context.Context, deleteFunctionEventOptions *platform.DeleteFunctionEventOptions) error
DeleteFunctionEvent will delete a previously existing function event
func (*Platform) DeleteProject ¶
func (p *Platform) DeleteProject(ctx context.Context, deleteProjectOptions *platform.DeleteProjectOptions) error
DeleteProject will delete an existing project
func (*Platform) GetAPIGatewayScrubber ¶
func (p *Platform) GetAPIGatewayScrubber() *platform.APIGatewayScrubber
func (*Platform) GetAPIGateways ¶
func (p *Platform) GetAPIGateways(ctx context.Context, getAPIGatewaysOptions *platform.GetAPIGatewaysOptions) ([]platform.APIGateway, error)
GetAPIGateways not supported on this platform
func (*Platform) GetDefaultInvokeIPAddresses ¶
func (*Platform) GetExternalIPAddresses ¶
GetExternalIPAddresses returns the external IP addresses invocations will use. These addresses are either set through SetExternalIPAddresses or automatically discovered
func (*Platform) GetFunctionContainerName ¶
func (p *Platform) GetFunctionContainerName(functionConfig *functionconfig.Config) string
func (*Platform) GetFunctionEvents ¶
func (p *Platform) GetFunctionEvents(ctx context.Context, getFunctionEventsOptions *platform.GetFunctionEventsOptions) ([]platform.FunctionEvent, error)
GetFunctionEvents will list existing function events
func (*Platform) GetFunctionReplicaContainers ¶
func (*Platform) GetFunctionReplicaLogsStream ¶
func (p *Platform) GetFunctionReplicaLogsStream(ctx context.Context, options *platform.GetFunctionReplicaLogsStreamOptions) (io.ReadCloser, error)
func (*Platform) GetFunctionReplicaNames ¶
func (*Platform) GetFunctionScrubber ¶
func (p *Platform) GetFunctionScrubber() *functionconfig.Scrubber
func (*Platform) GetFunctionVolumeMountName ¶
func (p *Platform) GetFunctionVolumeMountName(functionConfig *functionconfig.Config) string
func (*Platform) GetFunctions ¶
func (p *Platform) GetFunctions(ctx context.Context, getFunctionsOptions *platform.GetFunctionsOptions) ([]platform.Function, error)
GetFunctions will return deployed functions
func (*Platform) GetHealthCheckMode ¶
func (p *Platform) GetHealthCheckMode() platform.HealthCheckMode
GetHealthCheckMode returns the healthcheck mode the platform requires
func (*Platform) GetNamespaces ¶
GetNamespaces returns all the namespaces in the platform
func (*Platform) GetProjects ¶
func (p *Platform) GetProjects(ctx context.Context, getProjectsOptions *platform.GetProjectsOptions) ([]platform.Project, error)
GetProjects will list existing projects
func (*Platform) InitializeContainerBuilder ¶
func (*Platform) RedeployFunction ¶
func (*Platform) SaveFunctionDeployLogs ¶
func (*Platform) UpdateFunction ¶
func (p *Platform) UpdateFunction(ctx context.Context, updateFunctionOptions *platform.UpdateFunctionOptions) error
UpdateFunction will update a previously deployed function
func (*Platform) UpdateFunctionEvent ¶
func (p *Platform) UpdateFunctionEvent(ctx context.Context, updateFunctionEventOptions *platform.UpdateFunctionEventOptions) error
UpdateFunctionEvent will update a previously existing function event
func (*Platform) UpdateProject ¶
func (p *Platform) UpdateProject(ctx context.Context, updateProjectOptions *platform.UpdateProjectOptions) error
UpdateProject will update an existing project