Docs and Release Notes 0.17 update (#3387)

* (Issue #2444) 'UDP traffic for NAT Gateway' section was added to docs

* (Issue #3794) 'Cloud Nodes' doc was added

docs/md/manual/09_Manage_Cluster_nodes/9.2._Core_Services_Monitoring.md

@@ -1,96 +1,90 @@
+# Monitoring: core components
 
-# **Monitoring: core components**
 - [Core nodes](#core-nodes)
 - [Core services](#core-services)
     - [Service details](#service-details)
     - [Service status](#service-status)
     - [Filters](#filters)
 
-For the quick access to core nodes and services, a new tab was added to the **Cluster State** section - **CORE NODES** tab:
+For the quick access to core nodes and services, a new tab was added to the **Cluster State** section - **CORE NODES** tab:  
+   ![CP_CloudNodes](attachments/CoreServices_01.png)
 
-![](attachments/core_services_001.png)
+> To view **CORE NODES** tab you need to have the **ROLE\_ADMIN** role. For more information see [13. Permissions](../13_Permissions/13._Permissions.md).
 
 This tab includes two subtabs:
 
 - **Core nodes** - to view the list of all core nodes of the current platform deployment
 - **Core services** - to view the list of all services on the core nodes and their state
 
-Please note, **CORE NODES** tab is available and may be viewed only by admins.
-# **Core nodes**
-To view the list of platform core nodes:
+## Core nodes
 
-- open the **Cluster State** section
-- navigate to the **CORE NODES** tab → **Core nodes** subtab
+To view the list of platform core nodes:
 
-![](attachments/core_services_002.png)
+1. Open the **Cluster State** section.
+2. Navigate to the **CORE NODES** tab → **Core nodes** subtab:  
+   ![CP_CloudNodes](attachments/CoreServices_02.png)
 
 This subtab shows the table similar to the one for general active nodes (**ALL NODES** tab of the **Cluster State** section), but only for core nodes.
 
 Displaying details:
 
 - **Name** - name of the node
 - **Pipeline** - currently assigned run on the node (usually not applicable)
-- **Labels** - characteristics extracted from the parameters of the node. 
-  There are common labels:
+- **Labels** - characteristics extracted from the parameters of the node.  
+    There are common labels:  
     - node name
     - labels with details of compute instances used for nodes
     - labels of core services used by nodes
 - **Addresses** - node addresses
 - **Created** - date of the node creation
 
-To get currently active nodes list, use the !button in the right-upper corner of the nodes list.
+To get currently active nodes list, use the ![CP_CloudNodes](attachments/CoreServices_03.png) button in the right-upper corner of the nodes list.
 
 To navigate to the detailed node information page, click its row in the table.
 
 **Core nodes** table supports sorting by any of columns:
 
-- *Name*
-- *Labels*
-- *Created*
+- _Name_
+- _Labels_
+- _Created_
 
 To sort the table, click the sorting control near the column header.
 
 **Core nodes** table supports filtering by any of columns:
 
-- *Labels*
-- *Addresses*
+- _Labels_
+- _Addresses_
 
 To filter the table:
 
-- click the filter control near the column header:
-
-![](attachments/core_services_004.png)
-
-- in the appeared filter, specify desired value and click the **OK** button, e.g.:
-
-![](attachments/core_services_005.png)
+1. Click the filter control near the column header:  
+   ![CP_CloudNodes](attachments/CoreServices_04.png)
+2. In the appeared filter, specify desired value and click the **OK** button, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_05.png)
+3. Table will be filtered:  
+   ![CP_CloudNodes](attachments/CoreServices_06.png)
 
-- table will be filtered:
+## Core services
 
-![](attachments/core_services_006.png)
-# **Core services**
 To inspect the list of services of platform core nodes:
 
-- open the **Cluster State** section
-- navigate to the **CORE NODES** tab → **Core services** subtab
+1. Open the **Cluster State** section.
+2. Navigate to the **CORE NODES** tab → **Core services** subtab:  
+   ![CP_CloudNodes](attachments/CoreServices_07.png)
 
-![](attachments/core_services_007.png)
+This subtab shows the list of services for core nodes.  
+Each service presents an entity that can be expanded - via the plus button (![CP_CloudNodes](attachments/CoreServices_08.png)) near the service name.  
 
-This subtab shows the list of services for core nodes.
-
-Each service presents an entity that can be expanded - via the plus button (!) near the service name.
-
-Inside the service entity, there is a list of service pods. Each pod entity can be expanded as well - via the plus button (!) near the pod name.
+Inside the service entity, there is a list of service pods.  
+Each pod entity can be expanded as well - via the plus button (![CP_CloudNodes](attachments/CoreServices_08.png)) near the pod name.
 
 Inside the pod entity, there is a list of pod containers.
 
-![](attachments/core_services_009.png)
-
-To collapse the entity, use the minus button (![](attachments/core_services_010.png)) near the entity name.
+![CP_CloudNodes](attachments/CoreServices_09.png)
 
-To collapse all expanded entities, use the corresponding button ![](attachments/core_services_011.png)  in the right-upper corner of the table.
-
-To get the current services list, use the !button in the right-upper corner of the table.
+To collapse the entity, use the minus button (![CP_CloudNodes](attachments/CoreServices_10.png)) near the entity name.  
+To collapse all expanded entities, use the corresponding button ![CP_CloudNodes](attachments/CoreServices_11.png) in the right-upper corner of the table.  
+To get the current services list, use the ![CP_CloudNodes](attachments/CoreServices_03.png) in the right-upper corner of the table.
 
 Displaying details in the table:
 
@@ -100,72 +94,73 @@ Displaying details in the table:
 - **Pod status** - state of the service/pod/container
 - **Restarts** - number of pod restarts
 - **Uptime** - duration of the pod uptime
-## **Service details**
+
+### Service details
+
 You may view detailed info of a pod:
 
 1. Expand the desired service.
-1. Click the info icon near the pod name, e.g.:
-   ![](attachments/core_services_012.png)
-1. Pop-up with the pod info in JSON format will appear:
-   ![](attachments/core_services_013.png)
-1. For some pods, that pop-up can include additional tab - **Events**, e.g.:
-   ![](attachments/core_services_014.png)
-1. This tab includes pod events list, e.g.:
-   ![](attachments/core_services_015.png)
+2. Click the info icon near the pod name, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_12.png)
+3. Pop-up with the pod info in JSON format will appear:  
+   ![CP_CloudNodes](attachments/CoreServices_13.png)
+4. For some pods, that pop-up can include additional tab - **Events**, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_14.png)
+5. This tab includes pod events list, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_15.png)
 
 You may view logs of a container:
 
 1. Expand the desired service.
-1. Expand the pod.
-1. Click the info icon near the container name, e.g.:
-   ![](attachments/core_services_016.png)
-1. Pop-up with the container running logs will appear:
-   ![](attachments/core_services_017.png)
-1. You may view/refresh such logs in the pop-up or download them to the local workstation via the corresponding buttons.
-## **Service status**
-Status shown in the **Pod status** column varies by the entity type.
-
-For *services*, status has the format **`[X]/[Y]`**, where:
-
-- `[X]` - number of not failed pods of the service. ***Note***: not failed pods may be running, succeeded or pending.
+2. Expand the pod.
+3. Click the info icon near the container name, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_16.png)
+4. Pop-up with the container running logs will appear:  
+   ![CP_CloudNodes](attachments/CoreServices_17.png)
+5. You may view/refresh such logs in the pop-up or download them to the local workstation via the corresponding buttons.
+
+### Service status
+
+Status shown in the **Pod status** column varies by the entity type.  
+For _services_, status has the format **`[X]/[Y]`**, where:
+
+- `[X]` - number of not-failed pods of the service. ***Note***: not-failed pods may be _running_, _succeeded_ or _pending_.
 - `[Y]` - total number of the service pods
 
 Additionally, there is a colorful icon that shows *service* status:
 
-- ***Unhealthy*** services (i.e. services with at least one failed pod) has a red status circle
-- ***Healthy*** services (i.e. services without failed pods) has a green status circle
+- **_Unhealthy_** services (i.e. services with at least one failed pod) has a red status circle
+- **_Healthy_** services (i.e. services without failed pods) has a green status circle
 
-![](attachments/core_services_018.png)
+![CP_CloudNodes](attachments/CoreServices_18.png)
 
-For *pods*, status may be one of the following:
+For _pods_, status may be one of the following:
 
 - ***Pending***, status icon is orange
 - ***Running***, status icon is blue
 - ***Succeeded***, status icon is green
 - ***Failed***, status icon is red
 
-![](attachments/core_services_019.png)
+![CP_CloudNodes](attachments/CoreServices_19.png)
 
-*Containers* have statuses from the same categories as pods, with the corresponding icons. Name of these statuses may vary from the category names depending on the container state.
+_Containers_ have statuses from the same categories as pods, with the corresponding icons. Name of these statuses may vary from the category names depending on the container state.
 
-![](attachments/core_services_020.png)
-## **Filters**
-There are several ways to filter core services:
+![CP_CloudNodes](attachments/CoreServices_20.png)
 
-- *Main filter* - allows to show only ***healthy*** / ***unhealthy*** / ***all*** core services - this filter is located above the table and presents the corresponding control, e.g.:
+### Filters
 
-![](attachments/core_services_021.png)
+There are several ways to filter core services:
+
+- _Main filter_ - allows to show only **_healthy_** / **_unhealthy_** / **_all_** core services - this filter is located above the table and presents the corresponding control, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_21.png)
 
-- *Column filter* - allows to filter table by the specific value(s) in the desired column(s):
+- _Column filter_ - allows to filter table by the specific value(s) in the desired column(s):
     - click the filter icon in the column header
     - specify/select the desired value in the filter field
-    - table will be automatically filtered by the specified value, e.g.:
-
-      ![](attachments/core_services_022.png)
-
-- *Search field* - allows to perform the search over the whole services table, e.g.:
-
-![](attachments/core_services_023.png)
+    - table will be automatically filtered by the specified value, e.g.:  
+    ![CP_CloudNodes](attachments/CoreServices_22.png)
 
+- _Search field_ - allows to perform the search over the whole services table, e.g.:  
+   ![CP_CloudNodes](attachments/CoreServices_23.png)
 
 To reset all specified filters, click the button **Clear filters** in the top of the table.

docs/md/manual/09_Manage_Cluster_nodes/9.3._Cloud_nodes.md

@@ -0,0 +1,48 @@
+# 9.3. Cloud nodes
+
+**Cloud Nodes** - instances in the Cloud that were launched via the Cloud-account of the Cloud Pipeline platform's deployment but not related to the platform directly.  
+Most of these are different cloud instances for additional services.  
+You can view Cloud Nodes using a separate tab on the **Cluster State** page - **CLOUD NODES** tab.
+
+> To view **CLOUD NODES** tab you need to have the **ROLE\_ADMIN** role. For more information see [13. Permissions](../13_Permissions/13._Permissions.md).
+
+![CP_CloudNodes](attachments/CloudNodes_01.png)
+
+Tab contains the list of Cloud Nodes with the following info:
+
+- _Name_ - node name
+- _Labels_ - list of metadata tag values associated with the node
+- _Addresses_ - IP-address and ID of the node
+- _Created_ - date and time of the node creation
+
+Table data at this tab can be sorted and filtered - similar to the main [nodes table](9._Manage_Cluster_nodes.md#9-cluster-nodes).
+
+To view node details, click the node row in the list. Node details page will be opened, e.g.:  
+    ![CP_CloudNodes](attachments/CloudNodes_02.png)
+
+Details page contains two tables:
+
+- _Addresses_ - IP-address and ID of the node
+- _Labels_ - list of metadata tags associated with the node
+
+Cloud Nodes are visible at the **ALL NODES** tab of the **Cluster State** page as well:  
+    ![CP_CloudNodes](attachments/CloudNodes_03.png)
+
+At this tab, Cloud Nodes are highlighted by grey and have additional cloud icon (![CP_CloudNodes](attachments/CloudNodes_04.png)).
+
+## Cluster Node termination
+
+By default, there is no ability to terminate Cloud Nodes from the UI - there are no corresponding buttons in their rows.  
+But that behavior can be changed - via the special System Preference **`ui.standalone.nodes.allow.terminate`**.  
+This preference allows to manage the availability of the Cluster Nodes termination. Default value of the preference - _disabled_.
+
+To enable Cluster Nodes termination from UI, you shall:
+
+1. Open System Preferences.
+2. Find **`ui.standalone.nodes.allow.terminate`** preference and tick its checkbox:  
+    ![CP_CloudNodes](attachments/CloudNodes_05.png)
+3. Save changes.
+4. After, Cloud Nodes will become available for selection and termination:  
+    ![CP_CloudNodes](attachments/CloudNodes_06.png)
+5. And at the **ALL NODES** tab as well:  
+    ![CP_CloudNodes](attachments/CloudNodes_07.png)

docs/md/manual/12_Manage_Settings/12.14._NAT_gateway.md

@@ -15,11 +15,12 @@ Each route record contains:
     - icon with the route status
     - server name
     - IP
-    - port
+    - port(s)
+    - transfer protocol
 - info about corresponding internal config (mapping details):
     - service name
     - service IP
-    - port
+    - port(s)
     - comment field
 - button to remove the route
 
@@ -45,13 +46,16 @@ To add a new route, administrator shall:
     ![CP_NATgateway](attachments/NatGateway_06.png)  
     Repeat if necessary.  
     To remove extra-added port from the list, click the button ![CP_NATgateway](attachments/NatGateway_07.png) near the port.
-7. Optionally, you can add a comment/description for the created route, e.g.:  
+7. Select the protocol for the data transfer from the dropdown list:  
+    ![CP_NATgateway](attachments/NatGateway_23.png)  
+    **_Note_**: TCP is selected by default.
+8. Optionally, you can add a comment/description for the created route, e.g.:  
     ![CP_NATgateway](attachments/NatGateway_08.png)
-8. Once all details are specified, click the **ADD** button:  
+9. Once all details are specified, click the **ADD** button:  
     ![CP_NATgateway](attachments/NatGateway_09.png)
-9. Just-added external server will appear in the list:  
+10. Just-added external server will appear in the list:  
     ![CP_NATgateway](attachments/NatGateway_10.png)
-10. We've added a temporary record in external resources list. Unsaved routes are displayed in blue color.  
+11. We've added a temporary record in external resources list. Unsaved routes are displayed in blue color.  
     Also:  
     - if necessary, any other server(s) or new ports for the existing servers can be added in the same way as described. To add a new record, click the button ![CP_NATgateway](attachments/NatGateway_11.png)
     - to cancel all made changes, click the button ![CP_NATgateway](attachments/NatGateway_12.png)

docs/md/manual/Cloud_Pipeline_-_Manual.md

@@ -43,6 +43,8 @@
     - [8.14. Omics storages](08_Manage_Data_Storage/8.14._Omics_storages.md)
 - [9. Manage Cluster nodes](09_Manage_Cluster_nodes/9._Manage_Cluster_nodes.md)
     - [9.1. Manage hot node pools](09_Manage_Cluster_nodes/9.1._Hot_node_pools.md)
+    - [9.2. Core services monitoring](09_Manage_Cluster_nodes/9.2._Core_Services_Monitoring.md)
+    - [9.3. Cloud nodes](09_Manage_Cluster_nodes/9.3._Cloud_nodes.md)
 - [10. Manage Tools](10_Manage_Tools/10._Manage_Tools.md)
     - [10.1. Add/Edit a Docker registry](10_Manage_Tools/10.1._Add_Edit_a_Docker_registry.md)
     - [10.2. Add/Edit a Tool group](10_Manage_Tools/10.2._Add_Edit_a_Tool_group.md)

docs/mkdocs.yml

@@ -65,6 +65,7 @@ nav:
     - 9.0. Cluster nodes: 'manual/09_Manage_Cluster_nodes/9._Manage_Cluster_nodes.md'
     - 9.1. Hot node pools: 'manual/09_Manage_Cluster_nodes/9.1._Hot_node_pools.md'
     - 9.2. Core services monitoring: 'manual/09_Manage_Cluster_nodes/9.2._Core_Services_Monitoring.md'
+    - 9.3. Cloud nodes: 'manual/09_Manage_Cluster_nodes/9.3._Cloud_nodes.md'
   - 10. Manage Tools:
     - 10.0. Overview: 'manual/10_Manage_Tools/10._Manage_Tools.md'
     - 10.1. Add and edit a Docker registry: 'manual/10_Manage_Tools/10.1._Add_Edit_a_Docker_registry.md'