Merge pull request #2 from vsphere-tmm/rrick/structure_consistency

Align all the plugins with a similar TOC
vsphere-tmm · Oct 10, 2023 · c4d7fe6 · c4d7fe6
2 parents f69e01a + 608bafe
commit c4d7fe6
Show file tree

Hide file tree

Showing 4 changed files with 98 additions and 94 deletions.
diff --git a/network-service/README.md b/network-service/README.md
@@ -38,17 +38,22 @@ This would be a summary of what this tutorial covers, example deploy a vm.....
 The UI can be used in addition to the kubectl and API support available in CCI.
 
 The UI allows users to execute all necessary workflows:
-- List all Services
+- Services
+    - List all Services
+        - See summary of the service
+        - See details for the service
     - Action
         - View the YAML for a service
-    - See details for the service
 - List all VM Load Balancers
+    - List all Load Balancers
+        - See summary of the Load Balancer
+        - See details for the Load Balancer
     - Action menu bar
         - Create a new Load Balancer
     - Grid action menu
         - View the YAML for a Load Balancer
-        - Edit a Load Balancer
         - Delete a Load Balancer
+        - Edit a Load Balancer
 
 ## List all Services
 

diff --git a/tkg-service/README.md b/tkg-service/README.md
@@ -42,17 +42,18 @@ The UI can be used in addition to the kubectl and API support available in CCI.
 The UI allows users to execute all necessary workflows:
 - List all Clusters
     - Show summary of cluster
-    - Show details of cluster
+    - Show details of cluster, including editing the cluster
 - Action menubar
-    - Create a new cluster Default configuration
-    - Create a new cluster Custom Configuration
+    - Create a new cluster (Default and Custom configuration)
 - Grid action menu
     - View the YAML for a cluster
-    - Edit a cluster
     - Delete a cluster
 
 ## List all Clusters
 
+![Listing of clusters](source/images/tkgs-list.png "Listing of clusters")
+
+
 ## Actions
 There are two options for creating Tanzu Kubernetes Clusters. You can create clusters with Default settings or customize the cluster's settings.
 ### Create a new cluster - Default configuration

diff --git a/vm-image-service/README.md b/vm-image-service/README.md
@@ -33,71 +33,30 @@ This would be a summary of what this tutorial covers, example deploy a vm.....
 3. Deploy config-map
 4. deploy VM object
 
-# Virtual Machine Service - UI Support
-
-[#Create VM]
+# Virtual Machine Image Service - UI Support
 
 The UI can be used in addition to the kubectl and API support available in CCI.
 
 The UI allows users to execute all necessary workflows:
-- Create VM
-- View all VMs
-- Day 2 operations
-- Delete VMs
-
-## Create VM
-
-The create VM workflow supports two distinct paths.
-
-For both paths the user must select a VM Image and VM Class for the VM.
-
-![VM Create](source/images/vm-service-create-image-class.png "VM Create")
-
-The user is then presented with "REVIEW AND CONFIRM" and "GO TO ADVANCED SETTINGS" buttons.
-
-### Standard
-
-If the user clicks on "REVIEW AND CONFIRM", then they are taken immediately to the last step of the wizard to review the settings before dpeloying the VM.
-
-After reviewing the two options they selected, they can proceed with the VM creation by clicking the DEPLOY VM button.
-
-### Advanced Settings
-
-If the user has opted for the advanced settings flow, they have the abililty to:
-- Add additional volumes to the VM
-- Specify a ssh keypair to use to access the VM
-- Add additional LoadBalancer configuration (service resources)
-- Add Cloud-config data, configuration, or scripts
-
-Once the additional settings have been selected, the user clicks on the NEXT button to review and deploy the VM. The user can click the DEPLOY VM button to initiate the creation of the VM.
-
-![VM Create PVC](source/images/vm-service-pvc.png "VM Create PVC")
-![VM Create SSH Keypair](source/images/vm-service-public-key.png "VM Create SSH Keypair")
-![VM Create LB](source/images/vm-service-lb.png "VM Create LB")
-![VM Create Cloud-config](source/images/vm-service-cloud-config.png "VM Create Cloud-config")
-
-
-## View all VMs
-
-Users can view all the VMs created in the namespace. The user will see the following information in the grid's default view:
-- Name
-- Status (Ready, Error, etc.)
-- Power State (On/Off)
-- Managed by : indicates whether the VM is part of a Tanzu Kubernetes Cluster
-- Address : IP address
-- Age : How long the VM has existed
-
-![VM List](source/images/vm-service-list.png "VM List")
-
-
-## Day 2 operations
+- Virtual Machine Images
+    - List all Virtual Machine Images
+        - Show details of image
+    - Grid action menu
+        - Delete an image from a content library
+        - View the YAML for an image
+- Content Libraries
+    - List all Content Library contents
+        - Show details for the Content Library
+    - Grid action menu
+        - View the YAML for a Content Library
 
-The user has the ability to toggle the Power State and manage the volumes associated with the VM. Volumes can be added, detached, or have their capacity increased through the UI.
+## List all Virtual Machine Images
 
-![VM Edit](source/images/vm-service-day-2.png "VM Edit")
+### Actions
+### Details
 
-## Delete VM
+## List all Content Library contents
 
-VMs can be deleted by clicking on the three vertical dots for a VM in the datagrid and selecting Delete and providing confirmation.
+### Actions
+### Details
 
-![VM Delete](source/images/vm-service-delete.png "VM Delete")
diff --git a/vm-service/README.md b/vm-service/README.md
@@ -35,17 +35,62 @@ This would be a summary of what this tutorial covers, example deploy a vm.....
 
 # Virtual Machine Service - UI Support
 
-[#Create VM]
-
 The UI can be used in addition to the kubectl and API support available in CCI.
 
 The UI allows users to execute all necessary workflows:
-- Create VM
-- View all VMs
-- Day 2 operations
-- Delete VMs
+- Virtual Machines
+    - List all VMs
+        - Show summary of VM
+        - Show details of VM, including editing the VM
+        - Toggle display of TKG Cluster VMs
+    - Action menubar
+        - Create a new VM (Default and Advanced configuration)
+        - Toggle display of TKG Cluster VMs
+    - Grid action menu
+        - View the YAML for a VM
+        - Publish a VM
+        - Open Web Console
+        - Delete a VM
+- VM Classes
+- Related Objects
+
+## Virtual Machines
+
+### List all VMs
+
+List of available Virtual Machines. You can deploy and manage VMs in a self-service way using Kubernetes APIs.
+
+Users can view all the VMs created in the namespace. The user will see the following information in the grid's default view:
+- Name
+- Status (Ready, Error, etc.)
+- Power State (On/Off)
+- Address : IP address
+- VM Image
+- VM Class
+- Age : How long the VM has existed
+
+There are additional columns that can be toggled through the Manage Columns button located at the bottom of the grid:
+
+- Managed by - which TKG Cluster does this VM belong to
+- Labels - any labels assigned to the VM
+- Created On - specific time the VM was created
+
+![VM List](source/images/vm-service-list.png "VM List")
+
+### Summary of VM
+
+Click on the double chevrons to see key information for the resources.
+
+### Details of VM
+
+Click on the VM to see all the details for the resource, including VM health status and recent events.
 
-## Create VM
+The user has the ability to toggle the Power State and manage the volumes associated with the VM. Volumes can be added, detached, or have their capacity increased through the UI.
+
+![VM Edit](source/images/vm-service-day-2.png "VM Edit")
+
+### Action Menubar
+#### Create VM
 
 The create VM workflow supports two distinct paths.
 
@@ -55,19 +100,15 @@ For both paths the user must select a VM Image and VM Class for the VM.
 
 The user is then presented with "REVIEW AND CONFIRM" and "GO TO ADVANCED SETTINGS" buttons.
 
-### Standard
-
 If the user clicks on "REVIEW AND CONFIRM", then they are taken immediately to the last step of the wizard to review the settings before dpeloying the VM.
 
 After reviewing the two options they selected, they can proceed with the VM creation by clicking the DEPLOY VM button.
 
-### Advanced Settings
-
 If the user has opted for the advanced settings flow, they have the abililty to:
 - Add additional volumes to the VM
 - Specify a ssh keypair to use to access the VM
 - Add additional LoadBalancer configuration (service resources)
-- Add Cloud-config data, configuration, or scripts
+- Add Cloud-config data, configuration, or scripts; or alternatively, Sysprep data for a Windows configuration
 
 Once the additional settings have been selected, the user clicks on the NEXT button to review and deploy the VM. The user can click the DEPLOY VM button to initiate the creation of the VM.
 
@@ -76,28 +117,26 @@ Once the additional settings have been selected, the user clicks on the NEXT but
 ![VM Create LB](source/images/vm-service-lb.png "VM Create LB")
 ![VM Create Cloud-config](source/images/vm-service-cloud-config.png "VM Create Cloud-config")
 
+#### Toggle display of TKG Cluster VMs
 
-## View all VMs
-
-Users can view all the VMs created in the namespace. The user will see the following information in the grid's default view:
-- Name
-- Status (Ready, Error, etc.)
-- Power State (On/Off)
-- Managed by : indicates whether the VM is part of a Tanzu Kubernetes Cluster
-- Address : IP address
-- Age : How long the VM has existed
+Click on "HIDE TKG CLUSTER VMS" to toggle whether TKG Cluster VMs are included in the listing of VMs.
 
-![VM List](source/images/vm-service-list.png "VM List")
+### Grid action menu
 
+There are several actions available from the grid menu.
+1. Viewing the YAML for the resource
+2. Publishing the VM to a writable Content Library
+3. Opening the web console for the VM
+4. Deleting the VM
 
-## Day 2 operations
+Click on the 3 vertical dots to open the menu.
 
-The user has the ability to toggle the Power State and manage the volumes associated with the VM. Volumes can be added, detached, or have their capacity increased through the UI.
+![VM Grid Menu](source/images/vm-service-grid-menu.png "VM Grid Menu")
 
-![VM Edit](source/images/vm-service-day-2.png "VM Edit")
+## VM Classes
 
-## Delete VM
+List of available VM Classes. A VM Class defines the software configuration of a VM, including the operating system.
 
-VMs can be deleted by clicking on the three vertical dots for a VM in the datagrid and selecting Delete and providing confirmation.
+## Related Objects
 
-![VM Delete](source/images/vm-service-delete.png "VM Delete")
+List of resources related to all the VMs. You can click through to see more details for resources supported by other services.