[dhcp-relay] make DHCP relay an extension

.gitignore

@@ -20,13 +20,18 @@ target/
 *-dbg
 *dbg.j2
 *.img
+*.pyc
 
 # Autogenerated Dockerfiles
 sonic-slave*/Dockerfile
 sonic-slave*/Dockerfile.user
 dockers/*/Dockerfile
 platform/*/docker-*/Dockerfile
 
+# Autogenerated manifest files
+dockers/*/manifest.json
+platform/*/docker-*/manifest.json
+
 # Installer-related files and directories
 installer/x86_64/platforms/
 

Makefile.work

@@ -241,6 +241,7 @@ SONIC_BUILD_INSTRUCTION :=  make \
                            HTTP_PROXY=$(http_proxy) \
                            HTTPS_PROXY=$(https_proxy) \
                            SONIC_INCLUDE_SYSTEM_TELEMETRY=$(INCLUDE_SYSTEM_TELEMETRY) \
+                           INCLUDE_DHCP_RELAY=$(INCLUDE_DHCP_RELAY) \
                            SONIC_INCLUDE_RESTAPI=$(INCLUDE_RESTAPI) \
                            TELEMETRY_WRITABLE=$(TELEMETRY_WRITABLE) \
                            EXTRA_DOCKER_TARGETS=$(EXTRA_DOCKER_TARGETS) \

dockers/docker-database/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -60,4 +62,6 @@ COPY ["critical_processes", "/etc/supervisor"]
 COPY ["files/update_chassisdb_config", "/usr/local/bin/"]
 COPY ["flush_unused_database", "/usr/local/bin/"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/docker-database-init.sh"]

dockers/docker-dhcp-relay/Dockerfile.j2

@@ -3,6 +3,8 @@ FROM docker-config-engine-buster
 
 ARG docker_container_name
 ARG image_version
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -32,5 +34,8 @@ COPY ["docker_init.sh", "start.sh", "/usr/bin/"]
 COPY ["docker-dhcp-relay.supervisord.conf.j2", "port-name-alias-map.txt.j2", "wait_for_intf.sh.j2", "/usr/share/sonic/templates/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
+COPY ["cli", "/cli/"]
+
+LABEL com.azure.sonic.manifest="$manifest"
 
 ENTRYPOINT ["/usr/bin/docker_init.sh"]

dockers/docker-dhcp-relay/cli/config/plugins/dhcp_relay.py

@@ -0,0 +1,84 @@
+import click
+import utilities_common.cli as clicommon
+
+@click.group(cls=clicommon.AbbreviationGroup, name='dhcp_relay')
+def vlan_dhcp_relay():
+    pass
+
+@vlan_dhcp_relay.command('add')
+@click.argument('vid', metavar='<vid>', required=True, type=int)
+@click.argument('dhcp_relay_destination_ip', metavar='<dhcp_relay_destination_ip>', required=True)
+@clicommon.pass_db
+def add_vlan_dhcp_relay_destination(db, vid, dhcp_relay_destination_ip):
+    """ Add a destination IP address to the VLAN's DHCP relay """
+
+    ctx = click.get_current_context()
+
+    if not clicommon.is_ipaddress(dhcp_relay_destination_ip):
+        ctx.fail('{} is invalid IP address'.format(dhcp_relay_destination_ip))
+
+    vlan_name = 'Vlan{}'.format(vid)
+    vlan = db.cfgdb.get_entry('VLAN', vlan_name)
+    if len(vlan) == 0:
+        ctx.fail("{} doesn't exist".format(vlan_name))
+
+    dhcp_relay_dests = vlan.get('dhcp_servers', [])
+    if dhcp_relay_destination_ip in dhcp_relay_dests:
+        click.echo("{} is already a DHCP relay destination for {}".format(dhcp_relay_destination_ip, vlan_name))
+        return
+
+    dhcp_relay_dests.append(dhcp_relay_destination_ip)
+    vlan['dhcp_servers'] = dhcp_relay_dests
+    db.cfgdb.set_entry('VLAN', vlan_name, vlan)
+    click.echo("Added DHCP relay destination address {} to {}".format(dhcp_relay_destination_ip, vlan_name))
+    try:
+        click.echo("Restarting DHCP relay service...")
+        clicommon.run_command("systemctl stop dhcp_relay", display_cmd=False)
+        clicommon.run_command("systemctl reset-failed dhcp_relay", display_cmd=False)
+        clicommon.run_command("systemctl start dhcp_relay", display_cmd=False)
+    except SystemExit as e:
+        ctx.fail("Restart service dhcp_relay failed with error {}".format(e))
+
+@vlan_dhcp_relay.command('del')
+@click.argument('vid', metavar='<vid>', required=True, type=int)
+@click.argument('dhcp_relay_destination_ip', metavar='<dhcp_relay_destination_ip>', required=True)
+@clicommon.pass_db
+def del_vlan_dhcp_relay_destination(db, vid, dhcp_relay_destination_ip):
+    """ Remove a destination IP address from the VLAN's DHCP relay """
+
+    ctx = click.get_current_context()
+
+    if not clicommon.is_ipaddress(dhcp_relay_destination_ip):
+        ctx.fail('{} is invalid IP address'.format(dhcp_relay_destination_ip))
+
+    vlan_name = 'Vlan{}'.format(vid)
+    vlan = db.cfgdb.get_entry('VLAN', vlan_name)
+    if len(vlan) == 0:
+        ctx.fail("{} doesn't exist".format(vlan_name))
+
+    dhcp_relay_dests = vlan.get('dhcp_servers', [])
+    if not dhcp_relay_destination_ip in dhcp_relay_dests:
+        ctx.fail("{} is not a DHCP relay destination for {}".format(dhcp_relay_destination_ip, vlan_name))
+
+    dhcp_relay_dests.remove(dhcp_relay_destination_ip)
+    if len(dhcp_relay_dests) == 0:
+        del vlan['dhcp_servers']
+    else:
+        vlan['dhcp_servers'] = dhcp_relay_dests
+    db.cfgdb.set_entry('VLAN', vlan_name, vlan)
+    click.echo("Removed DHCP relay destination address {} from {}".format(dhcp_relay_destination_ip, vlan_name))
+    try:
+        click.echo("Restarting DHCP relay service...")
+        clicommon.run_command("systemctl stop dhcp_relay", display_cmd=False)
+        clicommon.run_command("systemctl reset-failed dhcp_relay", display_cmd=False)
+        clicommon.run_command("systemctl start dhcp_relay", display_cmd=False)
+    except SystemExit as e:
+        ctx.fail("Restart service dhcp_relay failed with error {}".format(e))
+
+
+def register(cli):
+    cli.commands['vlan'].add_command(vlan_dhcp_relay)
+
+
+if __name__ == '__main__':
+    vlan_dhcp_relay()

dockers/docker-dhcp-relay/cli/show/plugins/dhcp_relay.py

@@ -0,0 +1,22 @@
+from natsort import natsorted
+from .. import vlan
+
+
+def get_dhcp_helper_address(ctx, vlan):
+    cfg, _ = ctx
+    vlan_dhcp_helper_data, _, _ = cfg
+    vlan_config = vlan_dhcp_helper_data.get(vlan)
+    if not vlan_config:
+        return ""
+
+    dhcp_helpers = vlan_config.get('dhcp_servers', [])
+
+    return '\n'.join(natsorted(dhcp_helpers))
+
+
+vlan.VlanBrief.COLUMNS.append(('DHCP Helper Address', get_dhcp_helper_address))
+
+
+def register(cli):
+    pass
+

dockers/docker-fpm-frr/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 ARG frr_user_uid
 ARG frr_user_gid
 
@@ -59,4 +61,6 @@ RUN chmod a+x /usr/bin/TSA && \
     chmod a+x /usr/bin/TSB && \
     chmod a+x /usr/bin/TSC
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/bin/docker_init.sh"]

dockers/docker-fpm-gobgp/Dockerfile.j2

@@ -1,5 +1,8 @@
 FROM docker-fpm-quagga
 
+ARG docker_container_name
+ARG manifest
+
 ## Make apt-get non-interactive
 ENV DEBIAN_FRONTEND=noninteractive
 
@@ -27,4 +30,6 @@ COPY ["daemons", "/etc/quagga/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-fpm-quagga/Dockerfile.j2

@@ -1,6 +1,8 @@
 FROM docker-config-engine
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -36,4 +38,6 @@ COPY ["*.j2", "/usr/share/sonic/templates/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-iccpd/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 ## Make apt-get non-interactive
@@ -31,4 +33,6 @@ RUN apt-get clean -y      && \
     apt-get autoremove -y && \
     rm -rf /debs
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-lldp/Dockerfile.j2

@@ -2,7 +2,9 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
 ARG image_version
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -49,4 +51,6 @@ COPY ["lldpmgrd", "/usr/bin/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/bin/docker-lldp-init.sh"]

dockers/docker-nat/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 RUN echo
@@ -35,4 +37,6 @@ COPY ["critical_processes", "/etc/supervisor"]
 RUN apt-get clean -y; apt-get autoclean -y; apt-get autoremove -y
 RUN rm -rf /debs
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-orchagent/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -75,4 +77,6 @@ COPY ["critical_processes", "/etc/supervisor/"]
 # Copy all Jinja2 template files into the templates folder
 COPY ["*.j2", "/usr/share/sonic/templates/"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/bin/docker-init.sh"]

dockers/docker-platform-monitor/Dockerfile.j2

@@ -2,7 +2,9 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
 ARG image_version
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -91,4 +93,6 @@ COPY ["ssd_tools/*", "/usr/bin/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/bin/docker_init.sh"]

dockers/docker-router-advertiser/Dockerfile.j2

@@ -2,7 +2,9 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
 ARG image_version
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Make apt-get non-interactive
@@ -37,4 +39,6 @@ COPY ["radvd.conf.j2", "wait_for_link.sh.j2", "docker-router-advertiser.supervis
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/bin/docker-init.sh"]

dockers/docker-sflow/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 ## Make apt-get non-interactive
@@ -32,4 +34,6 @@ COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 COPY ["port_index_mapper.py", "/usr/bin"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-snmp/Dockerfile.j2

@@ -2,7 +2,9 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
 ARG image_version
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 # Enable -O for all Python calls
@@ -77,4 +79,6 @@ COPY ["critical_processes", "/etc/supervisor"]
 # Although exposing ports is not needed for host net mode, keep it for possible bridge mode
 EXPOSE 161/udp 162/udp
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-sonic-mgmt-framework/Dockerfile.j2

@@ -1,6 +1,8 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 ## Make apt-get non-interactive
@@ -53,4 +55,6 @@ RUN apt-get remove -y g++ python3-dev
 RUN apt-get clean -y; apt-get autoclean -y; apt-get autoremove -y
 RUN rm -rf /debs
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-sonic-restapi/Dockerfile.j2

@@ -2,6 +2,8 @@
 FROM docker-config-engine-stretch
 
 ARG docker_container_name
+ARG manifest
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 ## Make apt-get non-interactive
@@ -25,4 +27,6 @@ COPY ["supervisord.conf", "/etc/supervisor/conf.d/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

dockers/docker-sonic-telemetry/Dockerfile.j2

@@ -2,7 +2,9 @@
 FROM docker-config-engine-buster
 
 ARG docker_container_name
+ARG manifest
 ARG image_version
+
 RUN [ -f /etc/rsyslog.conf ] && sed -ri "s/%syslogtag%/$docker_container_name#%syslogtag%/;" /etc/rsyslog.conf
 
 ## Make apt-get non-interactive
@@ -32,4 +34,6 @@ COPY ["supervisord.conf", "/etc/supervisor/conf.d/"]
 COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]