From 157c166f7c457dc6ecf93e30e4b3323f1788eecb Mon Sep 17 00:00:00 2001
From: rsujay <ramkrishna.sujay@windriver.com>
Date: Fri, 20 Jan 2023 03:25:57 -0500
Subject: [PATCH] Update DC api-ref documentation with new parameters

The current restrictions for network reconfiguration post-install is problematic for correcting or updating network configuration for Subcloud deployments or supporting Subcloud rehoming procedures.

The proposed solution is to decouple the Distributed Cloud networking operations from the management network by introducing a new admin network type that will be used for the addressing and routing between the central System Controller and the Subcloud.

Currently, network parameters are not able to be modified via the dcmanager subcloud update CLI.  This commit is to update DC api-ref documentation with new admin parameters.

Test-plan: Debian
dcmanager subcloud update --admin-subnet --admin-gateway-ip --admin-node-0-address --admin-node-1-address
dcmanager subcloud show


Story: 2010319
Task: 47139

Signed-off-by: rsujay <ramkrishna.sujay@windriver.com>
Change-Id: I971943fa7fec63d4fae222ba0199ef1811975f8f
---
 api-ref/source/api-ref-dcmanager-v1.rst | 12 ++++++++++++
 api-ref/source/parameters.yaml          | 24 ++++++++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/api-ref/source/api-ref-dcmanager-v1.rst b/api-ref/source/api-ref-dcmanager-v1.rst
index e6c0f8772..810b10168 100644
--- a/api-ref/source/api-ref-dcmanager-v1.rst
+++ b/api-ref/source/api-ref-dcmanager-v1.rst
@@ -318,6 +318,14 @@ The attributes of a subcloud which are modifiable:
 
 -  group_id
 
+-  admin-subnet
+
+-  admin-gateway-ip
+
+-  admin-node-0-address
+
+-  admin-node-1-address
+
 **Normal response codes**
 
 200
@@ -337,6 +345,10 @@ serviceUnavailable (503)
   - location: subcloud_location
   - management-state: subcloud_management_state
   - group_id: subcloud_group_id
+  - admin-subnet: subcloud_admin_subnet
+  - admin-gateway-ip: subcloud_admin_gateway_ip
+  - admin-node-0-address: subcloud_admin_node_0_address
+  - admin-node-1-address: subcloud_admin_node_1_address
 
 Request Example
 ----------------
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 44362a31f..60dd49f22 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -379,6 +379,30 @@ strategy_steps:
   in: body
   required: false
   type: array
+subcloud_admin_gateway_ip:
+  description: |
+    The admin gateway ip of a subcloud.
+  in: body
+  required: false
+  type: string
+subcloud_admin_node_0_address:
+  description: |
+    The admin node-0 address of a subcloud.
+  in: body
+  required: false
+  type: string
+subcloud_admin_node_1_address:
+  description: |
+    The admin node-1 address of a subcloud.
+  in: body
+  required: false
+  type: string
+subcloud_admin_subnet:
+  description: |
+    The admin subnet of a subcloud.
+  in: body
+  required: false
+  type: string
 subcloud_apply_type:
   description: |
     The apply type for the update.  `serial` or `parallel`.