forked from sonic-net/sonic-buildimage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add container for GNMI (sonic-net#115)
Why I did it We need two containers, one for telemetry, another one for gnmi native write. How I did it Add a new docker, docker-sonic-gnmi How to verify it Build image, and check containers with KVM environment.
- Loading branch information
Showing
22 changed files
with
311 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
{% from "dockers/dockerfile-macros.j2" import install_debian_packages, install_python_wheels, copy_files %} | ||
FROM docker-config-engine-bullseye-{{DOCKER_USERNAME}}:{{DOCKER_USERTAG}} | ||
|
||
ARG docker_container_name | ||
ARG image_version | ||
RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf | ||
|
||
## Make apt-get non-interactive | ||
ENV DEBIAN_FRONTEND=noninteractive | ||
|
||
# Pass the image_version to container | ||
ENV IMAGE_VERSION=$image_version | ||
|
||
RUN apt-get update | ||
|
||
{% if docker_sonic_gnmi_debs.strip() -%} | ||
# Copy locally-built Debian package dependencies | ||
{{ copy_files("debs/", docker_sonic_gnmi_debs.split(' '), "/debs/") }} | ||
|
||
# Install locally-built Debian packages and implicitly install their dependencies | ||
{{ install_debian_packages(docker_sonic_gnmi_debs.split(' ')) }} | ||
{%- endif %} | ||
|
||
RUN apt-get clean -y && \ | ||
apt-get autoclean - && \ | ||
apt-get autoremove -y && \ | ||
rm -rf /debs | ||
|
||
COPY ["start.sh", "gnmi-native.sh", "dialout.sh", "/usr/bin/"] | ||
COPY ["telemetry_vars.j2", "/usr/share/sonic/templates/"] | ||
COPY ["supervisord.conf", "/etc/supervisor/conf.d/"] | ||
COPY ["files/supervisor-proc-exit-listener", "/usr/bin"] | ||
COPY ["critical_processes", "/etc/supervisor"] | ||
|
||
ENTRYPOINT ["/usr/local/bin/supervisord"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
############################################################################### | ||
## Monit configuration for gnmi container | ||
############################################################################### | ||
check program container_memory_telemetry with path "/usr/bin/memory_checker gnmi 419430400" | ||
if status == 3 for 10 times within 20 cycles then exec "/usr/bin/restart_service gnmi" repeat every 2 cycles |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
program:gnmi-native |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/usr/bin/env bash | ||
|
||
# Start with default config | ||
export CVL_SCHEMA_PATH=/usr/sbin/schema | ||
exec /usr/sbin/dialout_client_cli -insecure -logtostderr -v 2 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
#!/usr/bin/env bash | ||
|
||
EXIT_TELEMETRY_VARS_FILE_NOT_FOUND=1 | ||
TELEMETRY_VARS_FILE=/usr/share/sonic/templates/telemetry_vars.j2 | ||
|
||
if [ ! -f "$TELEMETRY_VARS_FILE" ]; then | ||
echo "Telemetry vars template file not found" | ||
exit $EXIT_TELEMETRY_VARS_FILE_NOT_FOUND | ||
fi | ||
|
||
# Try to read telemetry and certs config from ConfigDB. | ||
# Use default value if no valid config exists | ||
TELEMETRY_VARS=$(sonic-cfggen -d -t $TELEMETRY_VARS_FILE) | ||
TELEMETRY_VARS=${TELEMETRY_VARS//[\']/\"} | ||
X509=$(echo $TELEMETRY_VARS | jq -r '.x509') | ||
GNMI=$(echo $TELEMETRY_VARS | jq -r '.gnmi') | ||
CERTS=$(echo $TELEMETRY_VARS | jq -r '.certs') | ||
|
||
TELEMETRY_ARGS=" -logtostderr" | ||
export CVL_SCHEMA_PATH=/usr/sbin/schema | ||
|
||
if [ -n "$CERTS" ]; then | ||
SERVER_CRT=$(echo $CERTS | jq -r '.server_crt') | ||
SERVER_KEY=$(echo $CERTS | jq -r '.server_key') | ||
if [ -z $SERVER_CRT ] || [ -z $SERVER_KEY ]; then | ||
TELEMETRY_ARGS+=" --insecure" | ||
else | ||
TELEMETRY_ARGS+=" --server_crt $SERVER_CRT --server_key $SERVER_KEY " | ||
fi | ||
|
||
CA_CRT=$(echo $CERTS | jq -r '.ca_crt') | ||
if [ ! -z $CA_CRT ]; then | ||
TELEMETRY_ARGS+=" --ca_crt $CA_CRT" | ||
fi | ||
elif [ -n "$X509" ]; then | ||
SERVER_CRT=$(echo $X509 | jq -r '.server_crt') | ||
SERVER_KEY=$(echo $X509 | jq -r '.server_key') | ||
if [ -z $SERVER_CRT ] || [ -z $SERVER_KEY ]; then | ||
TELEMETRY_ARGS+=" --insecure" | ||
else | ||
TELEMETRY_ARGS+=" --server_crt $SERVER_CRT --server_key $SERVER_KEY " | ||
fi | ||
|
||
CA_CRT=$(echo $X509 | jq -r '.ca_crt') | ||
if [ ! -z $CA_CRT ]; then | ||
TELEMETRY_ARGS+=" --ca_crt $CA_CRT" | ||
fi | ||
else | ||
TELEMETRY_ARGS+=" --noTLS" | ||
fi | ||
|
||
# If no configuration entry exists for TELEMETRY, create one default port | ||
if [ -z "$GNMI" ]; then | ||
PORT=8080 | ||
else | ||
PORT=$(echo $GNMI | jq -r '.port') | ||
fi | ||
TELEMETRY_ARGS+=" --port $PORT" | ||
|
||
CLIENT_AUTH=$(echo $GNMI | jq -r '.client_auth') | ||
if [ -z $CLIENT_AUTH ] || [ $CLIENT_AUTH == "false" ]; then | ||
TELEMETRY_ARGS+=" --allow_no_client_auth" | ||
fi | ||
|
||
LOG_LEVEL=$(echo $GNMI | jq -r '.log_level') | ||
if [ ! -z $LOG_LEVEL ]; then | ||
TELEMETRY_ARGS+=" -v=$LOG_LEVEL" | ||
else | ||
TELEMETRY_ARGS+=" -v=2" | ||
fi | ||
|
||
TELEMETRY_ARGS+=" -gnmi_native_write=true" | ||
|
||
exec /usr/sbin/telemetry ${TELEMETRY_ARGS} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
#!/usr/bin/env bash | ||
|
||
if [ "${RUNTIME_OWNER}" == "" ]; then | ||
RUNTIME_OWNER="kube" | ||
fi | ||
|
||
CTR_SCRIPT="/usr/share/sonic/scripts/container_startup.py" | ||
if test -f ${CTR_SCRIPT} | ||
then | ||
${CTR_SCRIPT} -f gnmi -o ${RUNTIME_OWNER} -v ${IMAGE_VERSION} | ||
fi | ||
|
||
mkdir -p /var/sonic | ||
echo "# Config files managed by sonic-config-engine" > /var/sonic/config_status |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
[supervisord] | ||
logfile_maxbytes=1MB | ||
logfile_backups=2 | ||
nodaemon=true | ||
|
||
[eventlistener:dependent-startup] | ||
command=python3 -m supervisord_dependent_startup | ||
autostart=true | ||
autorestart=unexpected | ||
startretries=0 | ||
exitcodes=0,3 | ||
events=PROCESS_STATE | ||
buffer_size=1024 | ||
|
||
[eventlistener:supervisor-proc-exit-listener] | ||
command=/usr/bin/supervisor-proc-exit-listener --container-name telemetry | ||
events=PROCESS_STATE_EXITED,PROCESS_STATE_RUNNING | ||
autostart=true | ||
autorestart=false | ||
buffer_size=1024 | ||
|
||
[program:rsyslogd] | ||
command=/usr/sbin/rsyslogd -n -iNONE | ||
priority=1 | ||
autostart=false | ||
autorestart=true | ||
stdout_logfile=syslog | ||
stderr_logfile=syslog | ||
dependent_startup=true | ||
|
||
[program:start] | ||
command=/usr/bin/start.sh | ||
priority=2 | ||
autostart=false | ||
autorestart=false | ||
startsecs=0 | ||
stdout_logfile=syslog | ||
stderr_logfile=syslog | ||
dependent_startup=true | ||
dependent_startup_wait_for=rsyslogd:running | ||
|
||
[program:gnmi-native] | ||
command=/usr/bin/gnmi-native.sh | ||
priority=3 | ||
autostart=false | ||
autorestart=false | ||
stdout_logfile=syslog | ||
stderr_logfile=syslog | ||
dependent_startup=true | ||
dependent_startup_wait_for=start:exited | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"certs": {% if "certs" in GNMI.keys() %}{{ GNMI["certs"] }}{% else %}""{% endif %}, | ||
"gnmi" : {% if "gnmi" in GNMI.keys() %}{{ GNMI["gnmi"] }}{% else %}""{% endif %}, | ||
"x509" : {% if "x509" in DEVICE_METADATA.keys() %}{{ DEVICE_METADATA["x509"] }}{% else %}""{% endif %} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[Unit] | ||
Description=GNMI container | ||
Requires=database.service | ||
After=database.service swss.service syncd.service | ||
Before=ntp-config.service | ||
BindsTo=sonic.target | ||
After=sonic.target | ||
StartLimitIntervalSec=1200 | ||
StartLimitBurst=3 | ||
|
||
[Service] | ||
User={{ sonicadmin_user }} | ||
ExecStartPre=/usr/local/bin/{{docker_container_name}}.sh start | ||
ExecStart=/usr/local/bin/{{docker_container_name}}.sh wait | ||
ExecStop=/usr/local/bin/{{docker_container_name}}.sh stop | ||
RestartSec=30 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[Unit] | ||
Description=Delays gnmi container until SONiC has started | ||
PartOf=gnmi.service | ||
|
||
[Timer] | ||
OnUnitActiveSec=0 sec | ||
OnBootSec=3min 30 sec | ||
Unit=gnmi.service | ||
|
||
[Install] | ||
WantedBy=timers.target sonic.target sonic-delayed.target |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
service_mgmt.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
|
||
DPATH := $($(DOCKER_GNMI)_PATH) | ||
DEP_FILES := $(SONIC_COMMON_FILES_LIST) rules/docker-gnmi.mk rules/docker-gnmi.dep | ||
DEP_FILES += $(SONIC_COMMON_BASE_FILES_LIST) | ||
DEP_FILES += $(shell git ls-files $(DPATH)) | ||
|
||
$(DOCKER_GNMI)_CACHE_MODE := GIT_CONTENT_SHA | ||
$(DOCKER_GNMI)_DEP_FLAGS := $(SONIC_COMMON_FLAGS_LIST) | ||
$(DOCKER_GNMI)_DEP_FILES := $(DEP_FILES) | ||
|
||
$(eval $(call add_dbg_docker,$(DOCKER_GNMI),$(DOCKER_GNMI_DBG))) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# docker image for gnmi agent | ||
|
||
DOCKER_GNMI_STEM = docker-sonic-gnmi | ||
DOCKER_GNMI = $(DOCKER_GNMI_STEM).gz | ||
DOCKER_GNMI_DBG = $(DOCKER_GNMI_STEM)-$(DBG_IMAGE_MARK).gz | ||
|
||
$(DOCKER_GNMI)_PATH = $(DOCKERS_PATH)/$(DOCKER_GNMI_STEM) | ||
|
||
$(DOCKER_GNMI)_DEPENDS += $(SONIC_MGMT_COMMON) | ||
$(DOCKER_GNMI)_DEPENDS += $(SONIC_TELEMETRY) | ||
$(DOCKER_GNMI)_DBG_DEPENDS = $($(DOCKER_CONFIG_ENGINE_BULLSEYE)_DBG_DEPENDS) | ||
|
||
$(DOCKER_GNMI)_LOAD_DOCKERS += $(DOCKER_CONFIG_ENGINE_BULLSEYE) | ||
|
||
$(DOCKER_GNMI)_VERSION = 1.0.0 | ||
$(DOCKER_GNMI)_PACKAGE_NAME = gnmi | ||
|
||
$(DOCKER_GNMI)_DBG_IMAGE_PACKAGES = $($(DOCKER_CONFIG_ENGINE_BULLSEYE)_DBG_IMAGE_PACKAGES) | ||
|
||
SONIC_DOCKER_IMAGES += $(DOCKER_GNMI) | ||
ifeq ($(INCLUDE_SYSTEM_GNMI), y) | ||
SONIC_INSTALL_DOCKER_IMAGES += $(DOCKER_GNMI) | ||
endif | ||
|
||
SONIC_DOCKER_DBG_IMAGES += $(DOCKER_GNMI_DBG) | ||
ifeq ($(INCLUDE_SYSTEM_GNMI), y) | ||
SONIC_INSTALL_DOCKER_DBG_IMAGES += $(DOCKER_GNMI_DBG) | ||
endif | ||
|
||
$(DOCKER_GNMI)_CONTAINER_NAME = gnmi | ||
$(DOCKER_GNMI)_RUN_OPT += --privileged -t | ||
$(DOCKER_GNMI)_RUN_OPT += -v /etc/sonic:/etc/sonic:ro | ||
$(DOCKER_GNMI)_RUN_OPT += -v /usr/share/sonic/scripts:/usr/share/sonic/scripts:ro | ||
$(DOCKER_GNMI)_RUN_OPT += -v /var/run/dbus:/var/run/dbus:rw | ||
|
||
$(DOCKER_GNMI)_FILES += $(SUPERVISOR_PROC_EXIT_LISTENER_SCRIPT) | ||
$(DOCKER_GNMI)_BASE_IMAGE_FILES += monit_gnmi:/etc/monit/conf.d |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.