[dockers] label SONiC Docker with manifest

.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/
 

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
@@ -33,4 +35,6 @@ COPY ["docker-dhcp-relay.supervisord.conf.j2", "port-name-alias-map.txt.j2", "wa
 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-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
 
@@ -61,4 +63,6 @@ RUN chmod a+x /usr/bin/TSA && \
     chmod a+x /usr/bin/TSC && \
     chmod a+x /usr/bin/zsocket.sh
 
+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-macsec/Dockerfile.j2

@@ -2,6 +2,7 @@
 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
@@ -28,4 +29,6 @@ COPY ["files/supervisor-proc-exit-listener", "/usr/bin"]
 COPY ["critical_processes", "/etc/supervisor"]
 COPY ["etc/wpa_supplicant.conf", "/etc/wpa_supplicant.conf"]
 
+LABEL com.azure.sonic.manifest="$manifest"
+
 ENTRYPOINT ["/usr/local/bin/supervisord"]

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
@@ -90,4 +92,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"]

dockers/docker-teamd/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
@@ -27,4 +29,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"]

files/build_templates/manifest.json.j2

@@ -0,0 +1,27 @@
+{
+    "version": "1.0.0",
+    "package": {
+        "version": "{{ version }}",
+        "base-os-contraint": "^{{ base_os_ver.split('.')[0] }}.0.0",
+        "depends": {{ depends.split()|json if depends is defined else []}},
+        "name": "{{ package_name }}"
+    },
+    "service": {
+        "name": "{{ name }}",
+        "requires": {{ requires.split()|json if requires is defined else [] }},
+        "after": {{ after.split()|json if after is defined else [] }},
+        "before": {{ before.split()|json if before is defined else [] }},
+        "dependent-of": {{ dependent_of.split()|json if dependent_of is defined else [] }},
+        "asic-service": {{ asic_service }},
+        "host-service": {{ host_service }}
+    },
+    "container": {
+        "privileged": {{ privileged if privileged else 'false' }},
+        "volumes": {{ volumes.split()|json if volumes is defined else [] }},
+        "tmpfs": {{ tmpfs.split()|json if tmpfs is defined else [] }}
+    },
+    "cli": {
+        "config": "{{ config_cli_plugin|default('') }}",
+        "show": "{{ show_cli_plugin|default('') }}"
+    }
+}

files/build_templates/packages.json.j2

@@ -0,0 +1,17 @@
+{
+{% for docker_installation_target in installer_images.strip().split() -%}
+{% set pkgname, docker_build_path, image = docker_installation_target.split('|') -%}
+{% set imagefilepath = image.split(':')|first -%}
+{% set imageversion = image.split(':')|last -%}
+{% set imagefilename = imagefilepath.split('/')|last -%}
+{% set imagename = imagefilename.split('.')|first -%}
+    "{{ pkgname }}": {
+        "repository": "{{ imagename }}",
+        "description": "SONiC {{ pkgname }} package",
+        "default-reference": "{{ imageversion }}",
+        "installed-version": "{{ imageversion }}",
+        "built-in": true,
+        "installed": true
+    }{% if not loop.last %},{% endif %}
+{% endfor %}
+}

files/build_templates/sonic_debian_extension.j2

@@ -597,18 +597,32 @@ sudo mount proc /proc -t proc
 sudo mkdir $FILESYSTEM_ROOT/target
 sudo mount --bind target $FILESYSTEM_ROOT/target
 sudo chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS info
-{% for image in installer_images.strip().split(' ') -%}
-{% set imagefilename = image.split('/')|last -%}
+
+{% for docker_installation_target in installer_images.strip().split() -%}
+{% set pkgname, docker_build_path, image = docker_installation_target.split('|') %}
+{% set imagefilepath = image.split(':')|first -%}
+{% set imagefilename = imagefilepath.split('/')|last -%}
 {% set imagename = imagefilename.split('.')|first -%}
-sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS load -i {{image}}
+sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS load -i {{imagefilepath}}
 sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS tag {{imagename}}:latest {{imagename}}:"${SONIC_IMAGE_VERSION}"
+# Check if manifest exists for {{imagename}} and it is a valid JSON
+sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS inspect {{imagename}}:latest \
+    | jq '.[0].Config.Labels["com.azure.sonic.manifest"]' -r > /tmp/manifest.json
+jq -e . /tmp/manifest.json || {
+    >&2 echo "docker image {{imagename}} has no manifest or manifest is not a valid JSON"
+    exit 1
+}
 {% if imagename.endswith('-dbg') %}
 {% set imagebasename = imagename.replace('-dbg', '') -%}
 sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS tag {{imagename}}:latest {{imagebasename}}:"${SONIC_IMAGE_VERSION}"
 sudo LANG=C chroot $FILESYSTEM_ROOT docker $SONIC_NATIVE_DOCKERD_FOR_DOCKERFS tag {{imagename}}:latest {{imagebasename}}:latest
 {% endif %}
 {% endfor %}
 
+SONIC_PACKAGE_MANAGER_FOLDER="/var/lib/sonic-package-manager/"
+sudo mkdir -p $FILESYSTEM_ROOT/$SONIC_PACKAGE_MANAGER_FOLDER
+j2 $BUILD_TEMPLATES/packages.json.j2 | sudo tee $FILESYSTEM_ROOT/$SONIC_PACKAGE_MANAGER_FOLDER/packages.json
+
 # Copy docker_image_ctl.j2 for SONiC Package Manager
 sudo cp $BUILD_TEMPLATES/docker_image_ctl.j2 $FILESYSTEM_ROOT_USR_SHARE_SONIC_TEMPLATES/docker_image_ctl.j2