Skip to content

Expanding the manifest capabilities #2952

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.

Sign up for GitHub

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

Open
azmy98 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Expanding the manifest capabilities #2952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51479cb
Expanding the manifest capabilities to include
azmyali98 Aug 23, 2023
93e1bef
Merge branch 'master' into manifest_enhancement
azmyali98 Nov 26, 2024
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
2 changes: 2 additions & 0 deletions sonic_package_manager/manifest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ def unmarshal(self, value):
ManifestRoot('container', [
ManifestField('privileged', DefaultMarshaller(bool), False),
ManifestArray('volumes', DefaultMarshaller(str)),
ManifestField('network', DefaultMarshaller(str), ''),
ManifestArray('ports', DefaultMarshaller(str)),
ManifestArray('mounts', ManifestRoot('mounts', [
ManifestField('source', DefaultMarshaller(str)),
ManifestField('target', DefaultMarshaller(str)),
Expand Down
12 changes: 12 additions & 0 deletions sonic_package_manager/service_creator/creator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ def generate_container_mgmt(self, package: Package):
image_id = package.image_id
name = package.manifest['service']['name']
container_spec = package.manifest['container']
is_asic_service = package.manifest['service']['asic-service']
script_path = os.path.join(DOCKER_CTL_SCRIPT_LOCATION, f'{name}.sh')
script_template = get_tmpl_path(DOCKER_CTL_SCRIPT_TEMPLATE)
run_opt = []
Expand All @@ -237,6 +238,17 @@ def generate_container_mgmt(self, package: Package):

run_opt.append('-t')

if not is_asic_service:
if container_spec['network']:
docker_network_type = container_spec['network']
run_opt.append(f'--net={docker_network_type}')
else:
if container_spec['network'] != 'none':
raise ServiceCreatorError(f"Invalid Configuration, asic-service must not contain network type")
Copy link
Copy Markdown
Contributor

@qiluo-msft qiluo-msft Aug 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not contain network type

empty value means default value. It is not proper to enforce empty value only.

Copy link
Copy Markdown
Author

@azmy98 azmy98 Aug 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But ASIC services should not have network specified. This comment was given by the NVIDIA SONiC team. I am missing something?

Copy link
Copy Markdown
Contributor

@qiluo-msft qiluo-msft Sep 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe none? ref: https://docs.docker.com/engine/network/

Copy link
Copy Markdown
Author

@azmy98 azmy98 Sep 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you suggest? to enforce the none as the docker_network_type like this
run_opt.append(f'--net=none')

Copy link
Copy Markdown
Contributor

@qiluo-msft qiluo-msft Sep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, let me clarify:

  1. container_spec['network'] should have default value bridge. ie. if it is None, treat it as bridge.
  2. I do not propose to append run_opt, always respect user config
  3. if is_asic_service and container_spec['network'] != none, you can raise an exception.

Copy link
Copy Markdown
Author

@azmy98 azmy98 Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, but this is what I do in this if and else that i added.
for point 3, if the container_spec['network'] is None I raise exception, am I missing something?

Copy link
Copy Markdown
Author

@azmy98 azmy98 Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you suggesting to do explicitly container_spec['network'] != 'none'?

Copy link
Copy Markdown
Contributor

@qiluo-msft qiluo-msft Sep 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes


for port in container_spec['ports']:
run_opt.append(f'--publish {port}')

for volume in container_spec['volumes']:
run_opt.append(f'-v {volume}')

Expand Down
15 changes: 15 additions & 0 deletions tests/sonic_package_manager/test_service_creator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ def manifest():
},
'container': {
'privileged': True,
'network': 'bridge',
'ports': [
"8080:8080"
],
'volumes': [
'/etc/sonic:/etc/sonic:ro'
]
Expand Down Expand Up @@ -119,6 +123,17 @@ def read_file(name):
assert set(generated_services_conf_content.split()) == set(['test.service', 'test@.service'])


def test_service_creator_asic_service_network_type_err(sonic_fs, manifest, service_creator, package_manager):
new_manifest = copy.deepcopy(manifest)
new_manifest['service']['asic-service'] = True
entry = PackageEntry('test', 'azure/sonic-test')
package = Package(entry, Metadata(new_manifest))
installed_packages = package_manager._get_installed_packages_and(package)

with pytest.raises(ServiceCreatorError) as e:
service_creator.create(package)


def test_service_creator_with_timer_unit(sonic_fs, manifest, service_creator):
entry = PackageEntry('test', 'azure/sonic-test')
package = Package(entry, Metadata(manifest))
Expand Down