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

NMS-16982: Updating the SCV Page in the Meridian 2023 Docs #7561

Closed
wants to merge 2 commits into from

Conversation

garcia-sr
Copy link
Contributor

All Contributors

Contribution Checklist

  • Please make an issue in the OpenNMS issue tracker if there isn't one already.
    Once there is an issue, please:
    1. update the title of this PR to be in the format: ${JIRA-ISSUE-NUMBER}: subject of pull request
    2. update the Jira link at the bottom of this comment to refer to the real issue number
    3. prefix your commit messages with the issue number, if possible
    4. once you've created this PR, please link to it in a comment in the Jira issue
      Don't worry if this sounds like a lot, we can help you get things set up properly.
  • If this code is likely to affect the UI, did you name your branch with -smoke in it to trigger smoke tests?
  • If this is a new or updated feature, is there documentation for the new behavior?
  • If this is new code, are there unit and/or integration tests?
  • If this PR targets a foundation-* branch, does it try to avoid changing files in $OPENNMS_HOME/etc/?

What's Next?

A PR should be assigned at least 2 reviewers. If you know that someone would be a good person to review your code, feel free to add them.

If you need help making additions or changes to the documentation related to your changes, please let us know.

In any case, if anything is unclear or you want help getting your PR ready for merge, please don't hesitate to say something in the comments here,
or in the #opennms-development chat channel.

Once reviewer(s) accept the PR and the branch passes continuous integration, the PR is eligible for merge.

At that time, if you have commit access (are an OpenNMS Group employee or a member of the OGP) you are welcome to merge the PR when you're ready.
Otherwise, a reviewer can merge it for you.

Thanks for taking time to contribute!

External References

Adding more information to the SCV page. Fixed some spelling issues.
Updating Meta-Data page to show what files can use the SCV metadata tags.
@github-actions github-actions bot added the docs label Dec 11, 2024
@github-actions github-actions bot requested a review from indigo423 December 11, 2024 22:08
@garcia-sr garcia-sr requested a review from dino2gnt December 11, 2024 22:08
@garcia-sr garcia-sr changed the base branch from develop to foundation-2023 December 11, 2024 22:10
@garcia-sr garcia-sr changed the title Updating the SCV Page in the Meridian 2023 Docs NMS-16982: Updating the SCV Page in the Meridian 2023 Docs Dec 11, 2024
Copy link
Contributor

@dino2gnt dino2gnt left a comment

Choose a reason for hiding this comment

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

Content approved, but I can't verify if all the referenced configs have access to the SCV scope in M2023. Maybe Ronny knows?

Copy link
Member

@indigo423 indigo423 left a comment

Choose a reason for hiding this comment

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

Thank you for the improvements!🍻

@@ -108,6 +108,9 @@ The following keys are available under this context:
| interface:if-description
| The SNMP interface description

| interface:if-name
Copy link
Contributor

Choose a reason for hiding this comment

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

if name was only added by this PR #7515 which was added in foundation-2024

* <<deep-dive/alarms/alarm-handling.adoc#ga-advanced-alarm-handling, Alarmd Drools rules>>.

Furthermore, some {page-component-title} configuration files allow the use of Metadata DSL to access the global scope `scv` in order to reference credentials in the Secure Credentials Vault:

Copy link
Contributor

Choose a reason for hiding this comment

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

Are you sure all below configs parse metadata. Poller configs, collector configs I can see that they are supported. Snmp configs I have done it myself. Other configs we have to validate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, you bring up a good point Chandra. I rushed this thinking that all the SCV meta data interpolation stuff would be in this release and it's not. Dino sent me some of the NMS issues where those features were put into place in H33. Which wouldn't be in Meridian 2023.

I'm going to close this issue and re-open it for Foundation 2024 instead.

@garcia-sr
Copy link
Contributor Author

Closing and re-opening for Foundation 2024 instead. Foundation 2023 doesn't have all of the SCV features that 2024 has, so this documentation change will have false information.

@garcia-sr garcia-sr closed this Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants