Documentation
¶
Overview ¶
Package deploy provides functions to set the deploy configuration for a service
Index ¶
- type SetDeployConfig
- func Fail(err error) SetDeployConfig
- func Failf(stringFormat string, args ...any) SetDeployConfig
- func WithLabel(key, value string) SetDeployConfig
- func WithMode(mode string) SetDeployConfig
- func WithReplicas(replicas int) SetDeployConfig
- func WithResourceLimits(setters ...resource.SetResourceConfig) SetDeployConfig
- func WithResourceReservations(setters ...resource.SetResourceConfig) SetDeployConfig
- func WithRollbackConfig(setters ...update.SetUpdateConfig) SetDeployConfig
- func WithUpdateConfig(setters ...update.SetUpdateConfig) SetDeployConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SetDeployConfig ¶
type SetDeployConfig func(opt *types.DeployConfig) error
func Fail ¶ added in v0.1.4
func Fail(err error) SetDeployConfig
Fail is a function that returns a setter that always returns the given error
note: this is useful for when you want to fail the deploy config and append the error to the service config error collection
func Failf ¶ added in v0.1.4
func Failf(stringFormat string, args ...any) SetDeployConfig
Failf is a function that returns a setter that always returns the given error
note: this is useful for when you want to fail the deploy config and append the error to the service config error collection
func WithLabel ¶
func WithLabel(key, value string) SetDeployConfig
WithLabel appends a label for the service parameters:
- key: the key of the label
- value: the value of the label
func WithMode ¶
func WithMode(mode string) SetDeployConfig
WithMode sets the deploy mode parameters:
- mode: the deploy mode
func WithReplicas ¶
func WithReplicas(replicas int) SetDeployConfig
WithReplicas sets the number of replicas for the service parameters:
- replicas: the number of replicas for the service
func WithResourceLimits ¶
func WithResourceLimits(setters ...resource.SetResourceConfig) SetDeployConfig
WithResourceLimits sets the resource limits for the service parameters:
- setters: the setters for the resource limits
func WithResourceReservations ¶
func WithResourceReservations(setters ...resource.SetResourceConfig) SetDeployConfig
WithResourceReservations sets the resource reservations for the service parameters:
- setters: the setters for the resource reservations
func WithRollbackConfig ¶
func WithRollbackConfig(setters ...update.SetUpdateConfig) SetDeployConfig
WithRollbackConfig sets the rollback configuration for the service parameters:
- setters: the setters for the rollback configuration
func WithUpdateConfig ¶
func WithUpdateConfig(setters ...update.SetUpdateConfig) SetDeployConfig
WithUpdateConfig sets the update configuration for the service parameters:
- setters: the setters for the update configuration
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package resource provides functions to set the resource configuration for a service deploy
|
Package resource provides functions to set the resource configuration for a service deploy |
|
device
Package device provides functions to set the device configuration for a service deploys resource
|
Package device provides functions to set the device configuration for a service deploys resource |
|
Package update provides functions to set the update configuration for a service deploy
|
Package update provides functions to set the update configuration for a service deploy |