[dhcp-relay] make DHCP relay an extension #6531

stepanblyschak · 2021-01-22T15:03:30Z

- Why I did it
Make DHCP relay docker an extension. DHCP relay now carries dhcp relay commands CLI plugin and has a complete manifest.
It is installed as extension if INCLUDE_DHCP_REALY is set to y.

DEPENDS on #5939

- How I did it
Modify DHCP relay docker makefile and dockerfile. Make changes to sonic_debian_extension.j2 to install sonic packages.
I moved DHCP related CLI tests from sonic-utilities to DHCP relay docker.
This PR introduces a way to write a plugin as part of docker image and run the tests from cli-plugin-tests directory under docker directory.
The test result is available in target/docker-dhcp-relay.gz.log:

[ REASON ] :      target/docker-dhcp-relay.gz does not exist   NON-EXISTENT PREREQUISITES: docker-start target/docker-config-engine-buster.gz-load target/python-wheels/sonic_utilities-1.2-py3-none-any.whl-in
stall target/debs/buster/python3-swsscommon_1.0.0_amd64.deb-install
[ FLAGS  FILE    ] : []
[ FLAGS  DEPENDS ] : []
[ FLAGS  DIFF    ] : []
============================= test session starts ==============================
platform linux -- Python 3.7.3, pytest-3.10.1, py-1.7.0, pluggy-0.8.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /sonic/dockers/docker-dhcp-relay/cli-plugin-tests, inifile:
plugins: cov-2.6.0
collecting ... collected 10 items

test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_plugin_registration PASSED [ 10%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_nonexist_vlanid PASSED [ 20%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_vlanid PASSED [ 30%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_ip PASSED [ 40%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_exist_ip PASSED [ 50%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_del_dhcp_relay_dest PASSED [ 60%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_nonexist_dhcp_relay_dest PASSED [ 70%]
test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_dhcp_relay_dest_with_nonexist_vlanid PASSED [ 80%]
test_show_dhcp_relay.py::TestVlanDhcpRelay::test_plugin_registration PASSED [ 90%]
test_show_dhcp_relay.py::TestVlanDhcpRelay::test_dhcp_relay_column_output PASSED [100%]

=============================== warnings summary ===============================
/usr/local/lib/python3.7/dist-packages/tabulate.py:7
  /usr/local/lib/python3.7/dist-packages/tabulate.py:7: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working
    from collections import namedtuple, Iterable

-- Docs: https://docs.pytest.org/en/latest/warnings.html
==================== 10 passed, 1 warnings in 0.35 seconds =====================

- How to verify it
Build it with and without INCLUDE_DHCP_RELAY.

- Which release branch to backport (provide reason below if selected)

201811
201911
202006
202012

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

Previously all docker images built into SONiC binary were tagged with SONiC version string. With the introduction of container upgrades and SONiC extension framework all docker images should have their own version numbers that do not relate with SONiC version. All dockers are tagged with version 1.0.0 in this PR. Whenever changes are introduced to a docker image that require a version change, the docker image maintainer should update the version number. Signed-off-by: Stepan Blyschak <stepanb@nvidia.com>

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…rs_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…rs_version_tags Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…rs_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…rs_manifest

Signed-off-by: Stepan Blyschak <stepanb@nvidia.com>

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…rs_version_tags

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

…c-buildimage into dockers_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

stepanblyschak · 2021-01-22T16:22:07Z

@renukamanavalan @jleveque @tahmed-dev @lguohan @bandaru-viswanath

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

lgtm-com · 2021-07-12T12:56:45Z

This pull request introduces 1 alert when merging 42f8b36 into ba29bd6 - view on LGTM.com

new alerts:

1 for Unused import

stepanblyschak · 2021-07-13T08:41:01Z

/azpw run

mssonicbld · 2021-07-13T08:41:02Z

/AzurePipelines run

azure-pipelines · 2021-07-13T08:41:19Z

Azure Pipelines successfully started running 1 pipeline(s).

stepanblyschak · 2021-07-13T15:30:21Z

Looks like it did not restart 'kvmtest-t1-lag' still failed 20 hours ago:

Azure Pipelines / Azure.sonic-buildimage (Test kvmtest-t1-lag)
failed 20 hours ago in 31m 40s

stepanblyschak · 2021-07-13T15:30:27Z

/azpw run

mssonicbld · 2021-07-13T15:30:29Z

/AzurePipelines run

azure-pipelines · 2021-07-13T15:30:47Z

Azure Pipelines successfully started running 1 pipeline(s).

Makefile.work

renukamanavalan · 2021-07-14T03:12:56Z

files/build_templates/init_cfg.json.j2

@@ -46,7 +45,7 @@
            "has_per_asic_scope": {% if feature + '@.service' in installer_services.split(' ') %}true{% else %}false{% endif %},
            "auto_restart": "{{autorestart}}",
 {%- if include_kubernetes == "y" %}
-{%- if feature in ["dhcp_relay", "lldp", "pmon", "radv", "snmp", "telemetry"] %}
+{%- if feature in ["lldp", "pmon", "radv", "snmp", "telemetry"] %}


How do we ensure that the feature table entry for dhcp_relay has kube as set_owner?

Resolved

renukamanavalan · 2021-07-14T03:15:44Z

rules/docker-dhcp-relay.mk

+
+$(DOCKER_DHCP_RELAY)_DEFAULT_FEATURE_STATE_ENABLED = y
+
+ifeq ($(INSTALL_DEBUG_TOOLS),y)


Does this mean, default build of image (say, make target/sonic-broadcom.bin) will not build dhcp_relay and dhcp_relay docker will not be part of final install image ?

Resolved by Stepan:
_If INCLUDE_KUBERNETES is y then:
https://github.com/Azure/sonic-buildimage/pull/6531/files#diff-040507c367f31f429105c610d067f0a8df05d33edeef4dc40a7de112a4548ea7R34

and then: https://github.com/Azure/sonic-buildimage/blob/master/files/build_templates/sonic_debian_extension.j2#L689_

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

stepanblyschak · 2021-07-14T08:10:22Z

@renukamanavalan "How do we ensure that the feature table entry for dhcp_relay has kube as set_owner?"
If INCLUDE_KUBERNETES is y then:
https://github.com/Azure/sonic-buildimage/pull/6531/files#diff-040507c367f31f429105c610d067f0a8df05d33edeef4dc40a7de112a4548ea7R34

and then: https://github.com/Azure/sonic-buildimage/blob/master/files/build_templates/sonic_debian_extension.j2#L689

stepanblyschak · 2021-07-14T08:11:30Z

@renukamanavalan "Does this mean, default build of image (say, make target/sonic-broadcom.bin) will not build dhcp_relay and dhcp_relay docker will not be part of final install image ?"

It is installed by default and enabled, I don't change that.

lgtm-com · 2021-07-14T08:26:11Z

This pull request introduces 1 alert when merging c86bb45 into f95f8ea - view on LGTM.com

new alerts:

1 for Unused import

rules/docker-dhcp-relay.mk

stepanblyschak · 2021-07-14T16:33:56Z

/azpw run

mssonicbld · 2021-07-14T16:33:57Z

/AzurePipelines run

azure-pipelines · 2021-07-14T16:34:17Z

Azure Pipelines successfully started running 1 pipeline(s).

- Why I did it Make DHCP relay docker an extension. DHCP relay now carries dhcp relay commands CLI plugin and has a complete manifest. It is installed as extension if INCLUDE_DHCP_REALY is set to y. DEPENDS on #5939 - How I did it Modify DHCP relay docker makefile and dockerfile. Make changes to sonic_debian_extension.j2 to install sonic packages. I moved DHCP related CLI tests from sonic-utilities to DHCP relay docker. This PR introduces a way to write a plugin as part of docker image and run the tests from cli-plugin-tests directory under docker directory. The test result is available in target/docker-dhcp-relay.gz.log: [ REASON ] : target/docker-dhcp-relay.gz does not exist NON-EXISTENT PREREQUISITES: docker-start target/docker-config-engine-buster.gz-load target/python-wheels/sonic_utilities-1.2-py3-none-any.whl-in stall target/debs/buster/python3-swsscommon_1.0.0_amd64.deb-install [ FLAGS FILE ] : [] [ FLAGS DEPENDS ] : [] [ FLAGS DIFF ] : [] ============================= test session starts ============================== platform linux -- Python 3.7.3, pytest-3.10.1, py-1.7.0, pluggy-0.8.0 -- /usr/bin/python3 cachedir: .pytest_cache rootdir: /sonic/dockers/docker-dhcp-relay/cli-plugin-tests, inifile: plugins: cov-2.6.0 collecting ... collected 10 items test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_plugin_registration PASSED [ 10%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_nonexist_vlanid PASSED [ 20%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_vlanid PASSED [ 30%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_ip PASSED [ 40%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_exist_ip PASSED [ 50%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_del_dhcp_relay_dest PASSED [ 60%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_nonexist_dhcp_relay_dest PASSED [ 70%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_dhcp_relay_dest_with_nonexist_vlanid PASSED [ 80%] test_show_dhcp_relay.py::TestVlanDhcpRelay::test_plugin_registration PASSED [ 90%] test_show_dhcp_relay.py::TestVlanDhcpRelay::test_dhcp_relay_column_output PASSED [100%] =============================== warnings summary =============================== /usr/local/lib/python3.7/dist-packages/tabulate.py:7 /usr/local/lib/python3.7/dist-packages/tabulate.py:7: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working from collections import namedtuple, Iterable -- Docs: https://docs.pytest.org/en/latest/warnings.html ==================== 10 passed, 1 warnings in 0.35 seconds =====================

…ic-net#7593) Signed-off-by: Stepan Blyschak stepanb@mellanox.com Why I did it To support building DHCP relay as extension and installing it during build time. How I did it Created infrastructure. Users need to define their packages in rules/sonic-packages.mk How to verify it Together with sonic-net#6531

- Why I did it Make DHCP relay docker an extension. DHCP relay now carries dhcp relay commands CLI plugin and has a complete manifest. It is installed as extension if INCLUDE_DHCP_REALY is set to y. DEPENDS on sonic-net#5939 - How I did it Modify DHCP relay docker makefile and dockerfile. Make changes to sonic_debian_extension.j2 to install sonic packages. I moved DHCP related CLI tests from sonic-utilities to DHCP relay docker. This PR introduces a way to write a plugin as part of docker image and run the tests from cli-plugin-tests directory under docker directory. The test result is available in target/docker-dhcp-relay.gz.log: [ REASON ] : target/docker-dhcp-relay.gz does not exist NON-EXISTENT PREREQUISITES: docker-start target/docker-config-engine-buster.gz-load target/python-wheels/sonic_utilities-1.2-py3-none-any.whl-in stall target/debs/buster/python3-swsscommon_1.0.0_amd64.deb-install [ FLAGS FILE ] : [] [ FLAGS DEPENDS ] : [] [ FLAGS DIFF ] : [] ============================= test session starts ============================== platform linux -- Python 3.7.3, pytest-3.10.1, py-1.7.0, pluggy-0.8.0 -- /usr/bin/python3 cachedir: .pytest_cache rootdir: /sonic/dockers/docker-dhcp-relay/cli-plugin-tests, inifile: plugins: cov-2.6.0 collecting ... collected 10 items test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_plugin_registration PASSED [ 10%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_nonexist_vlanid PASSED [ 20%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_vlanid PASSED [ 30%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_invalid_ip PASSED [ 40%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_dhcp_relay_with_exist_ip PASSED [ 50%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_add_del_dhcp_relay_dest PASSED [ 60%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_nonexist_dhcp_relay_dest PASSED [ 70%] test_config_dhcp_relay.py::TestConfigVlanDhcpRelay::test_config_vlan_remove_dhcp_relay_dest_with_nonexist_vlanid PASSED [ 80%] test_show_dhcp_relay.py::TestVlanDhcpRelay::test_plugin_registration PASSED [ 90%] test_show_dhcp_relay.py::TestVlanDhcpRelay::test_dhcp_relay_column_output PASSED [100%] =============================== warnings summary =============================== /usr/local/lib/python3.7/dist-packages/tabulate.py:7 /usr/local/lib/python3.7/dist-packages/tabulate.py:7: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working from collections import namedtuple, Iterable -- Docs: https://docs.pytest.org/en/latest/warnings.html ==================== 10 passed, 1 warnings in 0.35 seconds =====================

stepanblyschak and others added 24 commits November 16, 2020 22:27

[dockers] label SONiC Docker with manifest

954cad9

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[dockers] add package name to manifest

855fa60

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

remove swss dependency from dhcp-relay & router-advertiser

44685ba

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'master' of github.com:azure/sonic-buildimage into docke…

d337e08

…rs_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'master' of github.com:azure/sonic-buildimage into docke…

5eb48a9

…rs_version_tags Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'master' of github.com:azure/sonic-buildimage into docke…

99d9d12

…rs_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

remove sonic-sdk added by mistake in this change

ed1bd3f

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'master' into dockers_version_tags

50237b4

Merge branch 'master' of github.com:azure/sonic-buildimage into docke…

caf5c9e

…rs_manifest

[dhcp-relay] make DHCP relay an extension

9bc4464

Signed-off-by: Stepan Blyschak <stepanb@nvidia.com>

[slave.mk] align lines in dependencies

efc69f5

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'master' of github.com:azure/sonic-buildimage into docke…

31d4bbf

…rs_version_tags

[docker-macsec] add version number for docker-macsec

823eede

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

Merge branch 'dockers_version_tags' of github.com:stepanblyschak/soni…

bdf0113

…c-buildimage into dockers_manifest Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[docker-macsec] add manifest for macsec docker

05df4ed

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[slave.mk] fix missing comma

e966fef

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[slave.mk] fix missing comma

d79293e

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[slave.mk] fix missing comma

a90f9b4

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[sonic_debian_extension.j2] use --enable instead of --enabled

74cd875

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[slave.mk] fix target path

2e5f097

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[docker-dhcp-relay] add cli to docker

e1b2c29

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[docker-dhcp-relay] add cli to docker

db7ef7d

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

stepanblyschak mentioned this pull request Jan 22, 2021

SONiC Application Extension PR Tracker #6398

Open

lguohan added the appext Application Extension label Jan 22, 2021

stepanblyschak added 3 commits January 25, 2021 18:33

[sonic_debian_extension.j2] fix merge conflict markers

e0735d2

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

align install from tarball command

4897003

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

[dockers] use single manifest template

2066aa9

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

tahmed-dev previously approved these changes Jul 13, 2021

View reviewed changes

renukamanavalan reviewed Jul 14, 2021

View reviewed changes

add missing INCLUDE_DHCP_RELAY condition

c86bb45

Signed-off-by: Stepan Blyshchak <stepanb@nvidia.com>

stepanblyschak dismissed tahmed-dev’s stale review via c86bb45 July 14, 2021 08:01

ayurkiv-nvda approved these changes Jul 14, 2021

View reviewed changes

renukamanavalan reviewed Jul 14, 2021

View reviewed changes

rules/docker-dhcp-relay.mk Show resolved Hide resolved

liat-grozovik added the Request for 202106 Branch label Jul 14, 2021

tahmed-dev approved these changes Jul 15, 2021

View reviewed changes

renukamanavalan merged commit b3b6938 into sonic-net:master Jul 15, 2021

vdahiya12 mentioned this pull request Jul 26, 2021

Design document for Y-cable API support for multiple vendors sonic-net/SONiC#757

Merged

judyjoseph added the Included in 202106 Branch label Aug 7, 2021

stepanblyschak deleted the dhcp-relay-ext branch September 23, 2022 13:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dhcp-relay] make DHCP relay an extension #6531

[dhcp-relay] make DHCP relay an extension #6531

stepanblyschak commented Jan 22, 2021 •

edited

Loading

stepanblyschak commented Jan 22, 2021

lgtm-com bot commented Jul 12, 2021

stepanblyschak commented Jul 13, 2021

mssonicbld commented Jul 13, 2021

azure-pipelines bot commented Jul 13, 2021

stepanblyschak commented Jul 13, 2021

stepanblyschak commented Jul 13, 2021

mssonicbld commented Jul 13, 2021

azure-pipelines bot commented Jul 13, 2021

renukamanavalan Jul 14, 2021 •

edited

Loading

renukamanavalan Jul 14, 2021 •

edited

Loading

stepanblyschak commented Jul 14, 2021

stepanblyschak commented Jul 14, 2021

lgtm-com bot commented Jul 14, 2021

stepanblyschak commented Jul 14, 2021

mssonicbld commented Jul 14, 2021

azure-pipelines bot commented Jul 14, 2021


		$(DOCKER_DHCP_RELAY)_DEFAULT_FEATURE_STATE_ENABLED = y

		ifeq ($(INSTALL_DEBUG_TOOLS),y)

[dhcp-relay] make DHCP relay an extension #6531

[dhcp-relay] make DHCP relay an extension #6531

Conversation

stepanblyschak commented Jan 22, 2021 • edited Loading

stepanblyschak commented Jan 22, 2021

lgtm-com bot commented Jul 12, 2021

stepanblyschak commented Jul 13, 2021

mssonicbld commented Jul 13, 2021

azure-pipelines bot commented Jul 13, 2021

stepanblyschak commented Jul 13, 2021

stepanblyschak commented Jul 13, 2021

mssonicbld commented Jul 13, 2021

azure-pipelines bot commented Jul 13, 2021

renukamanavalan Jul 14, 2021 • edited Loading

Choose a reason for hiding this comment

renukamanavalan Jul 14, 2021 • edited Loading

Choose a reason for hiding this comment

stepanblyschak commented Jul 14, 2021

stepanblyschak commented Jul 14, 2021

lgtm-com bot commented Jul 14, 2021

stepanblyschak commented Jul 14, 2021

mssonicbld commented Jul 14, 2021

azure-pipelines bot commented Jul 14, 2021

stepanblyschak commented Jan 22, 2021 •

edited

Loading

renukamanavalan Jul 14, 2021 •

edited

Loading

renukamanavalan Jul 14, 2021 •

edited

Loading