Documentation
¶
Overview ¶
Package sc provides functions to set the service config
Index ¶
- func Fail(err error) create.SetServiceConfig
- func Failf(stringFormat string, args ...any) create.SetServiceConfig
- func WithAnnotation(key, value string) create.SetServiceConfig
- func WithBuild(setters ...build.SetBuildConfig) create.SetServiceConfig
- func WithDependsOn(service string) create.SetServiceConfig
- func WithDependsOnHealthy(service string) create.SetServiceConfig
- func WithDeploy(setters ...deploy.SetDeployConfig) create.SetServiceConfig
- func WithDevelop(action WatchAction, watchPath string, target string, ignorePaths ...string) create.SetServiceConfig
- func WithEnvFile(path string) create.SetServiceConfig
- func WithNoAttach() create.SetServiceConfig
- func WithProfiles(profiles ...string) create.SetServiceConfig
- func WithSecret(setters ...secretservice.SetSecretServiceConfig) create.SetServiceConfig
- type WatchAction
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fail ¶ added in v0.1.4
func Fail(err error) create.SetServiceConfig
Fail is a function that returns an error
note: this is useful for when you want to fail the service config and append the error to the service config error collection
func Failf ¶ added in v0.1.4
func Failf(stringFormat string, args ...any) create.SetServiceConfig
Failf is a function that returns an error
note: this is useful for when you want to fail the service config and append the error to the service config error collection
func WithAnnotation ¶
func WithAnnotation(key, value string) create.SetServiceConfig
WithAnnotation sets an annotation for the service
func WithBuild ¶
func WithBuild(setters ...build.SetBuildConfig) create.SetServiceConfig
WithBuild sets the build config for the service parameters:
- setters: the setters for the build config
func WithDependsOn ¶
func WithDependsOn(service string) create.SetServiceConfig
WithDependsOn appends the depends on config for the service parameters:
- service: the service to depend on
func WithDependsOnHealthy ¶
func WithDependsOnHealthy(service string) create.SetServiceConfig
WithDependsOn appends the depends on config for the service parameters:
- service: the service to depend on
func WithDeploy ¶
func WithDeploy(setters ...deploy.SetDeployConfig) create.SetServiceConfig
WithDeploy sets the deploy config for the service parameters:
- setters: the setters for the deploy config
func WithDevelop ¶
func WithDevelop(action WatchAction, watchPath string, target string, ignorePaths ...string) create.SetServiceConfig
WithDevelop sets the develop config for the service parameters:
- action: the action to take when the watch path changes
- watchPath: the path to watch
- target: the target to sync to
- ignorePaths: the paths to ignore
note: this only works with the --watch flag in the compose cli
func WithEnvFile ¶
func WithEnvFile(path string) create.SetServiceConfig
WithEnvFile appends the env file paths for the service parameters:
- path: the path to the env file
func WithNoAttach ¶
func WithNoAttach() create.SetServiceConfig
WithNoAttach sets the attach option to false for the service
func WithProfiles ¶
func WithProfiles(profiles ...string) create.SetServiceConfig
WithProfiles appends the profiles for the service parameters:
- profiles: the profiles to append
func WithSecret ¶
func WithSecret(setters ...secretservice.SetSecretServiceConfig) create.SetServiceConfig
WithSecret appends a secret to the service parameters:
- setters: the setters for the secret
secrets specifies secrets to expose to the service.
Types ¶
type WatchAction ¶
type WatchAction string
WatchAction is the action to take when the watch path changes
const ( WatchActionSync WatchAction = "sync" WatchActionRebuild WatchAction = "rebuild" WatchActionSyncRestart WatchAction = "sync+restart" )
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package build provides functions to set the build config for a service
|
Package build provides functions to set the build config for a service |
|
ulimit
Package ulimit provides a set of functions to configure the ulimits for the build
|
Package ulimit provides a set of functions to configure the ulimits for the build |
|
Package deploy provides functions to set the deploy configuration for a service
|
Package deploy provides functions to set the deploy configuration for a service |
|
resource
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 |
|
resource/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 |
|
update
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 |
|
Package network provides functions to set the network configuration for a project
|
Package network provides functions to set the network configuration for a project |
|
pool
Package pool provides functions to set the ipam pool configuration for a project
|
Package pool provides functions to set the ipam pool configuration for a project |
|
secrets
|
|
|
projectsecret
Package projectsecret provides a set of functions to configure the secret for the project
|
Package projectsecret provides a set of functions to configure the secret for the project |
|
secretservice
Package secretservice provides a set of functions to configure the secrets for the service
|
Package secretservice provides a set of functions to configure the secrets for the service |
|
Package volume provides functions to set the volume configuration for a project
|
Package volume provides functions to set the volume configuration for a project |