feat: add ability to specify the initial container network

Closes #4477
This commit is contained in:
Jose Diaz-Gonzalez committed 2021-07-09 20:30:09 -04:00
1 parent 1bb4e4920b
commit 017037586c
5 files changed
+75 -7

No files matched your search

+21 -2
View File
@@ -127,7 +127,7 @@ dokku network:info test-network
> New as of 0.20.0, Requires Docker 1.21+ > New as of 0.20.0, Requires Docker 1.21+
Apps will default to being associated with the `bridge` network, but can be attached to `attachable` networks by changing the `attach-post-create` or `attach-post-deploy` network properties when using the [docker-local scheduler](/docs/advanced-usage/schedulers/docker-local.md). A change in these values will require an app deploy or rebuild. Apps will default to being associated with the `bridge` network, but can be attached to `attachable` networks by changing the `attach-post-create` or `attach-post-deploy` network properties when using the [docker-local scheduler](/docs/advanced-usage/schedulers/docker-local.md). Additionally, it can be attached to an initial network via the `initial-network` property. A change in these values will require an app deploy or rebuild.
```shell ```shell
# associates the network after a container is created but before it is started # associates the network after a container is created but before it is started
@@ -135,6 +135,9 @@ dokku network:set node-js-app attach-post-create test-network
# associates the network after the deploy is successful but before the proxy is updated # associates the network after the deploy is successful but before the proxy is updated
dokku network:set node-js-app attach-post-deploy other-test-network dokku network:set node-js-app attach-post-deploy other-test-network
# associates the network at container creation
dokku network:set node-js-app initial-network global-network
``` ```
Setting the `attach` network property to an empty value will de-associate the container with the network. Setting the `attach` network property to an empty value will de-associate the container with the network.
@@ -142,6 +145,13 @@ Setting the `attach` network property to an empty value will de-associate the co
```shell ```shell
dokku network:set node-js-app attach-post-create dokku network:set node-js-app attach-post-create
dokku network:set node-js-app attach-post-deploy dokku network:set node-js-app attach-post-deploy
dokku network:set node-js-app initial-network
```
Finally, the `initial-network` property can be set globally by using the `--global` flag in place of the app name.
```shell
dokku network:set --global initial-network global-network
``` ```
#### Network Aliases #### Network Aliases
@@ -203,8 +213,17 @@ Whatever the reason, the semantics of the two network hooks are important and ar
- Container state on attach: `running` - Container state on attach: `running`
- Use case: When another container on the network needs to access _this_ container. - Use case: When another container on the network needs to access _this_ container.
- Example: A background process needs to communicate with the web process exposed by this container. - Example: A background process needs to communicate with the web process exposed by this container.
- `initial-network`:
- Phase it applies to:
- `build`: Intermediate containers created during the build process.
- `deploy`: Deployed app containers.
- `run`: Containers created by the `run` command.
- Container state on attach: `created`
- Use case: When another container on the network is already running and needed by this container.
- Example: A key-value store exposing itself to all your apps may be on the `initial-network`.
> Warning: If the attachment fails at this stage, this may result in your application failing to respond to proxied requests once older containers are removed.
> Warning: If the attachment fails during the `running` container state, this may result in your application failing to respond to proxied requests once older containers are removed.
### Rebuilding network settings ### Rebuilding network settings
+4 -1
View File
@@ -20,11 +20,14 @@ var (
"bind-all-interfaces": "false", "bind-all-interfaces": "false",
"attach-post-create": "", "attach-post-create": "",
"attach-post-deploy": "", "attach-post-deploy": "",
"initial-network": "",
"tld": "", "tld": "",
} }
// GlobalProperties is a map of all valid global network properties // GlobalProperties is a map of all valid global network properties
GlobalProperties = map[string]bool{} GlobalProperties = map[string]bool{
"initial-network": true,
}
) )
// BuildConfig builds network config files // BuildConfig builds network config files
+24 -4
View File
@@ -13,10 +13,13 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
} }
flags := map[string]common.ReportFunc{ flags := map[string]common.ReportFunc{
"--network-bind-all-interfaces": reportBindAllInterfaces, "--network-bind-all-interfaces": reportBindAllInterfaces,
"--network-attach-post-create": reportAttachPostCreate, "--network-attach-post-create": reportAttachPostCreate,
"--network-attach-post-deploy": reportAttachPostDeploy, "--network-attach-post-deploy": reportAttachPostDeploy,
"--network-web-listeners": reportWebListeners, "--network-computed-initial-network": reportComputedInitialNetwork,
"--network-global-initial-network": reportGlobalInitialNetwork,
"--network-initial-network": reportInitialNetwork,
"--network-web-listeners": reportWebListeners,
} }
flagKeys := []string{} flagKeys := []string{}
@@ -42,6 +45,23 @@ func reportAttachPostDeploy(appName string) string {
return common.PropertyGet("network", appName, "attach-post-deploy") return common.PropertyGet("network", appName, "attach-post-deploy")
} }
func reportComputedInitialNetwork(appName string) string {
value := reportInitialNetwork(appName)
if value == "" {
value = reportGlobalInitialNetwork(appName)
}
return value
}
func reportGlobalInitialNetwork(appName string) string {
return common.PropertyGet("network", "--global", "initial-network")
}
func reportInitialNetwork(appName string) string {
return common.PropertyGet("network", appName, "initial-network")
}
func reportWebListeners(appName string) string { func reportWebListeners(appName string) string {
return strings.Join(GetListeners(appName, "web"), " ") return strings.Join(GetListeners(appName, "web"), " ")
} }
+9
View File
@@ -18,6 +18,15 @@ func main() {
var err error var err error
switch trigger { switch trigger {
case "docker-args-process-build":
appName := flag.Arg(0)
err = network.TriggerDockerArgsProcess(appName)
case "docker-args-process-deploy":
appName := flag.Arg(0)
err = network.TriggerDockerArgsProcess(appName)
case "docker-args-process-run":
appName := flag.Arg(0)
err = network.TriggerDockerArgsProcess(appName)
case "install": case "install":
err = network.TriggerInstall() err = network.TriggerInstall()
case "network-build-config": case "network-build-config":
+17
View File
@@ -2,6 +2,7 @@ package network
import ( import (
"fmt" "fmt"
"io/ioutil"
"os" "os"
"strings" "strings"
"unicode/utf8" "unicode/utf8"
@@ -10,6 +11,22 @@ import (
"github.com/dokku/dokku/plugins/config" "github.com/dokku/dokku/plugins/config"
) )
// TriggerDockerArgsProcess outputs the network plugin docker options for an app
func TriggerDockerArgsProcess(appName string) error {
stdin, err := ioutil.ReadAll(os.Stdin)
if err != nil {
return err
}
initialNetwork := reportComputedInitialNetwork(appName)
if initialNetwork != "" {
fmt.Printf(" --network=%s ", initialNetwork)
}
fmt.Print(string(stdin))
return nil
}
// TriggerInstall runs the install step for the network plugin // TriggerInstall runs the install step for the network plugin
func TriggerInstall() error { func TriggerInstall() error {
if err := common.PropertySetup("network"); err != nil { if err := common.PropertySetup("network"); err != nil {