1 parent
5141360b48
commit
04a96125cc
5 files changed
+103
-42
No files matched your search
@@ -0,0 +1,5 @@
|
|||||||
|
# 0.23.0 Migration Guide
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- The commands `proxy:enable`, `proxy:disable` and `proxy:build-config` now support the `--all` flag in addition to general parallelism.
|
||||||
@@ -3,11 +3,11 @@
|
|||||||
> New as of 0.5.0, Enhanced in 0.6.0
|
> New as of 0.5.0, Enhanced in 0.6.0
|
||||||
|
|
||||||
```
|
```
|
||||||
proxy:build-config <app> # (Re)builds config for given app
|
proxy:build-config [--parallel count] [--all|<app>] # (Re)builds config for given app
|
||||||
proxy:disable <app> # Disable proxy for app
|
proxy:disable [--parallel count] [--all|<app>] # Disable proxy for app
|
||||||
proxy:enable <app> # Enable proxy for app
|
proxy:enable [--parallel count] [--all|<app>] # Enable proxy for app
|
||||||
proxy:report [<app>] [<flag>] # Displays a proxy report for one or more apps
|
proxy:report [<app>] [<flag>] # Displays a proxy report for one or more apps
|
||||||
proxy:set <app> <proxy-type> # Set proxy type for app
|
proxy:set <app> <proxy-type> # Set proxy type for app
|
||||||
```
|
```
|
||||||
|
|
||||||
In Dokku 0.5.0, port proxying was decoupled from the `nginx-vhosts` plugin into the proxy plugin. Dokku 0.6.0 introduced the ability to map host ports to specific container ports. In the future this will allow other proxy software - such as HAProxy or Caddy - to be used in place of nginx.
|
In Dokku 0.5.0, port proxying was decoupled from the `nginx-vhosts` plugin into the proxy plugin. Dokku 0.6.0 introduced the ability to map host ports to specific container ports. In the future this will allow other proxy software - such as HAProxy or Caddy - to be used in place of nginx.
|
||||||
@@ -22,11 +22,23 @@ In certain cases, your app proxy configs may drift from the correct config for y
|
|||||||
dokku proxy:build-config node-js-app
|
dokku proxy:build-config node-js-app
|
||||||
```
|
```
|
||||||
|
|
||||||
### Container network interface binding
|
All apps may have their proxy config rebuilt by using the `--all` flag.
|
||||||
|
|
||||||
> Changed as of 0.11.0
|
```shell
|
||||||
|
dokku proxy:build-config --all
|
||||||
|
```
|
||||||
|
|
||||||
From Dokku versions `0.5.0` until `0.11.0`, enabling or disabling an application's proxy would **also** control whether or not the application was bound to all interfaces - e.g. `0.0.0.0`. As of `0.11.0`, this is now controlled by the network plugin. Please see the [network documentation](/docs/networking/network.md#container-network-interface-binding) for more information.
|
By default, rebuilding proxy configs for all apps happens serially. The parallelism may be controlled by the `--parallel` flag.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku proxy:build-config --all --parallel 2
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, the number of parallel workers may be automatically set to the number of CPUs available by setting the `--parallel` flag to `-1`
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku proxy:build-config --all --parallel -1
|
||||||
|
```
|
||||||
|
|
||||||
### Displaying proxy reports for an app
|
### Displaying proxy reports for an app
|
||||||
|
|
||||||
@@ -94,3 +106,9 @@ dokku proxy:set node-js-app nginx
|
|||||||
### Proxy port mapping
|
### Proxy port mapping
|
||||||
|
|
||||||
See the [port management documentation](/docs/networking/port-management.md) for more information on how port mappings are managed for an application.
|
See the [port management documentation](/docs/networking/port-management.md) for more information on how port mappings are managed for an application.
|
||||||
|
|
||||||
|
### Container network interface binding
|
||||||
|
|
||||||
|
> Changed as of 0.11.0
|
||||||
|
|
||||||
|
From Dokku versions `0.5.0` until `0.11.0`, enabling or disabling an application's proxy would **also** control whether or not the application was bound to all interfaces - e.g. `0.0.0.0`. As of `0.11.0`, this is now controlled by the network plugin. Please see the [network documentation](/docs/networking/network.md#container-network-interface-binding) for more information.
|
||||||
@@ -3,9 +3,14 @@ package proxy
|
|||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/dokku/dokku/plugins/common"
|
||||||
"github.com/dokku/dokku/plugins/config"
|
"github.com/dokku/dokku/plugins/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// RunInSerial is the default value for whether to run a command in parallel or not
|
||||||
|
// and defaults to -1 (false)
|
||||||
|
const RunInSerial = 0
|
||||||
|
|
||||||
// PortMap is a struct that contains a scheme:host-port:container-port mapping
|
// PortMap is a struct that contains a scheme:host-port:container-port mapping
|
||||||
type PortMap struct {
|
type PortMap struct {
|
||||||
ContainerPort int
|
ContainerPort int
|
||||||
@@ -22,6 +27,46 @@ func (p PortMap) AllowsPersistence() bool {
|
|||||||
return p.Scheme == "__internal__"
|
return p.Scheme == "__internal__"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BuildConfig rebuilds the proxy config for the specified app
|
||||||
|
func BuildConfig(appName string) error {
|
||||||
|
return common.PlugnTrigger("proxy-build-config", []string{appName}...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disable disables proxy implementations for the specified app
|
||||||
|
func Disable(appName string) error {
|
||||||
|
if !IsAppProxyEnabled(appName) {
|
||||||
|
common.LogInfo1("Proxy is already disable for app")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
common.LogInfo1("Disabling proxy for app")
|
||||||
|
entries := map[string]string{
|
||||||
|
"DOKKU_DISABLE_PROXY": "1",
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := config.SetMany(appName, entries, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return common.PlugnTrigger("proxy-disable", []string{appName}...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enable enables proxy implementations for the specified app
|
||||||
|
func Enable(appName string) error {
|
||||||
|
if IsAppProxyEnabled(appName) {
|
||||||
|
common.LogInfo1("Proxy is already enabled for app")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
common.LogInfo1("Enabling proxy for app")
|
||||||
|
keys := []string{"DOKKU_DISABLE_PROXY"}
|
||||||
|
if err := config.UnsetMany(appName, keys, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return common.PlugnTrigger("proxy-enable", []string{appName}...)
|
||||||
|
}
|
||||||
|
|
||||||
// IsAppProxyEnabled returns true if proxy is enabled; otherwise return false
|
// IsAppProxyEnabled returns true if proxy is enabled; otherwise return false
|
||||||
func IsAppProxyEnabled(appName string) bool {
|
func IsAppProxyEnabled(appName string) bool {
|
||||||
proxyEnabled := true
|
proxyEnabled := true
|
||||||
|
|||||||
@@ -20,19 +20,25 @@ func main() {
|
|||||||
switch subcommand {
|
switch subcommand {
|
||||||
case "build-config":
|
case "build-config":
|
||||||
args := flag.NewFlagSet("proxy:build-config", flag.ExitOnError)
|
args := flag.NewFlagSet("proxy:build-config", flag.ExitOnError)
|
||||||
|
allApps := args.Bool("all", false, "--all: build-config for all apps")
|
||||||
|
parallelCount := args.Int("parallel", proxy.RunInSerial, "--parallel: number of apps to build-config for in parallel, -1 to match cpu count")
|
||||||
args.Parse(os.Args[2:])
|
args.Parse(os.Args[2:])
|
||||||
appName := args.Arg(0)
|
appName := args.Arg(0)
|
||||||
err = proxy.CommandBuildConfig(appName)
|
err = proxy.CommandBuildConfig(appName, *allApps, *parallelCount)
|
||||||
case "disable":
|
case "disable":
|
||||||
args := flag.NewFlagSet("proxy:disable", flag.ExitOnError)
|
args := flag.NewFlagSet("proxy:disable", flag.ExitOnError)
|
||||||
|
allApps := args.Bool("all", false, "--all: disable proxy for all apps")
|
||||||
|
parallelCount := args.Int("parallel", proxy.RunInSerial, "--parallel: number of apps to disable proxy for in parallel, -1 to match cpu count")
|
||||||
args.Parse(os.Args[2:])
|
args.Parse(os.Args[2:])
|
||||||
appName := args.Arg(0)
|
appName := args.Arg(0)
|
||||||
err = proxy.CommandDisable(appName)
|
err = proxy.CommandDisable(appName, *allApps, *parallelCount)
|
||||||
case "enable":
|
case "enable":
|
||||||
args := flag.NewFlagSet("proxy:enable", flag.ExitOnError)
|
args := flag.NewFlagSet("proxy:enable", flag.ExitOnError)
|
||||||
|
allApps := args.Bool("all", false, "--all: enable proxy for all apps")
|
||||||
|
parallelCount := args.Int("parallel", proxy.RunInSerial, "--parallel: number of apps to enable proxy for in parallel, -1 to match cpu count")
|
||||||
args.Parse(os.Args[2:])
|
args.Parse(os.Args[2:])
|
||||||
appName := args.Arg(0)
|
appName := args.Arg(0)
|
||||||
err = proxy.CommandEnable(appName)
|
err = proxy.CommandEnable(appName, *allApps, *parallelCount)
|
||||||
case "ports":
|
case "ports":
|
||||||
args := flag.NewFlagSet("proxy:ports", flag.ExitOnError)
|
args := flag.NewFlagSet("proxy:ports", flag.ExitOnError)
|
||||||
args.Parse(os.Args[2:])
|
args.Parse(os.Args[2:])
|
||||||
|
|||||||
@@ -9,55 +9,42 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// CommandBuildConfig rebuilds config for a given app
|
// CommandBuildConfig rebuilds config for a given app
|
||||||
func CommandBuildConfig(appName string) error {
|
func CommandBuildConfig(appName string, allApps bool, parallelCount int) error {
|
||||||
|
if allApps {
|
||||||
|
return common.RunCommandAgainstAllApps(BuildConfig, "build-config", parallelCount)
|
||||||
|
}
|
||||||
|
|
||||||
if err := common.VerifyAppName(appName); err != nil {
|
if err := common.VerifyAppName(appName); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return common.PlugnTrigger("proxy-build-config", []string{appName}...)
|
return BuildConfig(appName)
|
||||||
}
|
}
|
||||||
|
|
||||||
// CommandDisable disables the proxy for app via command line
|
// CommandDisable disables the proxy for app via command line
|
||||||
func CommandDisable(appName string) error {
|
func CommandDisable(appName string, allApps bool, parallelCount int) error {
|
||||||
|
if allApps {
|
||||||
|
return common.RunCommandAgainstAllApps(Disable, "disable", parallelCount)
|
||||||
|
}
|
||||||
|
|
||||||
if err := common.VerifyAppName(appName); err != nil {
|
if err := common.VerifyAppName(appName); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if !IsAppProxyEnabled(appName) {
|
return Disable(appName)
|
||||||
common.LogInfo1("Proxy is already disable for app")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
common.LogInfo1("Disabling proxy for app")
|
|
||||||
entries := map[string]string{
|
|
||||||
"DOKKU_DISABLE_PROXY": "1",
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := config.SetMany(appName, entries, false); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return common.PlugnTrigger("proxy-disable", []string{appName}...)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// CommandEnable enables the proxy for app via command line
|
// CommandEnable enables the proxy for app via command line
|
||||||
func CommandEnable(appName string) error {
|
func CommandEnable(appName string, allApps bool, parallelCount int) error {
|
||||||
|
if allApps {
|
||||||
|
return common.RunCommandAgainstAllApps(Enable, "enable", parallelCount)
|
||||||
|
}
|
||||||
|
|
||||||
if err := common.VerifyAppName(appName); err != nil {
|
if err := common.VerifyAppName(appName); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if IsAppProxyEnabled(appName) {
|
return Enable(appName)
|
||||||
common.LogInfo1("Proxy is already enabled for app")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
common.LogInfo1("Enabling proxy for app")
|
|
||||||
keys := []string{"DOKKU_DISABLE_PROXY"}
|
|
||||||
if err := config.UnsetMany(appName, keys, false); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return common.PlugnTrigger("proxy-enable", []string{appName}...)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// CommandPorts is a cmd wrapper to list proxy port mappings for an app
|
// CommandPorts is a cmd wrapper to list proxy port mappings for an app
|
||||||
|
|||||||
Reference in new issue
Block a user