ACS screenshots (#288)

* wip * WIP * wip * wip * added optional OOB network handling * added screenshots
netrisai · Feb 1, 2025 · 829cee6 · 829cee6
1 parent 0d067d5
commit 829cee6
Show file tree

Hide file tree

Showing 31 changed files with 133 additions and 8 deletions.
diff --git a/tutorials/images/acs-dnat-creation.png b/tutorials/images/acs-dnat-creation.png
diff --git a/tutorials/images/acs-enable-netris-plugin.png b/tutorials/images/acs-enable-netris-plugin.png
diff --git a/tutorials/images/acs-inventory-profile.png b/tutorials/images/acs-inventory-profile.png
diff --git a/tutorials/images/acs-link-creation.png b/tutorials/images/acs-link-creation.png
diff --git a/tutorials/images/acs-lo-subnet.png b/tutorials/images/acs-lo-subnet.png
diff --git a/tutorials/images/acs-mgmt-subnet.png b/tutorials/images/acs-mgmt-subnet.png
diff --git a/tutorials/images/acs-mng-cloudbr0-vnet.png b/tutorials/images/acs-mng-cloudbr0-vnet.png
diff --git a/tutorials/images/acs-mng-hyper-subnet.png b/tutorials/images/acs-mng-hyper-subnet.png
diff --git a/tutorials/images/acs-mng-mgmt-vnet.png b/tutorials/images/acs-mng-mgmt-vnet.png
diff --git a/tutorials/images/acs-private-allocation.png b/tutorials/images/acs-private-allocation.png
diff --git a/tutorials/images/acs-public-allocation.png b/tutorials/images/acs-public-allocation.png
diff --git a/tutorials/images/acs-public-nat-subnet.png b/tutorials/images/acs-public-nat-subnet.png
diff --git a/tutorials/images/acs-server2-creation.png b/tutorials/images/acs-server2-creation.png
diff --git a/tutorials/images/acs-server2-link-edit.png b/tutorials/images/acs-server2-link-edit.png
diff --git a/tutorials/images/acs-server2-one-liner.png b/tutorials/images/acs-server2-one-liner.png
diff --git a/tutorials/images/acs-snat-creation.png b/tutorials/images/acs-snat-creation.png
diff --git a/tutorials/images/acs-system-vms-subnet.png b/tutorials/images/acs-system-vms-subnet.png
diff --git a/tutorials/images/acs-system-vms-vnet.png b/tutorials/images/acs-system-vms-vnet.png
diff --git a/tutorials/images/acs-topology-link-edit.png b/tutorials/images/acs-topology-link-edit.png
diff --git a/tutorials/images/acs-wizard-launch-zone.png b/tutorials/images/acs-wizard-launch-zone.png
diff --git a/tutorials/images/acs-wizard-netris-details.png b/tutorials/images/acs-wizard-netris-details.png
diff --git a/tutorials/images/acs-wizard-physical-network.png b/tutorials/images/acs-wizard-physical-network.png
diff --git a/tutorials/images/acs-wizard-pod1-details.png b/tutorials/images/acs-wizard-pod1-details.png
diff --git a/tutorials/images/acs-wizard-public-netris-pool.png b/tutorials/images/acs-wizard-public-netris-pool.png
diff --git a/tutorials/images/acs-wizard-public-network1.png b/tutorials/images/acs-wizard-public-network1.png
diff --git a/tutorials/images/acs-wizard-public-network2.png b/tutorials/images/acs-wizard-public-network2.png
diff --git a/tutorials/images/acs-wizard-vxlan-range.png b/tutorials/images/acs-wizard-vxlan-range.png
diff --git a/tutorials/images/acs-wizard-zone-details.png b/tutorials/images/acs-wizard-zone-details.png
diff --git a/tutorials/netris-cloudstack_p2.rst b/tutorials/netris-cloudstack_p2.rst
@@ -38,7 +38,8 @@ Allocations represent IP ranges assigned to an organization, such as private IP
 
 3. Click **Add** to create the allocation.
 
-[todo]Refer to the screenshot for guidance:
+.. image:: images/acs-private-allocation.png
+  :align: center
 
 
 Create Subnets
@@ -59,6 +60,11 @@ The **loopback subnet** is used for assigning **unique IPs** to each device (e.g
   * **Purpose**: Choose Loopback.
   * **Sites**: Associate with your Netris site.
 
+
+.. image:: images/acs-lo-subnet.png
+  :align: center
+
+
 Management Subnet (Optional)
 """"""""""""""""""""""""""""""""""
 
@@ -78,6 +84,9 @@ The **management subnet** provides connectivity for **server administration**.
    If your infrastructure does **not** have a dedicated **management network**, you can **skip this step**.
 
 
+.. image:: images/acs-mgmt-subnet.png
+  :align: center
+
 **Adding Subnets in Netris**
 
 
@@ -115,12 +124,12 @@ Step 2: Add Servers
 
 **Server 1 (CloudStack Management Node)**:
 
-  - **Name**: Server 1
+  - **Name**: Server-1
   - **Tenant**: Assign to Admin.
   - **Description**: Leave blank or add relevant details.
   - **Type**: Select Server.
   - **Site**: Assign to your site.
-  - **AS Number**: Assign automatically or provide a unique ASN.
+  - **AS Number**: Select `Disabled`.
   - **Main IP Address**: Select `Disabled` (as no Main IP is needed).
   - **Management IP Address**:
 
@@ -145,9 +154,9 @@ Click **Add** to save the configuration for **Server 1**.
 
   - **Name**:
 
-    - `Server 2` for the first hypervisor.
-    - `Server 3` for the second hypervisor.
-    - `Server 4` for the third hypervisor.
+    - `Server-2` for the first hypervisor.
+    - `Server-3` for the second hypervisor.
+    - `Server-4` for the third hypervisor.
 
   - **Tenant**: Assign to Admin.
   - **Description**: Leave blank or add relevant details.
@@ -222,6 +231,9 @@ Click **Add** to save the configuration for **Server 1**.
       }
 
 
+.. image:: images/acs-server2-creation.png
+  :align: center
+
 
 For **each server**, click **Add** to save the configuration.
 
@@ -330,6 +342,10 @@ Step 3: Repeat for All Server Interfaces
    Once the agent is installed, you will **return to these links** and **enable Underlay** for full integration.
 
 
+.. image:: images/acs-link-creation.png
+  :align: center
+
+
 Key Considerations
 """""""""""""""""""""""""""""""""""
 
@@ -402,6 +418,11 @@ Once saved, this setting will **optimize BGP overlays** for hypervisor networkin
   This step is limited to enabling the Optimize BGP Overlay option. Other parameters within the inventory profile are irrelevant to this process and should remain unchanged to avoid unnecessary complexity.
 
 
+.. image:: images/acs-inventory-profile.png
+  :align: center
+
+
+
 Adding Subnets for CloudStack Cluster
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -503,6 +524,10 @@ Define Subnets for CloudStack Management
    - Sites: Select the relevant site.
 
 
+.. image:: images/acs-mng-hyper-subnet.png
+  :align: center
+
+
 Define Public Allocation
 """"""""""""""""""""""""""""""
 
@@ -517,6 +542,10 @@ Define Public Allocation
    - Type: Allocation
 
 
+.. image:: images/acs-public-allocation.png
+  :align: center
+
+
 Define CIDR for CloudStack System VMs
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
@@ -533,6 +562,11 @@ In this step, we define a dedicated **subnet** for CloudStack **System VMs**, wh
    - Sites: Select the relevant site.
 
 
+.. image:: images/acs-system-vms-subnet.png
+  :align: center
+
+
+
 Defining CIDR for Internal Use (Infrastructure NAT)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
@@ -554,6 +588,11 @@ This subnet is designed to handle infrastructure-level NAT requirements efficien
    - Sites: Select the relevant site.
 
 
+.. image:: images/acs-public-nat-subnet.png
+  :align: center
+
+
+
 Define CIDR for CloudStack Virtual Routers (VRs)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
@@ -582,7 +621,7 @@ CloudStack’s VPN services require **publicly routable IPs** for VPN connectivi
 
 
 Public Allocation/Subnet for Netris Services
-"""""""""""""""""""""""""""""""""""""""
+"""""""""""""""""""""""""""""""""""""""""""""
 
 
 This CIDR is used by **CloudStack** to manage NAT and Load Balancer services directly in **Netris**, bypassing the Virtual Routers (VRs). When a user creates a NAT rule or Load Balancer in CloudStack, the system selects a free IP from this range and creates that service in **Netris**.
@@ -658,6 +697,11 @@ Step 2: Configure SNAT Rules
 Click **Add** to save the rule.
 
 
+.. image:: images/acs-snat-creation.png
+  :align: center
+
+
+
 **SNAT Rule for CloudStack Hypervisor Nodes**
 
 ::
@@ -743,6 +787,11 @@ Step 2: Configure the DNAT Rule
 
 2. Save the rule by clicking **Add**.
 
+
+.. image:: images/acs-dnat-creation.png
+  :align: center
+
+
 Step 3: Reminder
 """""""""""""""""""""""""""""""""""""""""""""""""
 
@@ -812,6 +861,11 @@ Step 2: Configure V-Nets
 
 Click **Save**.
 
+
+.. image:: images/acs-mng-mgmt-vnet.png
+  :align: center
+
+
 **2. CloudStack Management (Hypervisor Nodes)**
 ::
 
@@ -828,6 +882,11 @@ Click **Save**.
 
 Click **Save**.
 
+
+.. image:: images/acs-mng-cloudbr0-vnet.png
+  :align: center
+
+
 **3. CloudStack System VMs**
 ::
 
@@ -842,6 +901,11 @@ Click **Save**.
 
 Click **Save**.
 
+
+.. image:: images/acs-system-vms-vnet.png
+  :align: center
+
+
 **4. CloudStack Virtual Routers (VRs)**
 ::
 

diff --git a/tutorials/netris-cloudstack_p3.rst b/tutorials/netris-cloudstack_p3.rst
@@ -204,6 +204,10 @@ To provision the **netris-cloudstack agent** on the hypervisor servers (**Server
 6. **Repeat this process** for each hypervisor server (**Servers 2, 3, and 4**).
 
 
+.. image:: images/acs-server2-one-liner.png
+  :align: center
+
+
 Example Successful Output of One-Liner Script
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -283,6 +287,15 @@ Step 1: Enable Underlay for Hypervisor Links
 5. **Click Save**.
 6. **Repeat for all hypervisors (Server 2, 3, and 4)**.
 
+
+.. image:: images/acs-topology-link-edit.png
+  :align: left
+  :width: 330px
+  :height: 228px
+
+.. image:: images/acs-server2-link-edit.png
+  :align: center
+
 Step 2: Verify VXLAN Connectivity
 """"""""""""""""""""""""""""""""""""""""""""""""""""
 

diff --git a/tutorials/netris-cloudstack_p4.rst b/tutorials/netris-cloudstack_p4.rst
@@ -17,6 +17,11 @@ Once the CloudStack Management service is installed and running, the next step i
   #. Enable the Netris plugin by toggling the switch to "ON."
   #. Save the settings.
 
+
+.. image:: images/acs-enable-netris-plugin.png
+  :align: center
+
+
 After enabling the plugin, restart the CloudStack Management service to apply the changes:
 
    .. code-block:: shell
@@ -70,6 +75,11 @@ Fill in the following details for your zone:
 
 Click **Next** to continue the setup process.
 
+
+.. image:: images/acs-wizard-zone-details.png
+  :align: center
+
+
 Step 4: Network
 """"""""""""""""
 
@@ -87,6 +97,11 @@ Define the physical network for the zone.
 
 Click **Next** to proceed.
 
+
+.. image:: images/acs-wizard-physical-network.png
+  :align: center
+
+
 Step 5: Netris Provider Configuration
 """""""""""""""""""""""""""""""""""""
 
@@ -103,6 +118,10 @@ On the **Netris Provider** page, provide the following information:
 
 Click **Next** to proceed.
 
+.. image:: images/acs-wizard-netris-details.png
+  :align: center
+
+
 Step 6: Public Traffic Configuration
 """""""""""""""""""""""""""""""""""""
 
@@ -120,6 +139,11 @@ Example Configuration:
   - **VXLAN/VNI**: Use the **VXLAN ID** from **Netris** for **System VMs** (e.g., `vxlan://12`).
   - **Start and End IP**: `203.0.113.2 - 203.0.113.30`
 
+
+.. image:: images/acs-wizard-public-network1.png
+  :align: center
+
+
 - **Virtual Routers Public Network**:
 
   - **Gateway**: `203.0.113.129`
@@ -133,6 +157,10 @@ Click **Add** for each network and verify that the details align with your **Net
 
 Then click **Next**.
 
+.. image:: images/acs-wizard-public-network2.png
+  :align: center
+
+
 Step 7: Netris Public IP Pool
 """""""""""""""""""""""""""""""""""""
 
@@ -142,12 +170,17 @@ Example Configuration:
 
 - **Gateway**: `198.51.100.1` (from the **Subnet for Netris Services** in **Netris IPAM**).
 - **Netmask**: `255.255.255.128`.
-- **Start and End IP**: `198.51.100.2 - 198.51.100.254`.
+- **Start and End IP**: `198.51.100.2 - 198.51.100.126`.
 
 **Note**: For the **Netris Public IP Pool**, the **VLAN/VNI** field is **inactive** because this is not a **VNet**, but a **pool of IPs** that **CloudStack** will consume to create services like **NAT and load balancers**.
 
 Click **Add** and then **Next**.
 
+
+.. image:: images/acs-wizard-public-netris-pool.png
+  :align: center
+
+
 Step 8: Configuring Pod Management Network
 """""""""""""""""""""""""""""""""""""""""""
 
@@ -196,6 +229,11 @@ Using data from the corrected **hypervisor management subnet (10.100.0.0/21)** i
 
 Click **Next** to proceed.
 
+
+.. image:: images/acs-wizard-pod1-details.png
+  :align: center
+
+
 Step 9: Configuring VPC Tiers VXLAN Range
 """""""""""""""""""""""""""""""""""""""""""
 
@@ -236,6 +274,11 @@ The **VXLAN range** defines the **pool of VNIs** that CloudStack will use to cre
 .. note::
    Using a **large VXLAN range** allows for greater flexibility in **scaling your cloud network**, especially in **multi-tenant environments**.
 
+
+.. image:: images/acs-wizard-vxlan-range.png
+  :align: center
+
+
 Step 10: Final Steps in Zone Configuration
 """""""""""""""""""""""""""""""""""""""""""
 
@@ -270,6 +313,11 @@ Since **Netris is not involved** in these processes, no specific recommendations
    - **Secondary storage** is used for **templates, ISOs, and snapshots**.
    - This storage should also be **configured** and **attached** as part of the **zone setup**.
 
+
+.. image:: images/acs-wizard-launch-zone.png
+  :align: center
+
+
 **Why This Section is Brief**
 
 Since these steps are **unrelated to Netris functionality and configuration**, users should follow **CloudStack’s standard documentation** or their **internal policies** to complete these tasks.