22.5.1 released

nokia · May 20, 2022 · 67aee00 · 67aee00
1 parent bb93dc5
commit 67aee00
Show file tree

Hide file tree

Showing 16 changed files with 224 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,12 @@ Copyright 2021 Nokia.
 
 The license is located [here](LICENSE.md).
 
+## Reporting issues ##
+
+Issues, suggestions, and enhancements are welcome.  Please use the Nokia support
+process.  Issues raised in GitHub may be considered for inclusion into the project 
+by Nokia.  Pull requests are not accepted.
+
 ## Installation ##
 
 Multiple installation methods are available:
@@ -109,3 +115,10 @@ these include:
 - singlehtml
 - man
 - text
+
+
+## Further reading and assistance ##
+
+- [Nokia product documentation](https://documentation.nokia.com)
+- [Technical support](https://customer.nokia.com/support/s/)
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,15 +1,3 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
 sys.path.insert(0, os.path.relpath('../'))
@@ -22,15 +10,12 @@
 author = 'Nokia'
 
 # The full version, including alpha/beta/rc tags
-version = '22.2.1'
-release = '22.2.1'
+version = '22.5.1'
+release = '22.5.1'
 
 
 # -- General configuration ---------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [ 'sphinx.ext.autodoc',
                'sphinx.ext.autosectionlabel',
                'sphinx.ext.autosummary',
@@ -45,7 +30,6 @@
     }
 
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # List of patterns, relative to source directory, that match files and
@@ -61,14 +45,7 @@
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 html_logo = "_static/nokia-logo-white-on-blue.png"
 

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -19,7 +19,7 @@ pySROS libraries.
 pySROS data structures
 ######################
 
-Having made a connection to an SR OS device it is important to understand the data structures returned by the
+Having made a connection to an SR OS device, it is important to understand the data structures returned by the
 :py:meth:`pysros.management.Datastore.get` function and those that can be sent to a router using
 :py:meth:`pysros.management.Datastore.set`.
 

diff --git a/docs/source/features.rst b/docs/source/features.rst
@@ -0,0 +1,10 @@
+============
+New features
+============
+
+.. toctree::
+   :maxdepth: 3
+   :glob:
+   :reversed:
+
+   features/*
diff --git a/docs/source/features/22.2.rst b/docs/source/features/22.2.rst
@@ -0,0 +1,19 @@
+Release 22.2
+************
+
+22.2.2
+######
+
+
+22.2.1
+######
+
+* Performance improvements for connections when the YANG
+  schema has already been generated.
+* :py:meth:`pysros.management.Datastore.get_list_keys` method
+  introduced.
+
+.. Reviewed by PLM 20220316
+
+
+
diff --git a/docs/source/features/22.5.rst b/docs/source/features/22.5.rst
@@ -0,0 +1,14 @@
+Release 22.5
+************
+
+22.5.1
+######
+
+* Introduction of new feature announcements in this documentation (backdated to release 22.2.1)
+
+.. Reviewed by PLM 20220503
+.. Reviewed by TechComms 20220503
+
+
+
+
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
@@ -1,6 +1,6 @@
-********
-Glossary
-********
+***********************
+Glossary and assistance
+***********************
 
 Glossary of terms
 #################
@@ -16,9 +16,14 @@ Glossary of terms
    NETCONF
       Network Configuration protocol
 
+.. Reviewed by PLM 20220303
+.. Reviewed by TechComms 20220503
 
-References
-##########
+Additional assistance
+#####################
+
+Further reading
+***************
 
 .. seealso::
 
@@ -37,7 +42,18 @@ References
    `Nokia Network Developer Portal <https://network.developer.nokia.com>`_
       Additional resources for developing with SR OS
 
+   `Nokia product documentation <https://documentation.nokia.com>`_
+      Product documentation
+
+.. Reviewed by PLM 20220303
+.. Reviewed by TechComms 20220503
+
+Support and feedback
+********************
+
+* `Nokia technical support portal <https://customer.nokia.com/support/s/>`_
+* `Documentation feedback <mailto:[email protected]>`_
 
-.. Reviewed by PLM 20210902
-.. Reviewed by TechComms 20210902
+.. Reviewed by PLM 20220303
+.. Reviewed by TechComms 20220503
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -16,11 +16,11 @@ documentation will be updated accordingly.
 .. list-table::
    :header-rows: 0
 
-   * - pySROS release: 22.2.1
-   * - Document Number: 3HE 18378 AAAA TQZZA
+   * - pySROS release: 22.5.1
+   * - Document Number: 3HE 18378 AAAC TQZZA
 
-.. Reviewed by PLM 20220125
-.. Reviewed by TechComms 20220125
+.. Reviewed by PLM 20220303
+.. Reviewed by TechComms 20220503
 
 
 .. toctree::
@@ -31,6 +31,7 @@ documentation will be updated accordingly.
    examples
    modules
    glossary
+   features
 
 
 

diff --git a/examples/show_port_counters.py b/examples/show_port_counters.py
@@ -20,9 +20,8 @@
 
 This application to display system information demonstrates how to parse
 different arguments depending on if the application is running locally or
-remotely.  It also demonstrates how to print table headers in a different
-language.  The state element names and text values are displayed in English,
-since this how they appear in the state datastore.
+remotely.  It also demonstrates how to print table headers and element names
+in a different language.
 
 Add the following alias so that the Python application can be run as a
 native MD-CLI command.
@@ -463,7 +462,6 @@ def show_port_counters_output(connection_object, language):
         print_row_with_spacing(
             local_str["spacer"][language], width, local_str["Port"][language], str(port)
         )
-        print("-" * 80)
 
         # Print oper-state values
         print_row_with_spacing(
@@ -544,60 +542,113 @@ def show_port_counters_output(connection_object, language):
             print_row_with_spacing(
                 local_str["spacer"][language],
                 width,
-                local_str["in-multicast-packets"][language],
-                port_stats[port]["statistics"]["in-multicast-packets"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["in-unicast-packets"][language],
-                port_stats[port]["statistics"]["in-unicast-packets"].data,
+                local_str["counter-discontinuity-time"][language],
+                str(port_stats[port]["statistics"]["counter-discontinuity-time"].data),
             )
 
-            # Print output statistics
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-discards"][language],
-                port_stats[port]["statistics"]["out-discards"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-errors"][language],
-                port_stats[port]["statistics"]["out-errors"].data,
-            )
+        # last-cleared-time is a conditional state leaf, check existence
+        if "last-cleared-time" in port_stats[port]["statistics"]:
             print_row_with_spacing(
                 local_str["spacer"][language],
                 width,
-                local_str["out-octets"][language],
-                port_stats[port]["statistics"]["out-octets"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-packets"][language],
-                port_stats[port]["statistics"]["out-packets"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-broadcast-packets"][language],
-                port_stats[port]["statistics"]["out-broadcast-packets"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-multicast-packets"][language],
-                port_stats[port]["statistics"]["out-multicast-packets"].data,
-            )
-            print_row_with_spacing(
-                local_str["spacer"][language],
-                width,
-                local_str["out-unicast-packets"][language],
-                port_stats[port]["statistics"]["out-unicast-packets"].data,
+                local_str["last-cleared-time"][language],
+                str(port_stats[port]["statistics"]["last-cleared-time"].data),
             )
 
+        # Print input statistics
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-discards"][language],
+            port_stats[port]["statistics"]["in-discards"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-errors"][language],
+            port_stats[port]["statistics"]["in-errors"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-octets"][language],
+            port_stats[port]["statistics"]["in-octets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-packets"][language],
+            port_stats[port]["statistics"]["in-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-unknown-protocol-discards"][language],
+            port_stats[port]["statistics"]["in-unknown-protocol-discards"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-broadcast-packets"][language],
+            port_stats[port]["statistics"]["in-broadcast-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-multicast-packets"][language],
+            port_stats[port]["statistics"]["in-multicast-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["in-unicast-packets"][language],
+            port_stats[port]["statistics"]["in-unicast-packets"].data,
+        )
+
+        # Print output statistics
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-discards"][language],
+            port_stats[port]["statistics"]["out-discards"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-errors"][language],
+            port_stats[port]["statistics"]["out-errors"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-octets"][language],
+            port_stats[port]["statistics"]["out-octets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-packets"][language],
+            port_stats[port]["statistics"]["out-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-broadcast-packets"][language],
+            port_stats[port]["statistics"]["out-broadcast-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-multicast-packets"][language],
+            port_stats[port]["statistics"]["out-multicast-packets"].data,
+        )
+        print_row_with_spacing(
+            local_str["spacer"][language],
+            width,
+            local_str["out-unicast-packets"][language],
+            port_stats[port]["statistics"]["out-unicast-packets"].data,
+        )
+
     # Print the closing delimator
     print("=" * 80)