Skip to content

Add "vm_memory_high_watermark" to the generated config, sourced from the value of the "memory.limit_in_bytes" cgroup restriction #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 6, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion 3.6/alpine/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ RUN set -ex; \
ENV HOME /var/lib/rabbitmq

RUN mkdir -p /var/lib/rabbitmq /etc/rabbitmq \
&& echo '[ { rabbit, [ { loopback_users, [ ] } ] } ].' > /etc/rabbitmq/rabbitmq.config \
&& chown -R rabbitmq:rabbitmq /var/lib/rabbitmq /etc/rabbitmq \
&& chmod -R 777 /var/lib/rabbitmq /etc/rabbitmq
VOLUME /var/lib/rabbitmq
Expand Down
76 changes: 75 additions & 1 deletion 3.6/alpine/docker-entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ rabbitConfigKeys=(
default_user
default_vhost
hipe_compile
vm_memory_high_watermark
)
fileConfigKeys=(
management_ssl_cacertfile
Expand Down Expand Up @@ -95,6 +96,10 @@ for conf in "${allConfigKeys[@]}"; do
var="RABBITMQ_${conf^^}"
val="${!var:-}"
if [ "$val" ]; then
if [ "${configDefaults[$conf]:-}" ] && [ "${configDefaults[$conf]}" = "$val" ]; then
# if the value set is the same as the default, treat it as if it isn't set
continue
fi
haveConfig=1
case "$conf" in
ssl_*) haveSslConfig=1 ;;
Expand Down Expand Up @@ -235,13 +240,82 @@ rabbit_env_config() {
join $'\n' "${ret[@]}"
}

if [ "$1" = 'rabbitmq-server' ] && [ "$haveConfig" ]; then
shouldWriteConfig="$haveConfig"
if [ ! -f /etc/rabbitmq/rabbitmq.config ]; then
shouldWriteConfig=1
fi

if [ "$1" = 'rabbitmq-server' ] && [ "$shouldWriteConfig" ]; then
fullConfig=()

rabbitConfig=(
"{ loopback_users, $(rabbit_array) }"
)

# determine whether to set "vm_memory_high_watermark" (based on cgroups)
if [ -r /sys/fs/cgroup/memory/memory.limit_in_bytes ] && [ -r /proc/meminfo ]; then
memLimitB="$(< /sys/fs/cgroup/memory/memory.limit_in_bytes)"
memLimitKb="$(( memLimitB / 1024 ))"

memTotalKb="$(awk -F ':? +' '$1 == "MemTotal" { print $2; exit }' /proc/meminfo)"

if [ "$memLimitKb" -gt "$memTotalKb" ]; then
memLimitB=
memLimitKb=
fi

# https://github.com/docker-library/rabbitmq/pull/105#issuecomment-242165822
vmMemoryHighWatermark=
if [ "${RABBITMQ_VM_MEMORY_HIGH_WATERMARK:-}" ]; then
vmMemoryHighWatermark="$(
awk -v lim="$memLimitB" '
/^[0-9]*[.][0-9]+$|^[0-9]+([.][0-9]+)?%$/ {
perc = $0;
if (perc ~ /%$/) {
gsub(/%$/, "", perc);
perc = perc / 100;
}
if (perc > 1.0 || perc <= 0.0) {
printf "error: invalid percentage for vm_memory_high_watermark: %s (must be > 0%%, <= 100%%)\n", $0 > "/dev/stderr";
exit 1;
}
if (lim) {
printf "{ absolute, %d }\n", lim * perc;
} else {
printf "%0.03f\n", perc;
}
next;
}
/^[0-9]+$/ {
printf "{ absolute, %s }\n", $0;
next;
}
/^[0-9]+([.][0-9]+)?[a-zA-Z]+$/ {
printf "{ absolute, \"%s\" }\n", $0;
next;
}
{
printf "error: unexpected input for vm_memory_high_watermark: %s\n", $0;
exit 1;
}
' <(echo "$RABBITMQ_VM_MEMORY_HIGH_WATERMARK")
)"
elif [ -n "$memLimitB" ]; then
# if there is a cgroup limit, default to 40% of _that_ (as recommended by upstream)
vmMemoryHighWatermark="{ absolute, $(( $memLimitB * 40 / 100 )) }"
# otherwise let the default behavior win (40% of the total available)
fi
if [ "$vmMemoryHighWatermark" ]; then
# https://www.rabbitmq.com/memory.html#memsup-usage
rabbitConfig+=( "{ vm_memory_high_watermark, $vmMemoryHighWatermark }" )
fi
elif [ "${RABBITMQ_VM_MEMORY_HIGH_WATERMARK:-}" ]; then
echo >&2 'warning: RABBITMQ_VM_MEMORY_HIGH_WATERMARK was specified, but one of the following is not readable:'
echo >&2 ' - /sys/fs/cgroup/memory/memory.limit_in_bytes'
echo >&2 ' - /proc/meminfo'
echo >&2 '(so "vm_memory_high_watermark" will not be set)'
fi

if [ "$haveSslConfig" ]; then
IFS=$'\n'
rabbitSslOptions=( $(rabbit_env_config 'ssl' "${sslConfigKeys[@]}") )
Expand Down
1 change: 0 additions & 1 deletion 3.6/debian/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ ENV PATH /usr/lib/rabbitmq/bin:$PATH
ENV HOME /var/lib/rabbitmq

RUN mkdir -p /var/lib/rabbitmq /etc/rabbitmq \
&& echo '[ { rabbit, [ { loopback_users, [ ] } ] } ].' > /etc/rabbitmq/rabbitmq.config \
&& chown -R rabbitmq:rabbitmq /var/lib/rabbitmq /etc/rabbitmq \
&& chmod -R 777 /var/lib/rabbitmq /etc/rabbitmq
VOLUME /var/lib/rabbitmq
Expand Down
76 changes: 75 additions & 1 deletion 3.6/debian/docker-entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ rabbitConfigKeys=(
default_user
default_vhost
hipe_compile
vm_memory_high_watermark
)
fileConfigKeys=(
management_ssl_cacertfile
Expand Down Expand Up @@ -95,6 +96,10 @@ for conf in "${allConfigKeys[@]}"; do
var="RABBITMQ_${conf^^}"
val="${!var:-}"
if [ "$val" ]; then
if [ "${configDefaults[$conf]:-}" ] && [ "${configDefaults[$conf]}" = "$val" ]; then
# if the value set is the same as the default, treat it as if it isn't set
continue
fi
haveConfig=1
case "$conf" in
ssl_*) haveSslConfig=1 ;;
Expand Down Expand Up @@ -235,13 +240,82 @@ rabbit_env_config() {
join $'\n' "${ret[@]}"
}

if [ "$1" = 'rabbitmq-server' ] && [ "$haveConfig" ]; then
shouldWriteConfig="$haveConfig"
if [ ! -f /etc/rabbitmq/rabbitmq.config ]; then
shouldWriteConfig=1
fi

if [ "$1" = 'rabbitmq-server' ] && [ "$shouldWriteConfig" ]; then
fullConfig=()

rabbitConfig=(
"{ loopback_users, $(rabbit_array) }"
)

# determine whether to set "vm_memory_high_watermark" (based on cgroups)
if [ -r /sys/fs/cgroup/memory/memory.limit_in_bytes ] && [ -r /proc/meminfo ]; then
memLimitB="$(< /sys/fs/cgroup/memory/memory.limit_in_bytes)"
memLimitKb="$(( memLimitB / 1024 ))"

memTotalKb="$(awk -F ':? +' '$1 == "MemTotal" { print $2; exit }' /proc/meminfo)"

if [ "$memLimitKb" -gt "$memTotalKb" ]; then
memLimitB=
memLimitKb=
fi

# https://github.com/docker-library/rabbitmq/pull/105#issuecomment-242165822
vmMemoryHighWatermark=
if [ "${RABBITMQ_VM_MEMORY_HIGH_WATERMARK:-}" ]; then
vmMemoryHighWatermark="$(
awk -v lim="$memLimitB" '
/^[0-9]*[.][0-9]+$|^[0-9]+([.][0-9]+)?%$/ {
perc = $0;
if (perc ~ /%$/) {
gsub(/%$/, "", perc);
perc = perc / 100;
}
if (perc > 1.0 || perc <= 0.0) {
printf "error: invalid percentage for vm_memory_high_watermark: %s (must be > 0%%, <= 100%%)\n", $0 > "/dev/stderr";
exit 1;
}
if (lim) {
printf "{ absolute, %d }\n", lim * perc;
} else {
printf "%0.03f\n", perc;
}
next;
}
/^[0-9]+$/ {
printf "{ absolute, %s }\n", $0;
next;
}
/^[0-9]+([.][0-9]+)?[a-zA-Z]+$/ {
printf "{ absolute, \"%s\" }\n", $0;
next;
}
{
printf "error: unexpected input for vm_memory_high_watermark: %s\n", $0;
exit 1;
}
' <(echo "$RABBITMQ_VM_MEMORY_HIGH_WATERMARK")
)"
elif [ -n "$memLimitB" ]; then
# if there is a cgroup limit, default to 40% of _that_ (as recommended by upstream)
vmMemoryHighWatermark="{ absolute, $(( $memLimitB * 40 / 100 )) }"
# otherwise let the default behavior win (40% of the total available)
fi
if [ "$vmMemoryHighWatermark" ]; then
# https://www.rabbitmq.com/memory.html#memsup-usage
rabbitConfig+=( "{ vm_memory_high_watermark, $vmMemoryHighWatermark }" )
fi
elif [ "${RABBITMQ_VM_MEMORY_HIGH_WATERMARK:-}" ]; then
echo >&2 'warning: RABBITMQ_VM_MEMORY_HIGH_WATERMARK was specified, but one of the following is not readable:'
echo >&2 ' - /sys/fs/cgroup/memory/memory.limit_in_bytes'
echo >&2 ' - /proc/meminfo'
echo >&2 '(so "vm_memory_high_watermark" will not be set)'
fi

if [ "$haveSslConfig" ]; then
IFS=$'\n'
rabbitSslOptions=( $(rabbit_env_config 'ssl' "${sslConfigKeys[@]}") )
Expand Down