inventory pages and stubs

kalsky · kalsky · commit 7bc2aebb24d7 · 2024-01-30T16:22:22.000-06:00
diff --git a/docs/portal/inventory/_category_.json b/docs/portal/inventory/_category_.json
@@ -1,8 +1,4 @@
 {
   "label": "Inventory",
-  "position": 4,
-  "link": {
-    "type": "generated-index",
-    "description": "CloudShell Portal is the web client interface in which admins, blueprint designers and end-users set up and consume sandboxes."
-  }
+  "position": 4
 }
diff --git a/docs/portal/inventory/index.md b/docs/portal/inventory/index.md
@@ -0,0 +1,18 @@
+# Inventory
+
+This chapter describes CloudShell's inventory, the different resources it contains, and its options.
+
+## Recommended workflows
+
+### Finding and using resources
+
+1. [Search the Inventory](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Srch-Invnt.htm)
+2. [Reserve resources](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Rsrv-Rsrc-frm-Invtr.htm)
+3. [Edit abstract resource templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Edit.htm)
+
+
+### Creating and configuring resources
+
+1. [Search the Inventory](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Srch-Invnt.htm)
+2. [Create and configure resources](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Mng-Rsrc-in-Invnt.htm)
+3. [Manage abstract resource templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Mng-Abst-Rsrc-Tmplt.htm)
diff --git a/docs/portal/inventory/inventory-dashboard.md b/docs/portal/inventory/inventory-dashboard.md
@@ -2,4 +2,6 @@
 sidebar_position: 1
 ---
 
-# empty page
+# Inventory Dashboard
+
+WIP
diff --git a/docs/portal/inventory/managing-abstract-templates/_category_.json b/docs/portal/inventory/managing-abstract-templates/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Managing Abstract Resource Templates",
+  "position": 4
+}
diff --git a/docs/portal/inventory/managing-abstract-templates/create-abstract-template/_category_.json b/docs/portal/inventory/managing-abstract-templates/create-abstract-template/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Creating Abstract Resource Templates",
+  "position": 2
+}
diff --git a/docs/portal/inventory/managing-abstract-templates/create-abstract-template/index.md b/docs/portal/inventory/managing-abstract-templates/create-abstract-template/index.md
@@ -0,0 +1,34 @@
+# Creating Abstract Resource Templates
+
+To create, you must log in as administrator of the domain in which the abstract resource template will be used.
+
+You can also create an abstract resource template from an existing abstract resource in a blueprint by hovering over the abstract resource and selecting Save as template.
+
+**To create a new abstract resource template:**
+
+1. Open the **Abstract Templates** page and click the **Add New** button.
+    
+2. The **Create Resource Template** wizard is displayed, in the resource type page.
+    
+    ![](/Images/CloudShell-Portal/Lab-Management/Working-with-the-Inventory/CreateResourceTemplate.png)
+    
+3. Select the type of resource for the abstract resource template.
+    
+    The **Properties** page of the wizard is displayed.
+    
+4. Enter a **Name** and edit the settings, as appropriate. For additional information, see [Abstract Resource Settings](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Sttngs.htm).
+    
+    :::note
+    The resource's name has a limit of 100 characters and can only contain alpha-numeric characters, spaces, and the following characters: | - \_ \] \[
+    :::
+    
+5. Click **Save Changes**.
+    
+    The new abstract resource template is displayed in the **Abstract Templates** page of the **Inventory** dashboard and can be added to blueprints by users of this domain.
+    
+
+## Related Topics
+
+- [Viewing Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Crt.htm?tocpath=CloudShell%20Portal%7CInventory%7CManaging%20Abstract%20Resource%20Templates%7CCreating%20Abstract%20Resource%20Templates%7C_____0)
+- [Editing Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Edit.htm)
+- [Deleting Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Dlt.htm)
diff --git a/docs/portal/inventory/managing-abstract-templates/create-abstract-template/viewing-abstract-templates.md b/docs/portal/inventory/managing-abstract-templates/create-abstract-template/viewing-abstract-templates.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Abstract Resource Settings
+
+WIP
diff --git a/docs/portal/inventory/managing-abstract-templates/deleting-abstract-templates.md b/docs/portal/inventory/managing-abstract-templates/deleting-abstract-templates.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 4
+---
+
+# Deleting Abstract Resource Templates
+
+To delete, you must log in as administrator of the domain in which the abstract resource template was created.
+
+**To edit an abstract resource template:**
+
+1. Open the **Abstract Templates** page.
+2. Click the more info button of the abstract resource template.
+    
+    The more info window pops up.
+    
+    ![](/Images/CloudShell-Portal/Lab-Management/Working-with-the-Inventory/InventAbstTemplateMoreInfo.png)
+    
+3. Click **Delete**.
+    
+    A confirmation message is displayed in the window.
+    
+
+## Related Topics
+
+- [Inventory Dashboard](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Invnt-Dshbrd.htm)
diff --git a/docs/portal/inventory/managing-abstract-templates/editing-abstract-templates.md b/docs/portal/inventory/managing-abstract-templates/editing-abstract-templates.md
@@ -0,0 +1,27 @@
+---
+sidebar_position: 3
+---
+
+# Editing Abstract Resource Templates
+
+To edit, you must log in as administrator of the domain in which the abstract resource template was created.
+
+**To edit an abstract resource template:**
+
+1. Open the **Abstract Templates** page.
+2. Click the more info button of the abstract resource template.
+    
+    The more info window pops up.
+    
+    ![](/Images/CloudShell-Portal/Lab-Management/Working-with-the-Inventory/InventAbstTemplateMoreInfo.png)
+    
+3. Click **Edit**.
+   
+    The **Edit Resource Template** wizard is displayed, in the properties page.
+    
+4. Make the necessary changes. For additional information, see [Abstract Resource Settings](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Sttngs.htm).
+5. Click **Save Changes**.
+
+## Related Topics
+
+- [Inventory Dashboard](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Invnt-Dshbrd.htm)
diff --git a/docs/portal/inventory/managing-abstract-templates/index.md b/docs/portal/inventory/managing-abstract-templates/index.md
@@ -0,0 +1,15 @@
+# Managing Abstract Resource Templates
+
+This article explains how to create and manage abstract resource templates that can be added to different blueprints as abstract resources.
+
+The Abstract Templates page in the Inventory dashboard enables you to control which templates the users will have access to when creating dynamic blueprints.
+
+![](/Images/CloudShell-Portal/Lab-Management/Working-with-the-Inventory/InventAbstTemplate.png)
+
+## Related Topics
+
+- [Abstract Resources Overview](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/LAB-MNG/Features/Abstract-Resources.htm)
+- [Viewing Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-View.htm)
+- [Creating Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Crt.htm)
+- [Editing Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Edit.htm)
+- [Deleting Abstract Resource Templates](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Abst-Rsrc-Tmplt-Dlt.htm)
diff --git a/docs/portal/inventory/managing-abstract-templates/viewing-abstract-templates.md b/docs/portal/inventory/managing-abstract-templates/viewing-abstract-templates.md
@@ -0,0 +1,18 @@
+---
+sidebar_position: 1
+---
+
+# Viewing Abstract Resource Templates
+
+In the **Abstract Templates** page, you can view a repository of the abstract resource templates associated with the current domain. You can also create, edit, and delete abstract resource templates.
+
+**To view existing abstract resource templates:**
+
+- In the **Inventory** dashboard header, click **Abstract Templates**.
+    
+    The **Abstract Templates** page is displayed, listing the abstract resource templates you are permitted to access.
+    
+
+## Related Topics
+
+- [Inventory Dashboard](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Invnt-Dshbrd.htm)
diff --git a/docs/portal/inventory/managing-resources/_category_.json b/docs/portal/inventory/managing-resources/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Managing Resources in the Inventory",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "In the Inventory dashboard, you can perform the following actions on resources:"
+  }
+}
diff --git a/docs/portal/inventory/managing-resources/adding-inventory-resources/_category_.json b/docs/portal/inventory/managing-resources/adding-inventory-resources/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Adding Inventory Resources",
+  "position": 1
+}
diff --git a/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-aws-cp.md b/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-aws-cp.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Adding AWS EC2 Cloud Provider Resource
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-azure-cp.md b/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-azure-cp.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# Adding Microsoft Azure Cloud Provider Resource
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-vcenter-cp.md b/docs/portal/inventory/managing-resources/adding-inventory-resources/adding-vcenter-cp.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Adding VMWare vCenter Cloud Provider Resource
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/adding-inventory-resources/index.md b/docs/portal/inventory/managing-resources/adding-inventory-resources/index.md
@@ -0,0 +1,51 @@
+# Adding Inventory Resources
+
+In the **Inventory** dashboard, administrators can add resources based on Shell packages and cloud provider resources for App deployments.
+
+In order to add resources that are based on a Shell, the administrator needs to first import that Shell's package into CloudShell Portal. The Shells are preconfigured with the required settings, attributes, and automation. For additional information, see [Shells Overview](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/LAB-MNG/Features/Shells.htm).
+
+:::notes Notes
+- CloudShell administrators can download the required Shell package from [Quali Repositories](https://github.com/orgs/QualiSystems/repositories) and import it into CloudShell Portal. For details, see [Managing Shells](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/MNG/Mng-Shells.htm).
+- If you are populating your CloudShell inventory for the first time, we recommend to use the **CloudShell Autodiscovery** tool, which allows you to load multiple resources at the same time. For additional information, see the tool's [readme](https://github.com/QualiSystems/cloudshell-autodiscovery/blob/master/README.md).
+:::
+
+**To add a resource using a Shell:**
+
+1. In the **Inventory** dashboard, in the **Resources** tab, click the folder in which you want to create the resource.
+2. Click **+ Add New**.
+3. In the **Add New Resource** dialog box, select the required Shell from the list.
+4. Enter the required information. Type the **Name** and **IP Address** of the resource.
+    :::note
+    The resource's name has a limit of 100 characters and can only contain alpha-numeric characters, spaces, and the following characters: | . - \_ \] \[
+    :::
+    
+5. Click **Create**.
+    
+    You may be prompted at this point to start the discovery process (if there is a discovery option for this particular resource).
+    
+    A new dialog box is displayed for the discovery process.
+    :::note
+    The required inputs vary per driver.
+    :::
+    
+6. Enter the required information (for example, **Password** and **User** name), and click **Start Discovery**.
+    
+    A message is displayed, confirming that the discovery process has started. The discovery process validates the resource's settings against the actual device, and loads the device's resource structure (if exists) and settings into the resource.
+    
+    :::note
+    During the discovery process, the resource is excluded from use. In the Inventory list, the resource is marked by status icons with tooltips, indicating that the resource is excluded from use (!) and that the discovery process is in progress (![](/Images/CloudShell-Portal/INVN/offlinedisc.png) indicates the resource is offline during discovery). When the discovery process has completed, the status icons change accordingly, and the resource becomes available for use.
+    :::
+    
+    When the discovery process has completed, a confirmation message is displayed.
+    
+    CloudShell adds the new resource using the Shell’s settings, attributes, and driver.
+    
+    The resource is displayed in the **Inventory** list in CloudShell Portal and in Resource Manager.
+    
+
+## Related Topics
+
+- [Inventory Dashboard](../../inventory-dashboard)
+- [Traffic Generators Overview](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/LAB-MNG/Features/Traffic-Gens.htm)
+- [Editing Resources from the Inventory Dashboard](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Edit-Rsrc-in-Invnt.htm)
+- [Discovering Inventory Resources](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/INVN/Dscvr-Rsrc-in-Invnt.htm)
diff --git a/docs/portal/inventory/managing-resources/associate-resources-to-es.md b/docs/portal/inventory/managing-resources/associate-resources-to-es.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 8
+---
+
+# Associating Resources to Specific Execution Servers
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/connecting-remotely.md b/docs/portal/inventory/managing-resources/connecting-remotely.md
@@ -0,0 +1,30 @@
+---
+sidebar_position: 4
+---
+
+# Connecting Remotely to Devices from the Inventory Dashboard
+
+Admins can connect remotely to a device using the device's address and user credentials via RDP, SSH, VNC, or Telnet. RDP, SSH and Telnet are available by default, while VNC must be configured by the administrator. You can also connect to devices from the sandbox workspace.
+
+:::note
+This applies to resources that support remote connections. It is possible to enable or disable remote connection via QualiX on the resource level. For details, see [Editing Resources from the Inventory Dashboard](./editing-resources-from-inventory-dashboard).
+:::
+
+**To connect to a device via remote protocol:**
+
+1. In the **Inventory** dashboard, click the **Resources** tab.
+   The **Resources** page is displayed.
+    
+2. Click the **More Actions** button ![](/Images/CloudShell-Portal/Manage/ExecutionServersServersMenuButton.png) and select the remote connection option:
+   1. Telnet
+   2. SSH
+   3. RDP
+   4. VNC
+3. If prompted, perform additional steps, such as selecting the Windows application to use or entering the username and password to the device.
+4. The device is displayed in a Windows application, or in your web browser (if the QualiX Solution Pack is installed).
+
+## Related Topics
+
+- [Inventory Dashboard](../inventory-dashboard)
+- [Connect Remotely to Devices with QualiX (RDP, SSH, Telnet)](../../sandboxes/sandbox-workspace/resources/connect-remotely-with-qualix) (from the sandbox workspace)
+- [QualiX Installation and Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Qualix.htm)
diff --git a/docs/portal/inventory/managing-resources/deleting-resources-from-inventory.md b/docs/portal/inventory/managing-resources/deleting-resources-from-inventory.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 9
+---
+
+# Deleting Resources from the Inventory
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/discovering-resources.md b/docs/portal/inventory/managing-resources/discovering-resources.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Discovering Inventory Resources
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/editing-resources-from-inventory-dashboard.md b/docs/portal/inventory/managing-resources/editing-resources-from-inventory-dashboard.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 7
+---
+
+# Editing Resources from the Inventory Dashboard
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/include-exclude-resources.md b/docs/portal/inventory/managing-resources/include-exclude-resources.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 6
+---
+
+# Including/Excluding Inventory Resources
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/reserving-from-inventory.md b/docs/portal/inventory/managing-resources/reserving-from-inventory.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# Reserving Resources from the Inventory
+
+WIP
diff --git a/docs/portal/inventory/managing-resources/searching-for-sub-resources.md b/docs/portal/inventory/managing-resources/searching-for-sub-resources.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Searching for Sub-resources
+
+WIP
diff --git a/docs/portal/inventory/search-the-inventory.md b/docs/portal/inventory/search-the-inventory.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# Searching the Inventory
+
+WIP
diff --git a/docs/portal/inventory/viewing-services.md b/docs/portal/inventory/viewing-services.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Viewing Services
+
+WIP

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Inventory",`
`3`		`- "position": 4,`
`4`		`- "link": {`
`5`		`- "type": "generated-index",`
`6`		`- "description": "CloudShell Portal is the web client interface in which admins, blueprint designers and end-users set up and consume sandboxes."`
`7`		`- }`
	`3`	`+ "position": 4`
`8`	`4`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "label": "Managing Abstract Resource Templates",
 +  "position": 4
 +}