Skip to content
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.

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

Showtech sonic mgmt framework: Add Management Framework functionality for "show tech-support" #49

Merged

Conversation

kerry-meyer
Copy link
Contributor

@kerry-meyer kerry-meyer commented Jun 8, 2021

Provide the changes required for supporting the "show-techsupport" command via the SONiC Management Framework front end mechanisms (CLI, REST, and gNOI). The Management Framework functionality implemented by this PR improves on the the capabilities currently provided by the SONiC Click CLI interface via the "show techsupport" command by providing the following additional features:

  • User-friendly "help" information describing command syntax details for CLI invocation.
  • Ability to invoke the command via REST and gNOI mechanisms.

Unit test results are attached to this PR.

unit_test_log_0607.txt

Corequisite PRs:

sonic-net/sonic-telemetry#78
sonic-net/sonic-telemetry#79

…eld.

These changes make use of an additional output field for the "show
tech-support" command. The corresponding output-status leaf is added
to the set of output leaves in the Yang definition for the
sonic-show-techsupport module. This additional field is specified
in the SONiC Community HLD for the Management Framework "show tech-support"
feature, but was not present in the initial implementation of the feature.

The purpose of the additional field is to provide an indication of
"success" or detailed failure  status that is separate from the
output-filename field. With this change, the output-filename contains
either an output filename or a null string, and is no longer used to
describe errors in the event of a failure.
@anshuv-mfst
Copy link

Hi @renukamanavalan - could you please review and merge, thanks

@renukamanavalan renukamanavalan requested a review from jleveque June 22, 2021 16:37
@leeprecy
Copy link

reviewed

@@ -0,0 +1,17 @@
module sonic-showtech-annot {
Copy link
Contributor

Choose a reason for hiding this comment

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

why these yang model not in sonic-yang-model in build image?

Copy link

@venkatmahalingam venkatmahalingam Nov 23, 2021

Choose a reason for hiding this comment

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

We use RPC (to invoke internal Click command via d-bus infra) for show-tech operation from mgmt-framework and no config-DB update here and hence no YANG model is present in sonic-yang-model in build image.

@renukamanavalan
Copy link

Looks good to me.

This file contained commented out code to provide examples of synchronous and asynchronous invocation of the "HostQuery" and "HostQueryAsync" functions.

The examples are being deleted from this file to eliminate a block of commented out code. The equivalent information should, instead, be provided in the "SONiC_Host_Services_Developer_Guide" document.
@renukamanavalan
Copy link

@sujinmkang, Can you please help with the review?
It looks good to me,

renukamanavalan pushed a commit to sonic-net/sonic-mgmt-framework that referenced this pull request Jan 20, 2022
… for "show tech-support" (#86)

Provide the changes required for supporting the "show-techsupport" command via the SONiC Management Framework front end mechanisms (CLI, REST, and gNOI). The Management Framework functionality implemented by this PR improves on the the capabilities currently provided by the SONiC Click CLI interface via the "show techsupport" command by providing the following additional features:

User-friendly "help" information describing command syntax details for CLI invocation.
Ability to invoke the command via REST and gNOI mechanisms.
Unit test results are attached to this PR.

unit_test_log_0607.txt

Corequisite PRs:
sonic-net/sonic-mgmt-common#49
@renukamanavalan renukamanavalan merged commit 5156527 into sonic-net:master Jan 20, 2022
dell-engops pushed a commit to project-arlo/sonic-mgmt-common that referenced this pull request Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants