diff --git a/docs/functionality.rst b/docs/functionality.rst index ff3e8f5e2ae1ec9181127b77f8e1e6e37c45002c..2586c24b43f950356a12815180548f860e3f1e39 100644 --- a/docs/functionality.rst +++ b/docs/functionality.rst @@ -1,19 +1,7 @@ -Welcome to the hypertool documentation -###################################### +Functionality +============= -Hypertool enable easier support for registration, discovery, and lifecycle management across the Computing Continuum by adding additional labels and annotations to the register nodes status. -This ensure easier discovery and management of the nodes while using the native kubernetes commands. -For additional information about the added labels and annotations check section Functionality. - -The user can utilize the hypertool functionality with common kubernetes commands such us: -``kubectl describe node_name`` -(more commands will be documented as implemented in order to show the "registration, discovery and management capabilities of Hypertool) - -Added Labels/Annotations --------------------------- - -In this section we introduce all the addition labels/annotations in node status along with their -Kubernetes type, Dependencies, Parameters, Example outputs and Error Hanlding along with the methodology of how we calculate its value if needed. +In this section, we introduce all utility functions used to calculate HyperTool-specific attributes for Native Nodes. For each function, we specify how the resulting attribute is exposed in Kubernetes (as a label, annotation etc.), along with details about its dependencies, parameters, example output, and error handling. interface_name_and_type --------------------------