You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+18-45
Original file line number
Diff line number
Diff line change
@@ -35,55 +35,28 @@ The following variables are standard in most of our Dockerfiles to reduce duplic
35
35
36
36
## Run Environment
37
37
Run environment variables are used in the entrypoint script to render configuration templates, perform flow control, etc. These values can be overridden when inheriting from the base dockerfile, specified during `docker run`, or in kubernetes manifests in the `env` array.
38
-
39
-
*`KAZOO_APPS`: a comma delimited list used directly by the kazoo_apps erlang vm as the list of default apps to start. Defaults to `blackhole,callflow,cdr,conference,crossbar,doodle,ecallmgr,fax,hangups,hotornot,konami,jonny5,media_mgr,milliwatt,omnipresence,pivot,registrar,reorder,stepswitch,sysconf,teletype,trunkstore,webhooks`.
40
-
41
-
*`ERLANG_VM`: `_app` is appended to the end and passed to the `-s` argument in vm.args as well as used for the erlang node name. Defaults to `kazoo_apps`.
42
-
43
-
*`ERLANG_THREADS`: passed to the `+A` argument in vm.args. Defaults to `64`.
44
-
45
-
*`ERLANG_COOKIE`: written to `~/.erlang.cookie` by the `erlang-cookie` script in `/usr/local/bin`. Defaults to `insecure-cookie`.
46
-
47
-
*`KAZOO_LOG_LEVEL`: lowercased and used as the value for the console log level in the log section of `config.ini` Defaults to `info`
48
-
49
-
*`KAZOO_LOG_COLOR`: used as the value for the `colored` tuple in `sys.config`. Defaults to `true`
50
-
51
-
*`KAZOO_SASL_ERRLOG_TYPE`: used as the value for `-sasl errlog_type` in `vm.args`. Defaults to `error`, choices include: error, progress, all.
52
-
53
-
*`KAZOO_SASL_ERROR_LOGGER`: used as the value for `-sasl sasl_error_logger` in `vm.args`. Defaults to `tty`. *This shouldn't be changed without good reason inside docker and is provided for testing purposes*
54
-
55
-
*`REGION`: interpolated with `DATACENTER` as such `${REGION}-${DATACENTER}` and stored in `KAZOO_ZONE`. See `KAZOO_ZONE`. Defaults to local.
56
-
57
-
*`DATACENTER`: interpolated with `REGION` as such `${REGION}-${DATACENTER}` and stored in `KAZOO_ZONE`. See `KAZOO_ZONE`. Defaults to dev.
58
-
59
-
*`KAZOO_ZONE`: when provided, interpolation of `DATACENTER` and `REGION` is ignored and the value of `KAZOO_ZONE` is used directly. This is useful for local test and dev environments where ZONE's don't matter. Used as name in `[zone]` section and as `zone` attribute in other sections of `config.ini`. Defaults to the interpolation described.
60
-
61
-
*`COUCHDB_HOST`: the hostname or ip address of the load balancer to reach bigcouch or couchdb through. Used in the `bigcouch` section of `config.ini`. Defaults to `couchdb-lb`.
62
-
63
-
*`COUCHDB_DATA_PORT`: used as the value for the `port` key in the `bigcouch` section of `config.ini`. Defaults to `5984`.
64
-
65
-
*`COUCHDB_ADMIN_PORT`: used as the value for the `admin_port` key in the `bigcouch` section of `config.ini`. Defaults to `5986`.
66
-
67
-
*`COUCHDB_COMPACT_AUTOMATICALLY`: used as the value for the `compact_automatically` key in the `bigcouch` section of `config.ini`. Defaults to `true`.
68
-
69
-
*`COUCHDB_USER`: used as the value for the `username` key in the `bigcouch` section of `config.ini`. Defaults to `admin`.
70
-
71
-
*`COUCHDB_PASS`: used as the value for the `password` key in the `bigcouch` section of `config.ini`. Defaults to `secret`
72
-
73
-
*`RABBITMQ_USER`: interpolated as such `"amqp://user:pass@host:5672"` and used for all `uri` keys in the `amqp` section or the `amqp_uri` keys in the `zone` section of `config.ini`. Defaults to `guest`.
74
-
75
-
*`RABBITMQ_PASS`: interpolated as such `"amqp://user:pass@host:5672"` and used for all `uri` keys in the `amqp` section or the `amqp_uri` keys in the `zone` section of `config.ini`. Defaults to `guest`.
76
-
77
-
*`RABBITMQ_HOSTS`: comma delimited list of hostnames or ip addresses that are split on comma's, interpolated as such `"amqp://{user}:{pass}@{host}:5672"`, and used to build a list of `amqp_uri`'s' for the `zone` section of `config.ini`. Defaults to `rabbitmq`.
38
+
*`KAZOO_APPS`: a comma delimited list used directly by the kazoo_apps erlang vm as the list of default apps to start.
39
+
*`ERLANG_THREADS`: passed to the `+A` argument in vm.args.
40
+
*`ERLANG_COOKIE`: written to `~/.erlang.cookie` by the `erlang-cookie` script in `/usr/local/bin`.
41
+
*`KAZOO_LOG_LEVEL`: lowercased and used as the value for the console log level in the log section of `config.ini`.
42
+
*`KAZOO_LOG_COLOR`: used as the value for the `colored` tuple in `sys.config`.
43
+
*`REGION`: interpolated with `DATACENTER` as such `${COUNTRY}-${REGION}` and stored in `KAZOO_ZONE`. See `KAZOO_ZONE`.
44
+
*`COUNTRY`: interpolated with `REGION` as such `${COUNTRY}-${REGION}` and stored in `KAZOO_ZONE`. See `KAZOO_ZONE`.
45
+
*`KAZOO_ZONE`: when provided, interpolation of `COUNTRY` and `REGION` is ignored and the value of `KAZOO_ZONE` is used directly. This is useful for local test and dev environments where ZONE's don't matter. Used as name in `[zone]` section and as `zone` attribute in other sections of `config.ini`.
46
+
*`COUCHDB_HOST`: the hostname or ip address of the load balancer to reach bigcouch or couchdb through. Used in the `bigcouch` section of `config.ini`.
47
+
*`COUCHDB_DATA_PORT`: used as the value for the `port` key in the `bigcouch` section of `config.ini`.
48
+
*`COUCHDB_ADMIN_PORT`: used as the value for the `admin_port` key in the `bigcouch` section of `config.ini`.
49
+
*`COUCHDB_USER`: used as the value for the `username` key in the `bigcouch` section of `config.ini`.
50
+
*`COUCHDB_PASS`: used as the value for the `password` key in the `bigcouch` section of `config.ini`.
51
+
*`RABBITMQ_USER`: interpolated as such `"amqp://user:pass@host:5672"` and used for all `uri` keys in the `amqp` section or the `amqp_uri` keys in the `zone` section of `config.ini`.
52
+
*`RABBITMQ_PASS`: interpolated as such `"amqp://user:pass@host:5672"` and used for all `uri` keys in the `amqp` section or the `amqp_uri` keys in the `zone` section of `config.ini`.
53
+
*`RABBITMQ_HOST`: hostname or ip address, interpolated as such `"amqp://{user}:{pass}@{host}:5672"`, and used in the `amqp_uri` property of the `zone` section of `config.ini`.
78
54
79
55
80
56
## Extra tools
81
57
### In container
82
58
There is a binary called [kazoo-tool](build/kazoo-tool) in `~/bin`. It contains the useful functions such as remote_console, upgrade, etc found in the original kazoo service file. Since using service files in a docker container is largely a very bad idea, I've extracted the useful functions and adapted them to work in the container environment.
83
59
84
-
### Outside container
85
-
In the [scripts](scripts) directory, there are two scripts: `do-kube`, and `do-local` that allow you to run a sup command on a local or remote instance of kazoo as well as the basic initialization commands for a new kazoo cluster. Run either command without arguments for usage.
0 commit comments