-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
753 additions
and
7 deletions.
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
4
docs/admin/cloudshell-manage-dashboard/manage-app-templates/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Managing App Templates", | ||
| "position": 2 | ||
| } |
4 changes: 4 additions & 0 deletions
4
docs/admin/cloudshell-manage-dashboard/manage-app-templates/app-template/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Adding App Templates", | ||
| "position": 2 | ||
| } |
122 changes: 122 additions & 0 deletions
122
...shell-manage-dashboard/manage-app-templates/app-template/adding-app-template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # Adding a new App Template | ||
|
|
||
| When adding a new App template, you need to configure the settings of the virtual machine and application you want to deploy. To add App templates, at least one cloud provider resource must be defined. To define private cloud provider resources, see [Private Cloud Provider Support in CloudShell](https://help.quali.com/Online%20Help/0.0/Portal/Content/Admn/Prp-for-prvt-cld-prvdrs.htm), and for public cloud providers, see [Public Cloud Provider Support in CloudShell](https://help.quali.com/Online%20Help/0.0/Portal/Content/Admn/Prp-for-cld-prvdrs.htm). | ||
|
|
||
| If your CloudShell deployment includes multiple sites, it is recommended to configure the deployment process of the App to be carried out in the domain that is physically closest to the cloud provider. For additional information, see [Managing Private Cloud Apps in Domains](https://help.quali.com/Online%20Help/0.0/Portal/Content/Admn/Mng-Prvt-Cld-Apps-in-Dmns.htm) or [Managing Public Cloud Apps in Domains](https://help.quali.com/Online%20Help/0.0/Portal/Content/Admn/Mng-Pblc-Cld-Apps-in-Dmns.htm). | ||
|
|
||
| :::note Notes for public cloud Apps: | ||
| - By default, all public cloud Apps of the same type in the same sandbox are deployed within the same subnet and therefore are connected to each other and isolated from other sandboxes. However, using the Subnet service, blueprint designers can set up multiple subnet networks in the sandbox, instead of having one default subnet for all the Apps of the same cloud provider. For details, see [Subnet Connectivity](https://help.quali.com/Online%20Help/0.0/Portal/Content/Admn/Cnct-Ctrl-Subnets.htm). | ||
| - Public cloud App deployment requires the management network and subnet(s) to be prepared in advance as part of the sandbox Setup process. CloudShell's out-of-the-box Setup process does this. However, the blueprint must include at least one public cloud App to initiate the Setup script's connectivity preparation process for deployment in that public cloud. | ||
| ::: | ||
|
|
||
| 1. Click **\+ Add**. | ||
|
|
||
| The **Create New App** wizard is displayed. | ||
|
|
||
|  | ||
|
|
||
| 2. From the **Select Deployment Type** pane, select the desired deployment type. For example, "**vCenter VM From Template**" deploys a vCenter virtual machine from a template while "**AWS EC2 Instance**" deploys an AWS EC2 instance from an AMI image. | ||
| 3. Enter a **Name** for the App template. | ||
|
|
||
| :::note | ||
| The App template's name has a limit of 100 characters and can only contain alpha-numeric characters, spaces, and the following characters: | . - \_ \] \[ | ||
| ::: | ||
|
|
||
| 4. Click **Create**. | ||
|
|
||
| The App template is created and the **App** wizard's **General** page is displayed. | ||
|
|
||
|  | ||
|
|
||
| 5. In the **General** page, define the App template's display settings and category. | ||
|
|
||
| <table> | ||
| <thead> | ||
| <th>Field</th> | ||
| <th>Required</th> | ||
| <th>Description</th> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>Name</td> | ||
| <td>Required</td> | ||
| <td>App name that is displayed in the catalog.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Description</td> | ||
| <td>Optional</td> | ||
| <td>Description of the App.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Icon</td> | ||
| <td>Optional</td> | ||
| <td> | ||
| Add an image to the catalog definition. The recommended size for the image is 190x120 pixels (image size is limited to 400x400 pixels or 200 KB). | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>Categories</td> | ||
| <td>Optional</td> | ||
| <td> | ||
| <p>Service categories are a method to classify Apps. The Apps are displayed in the **Add App / Service** side pane in the blueprint and sandbox diagram, arranged in categories. Only users who are permitted to view the category can access the App. Apps without a category are not displayed.</p> | ||
| <p>By default, the **Applications** category is selected.</p> | ||
| <p>Select a category from the dropdown list. You can select additional categories. Examples of categories are: applications, networking and VLAN.</p> | ||
| :::note Notes: | ||
| - The category must be associated with the domain in which the required cloud provider resides. For information about domain categories, see [Managing domain categories](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/MNG/Mng-Blprnt-Ctlg-Ctgs.htm#Managing2). | ||
| - It is recommended to use up to a 2-level hierarchy when organizing the **Add App / Service** catalog (i.e. root and sub-category). | ||
| - In the **Add App / Service** side pane, Apps are displayed in the root category only. This includes services associated to sub-categories. | ||
| ::: | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| 6. In the left pane, click **Deployment Paths** and configure the App template's deployment path. | ||
|
|
||
| A deployment path consists of (1) the selected deployment type (the method to be used to deploy the VM, for example, from a vCenter VM template or AWS AMI image, (2) the VM’s settings such as storage size, CPU and image file, and (3) the CloudShell cloud provider resource that enables CloudShell to access the cloud provider and deploy the VM on it. | ||
|
|
||
| Note the deployment path's name (highlighted in the image below). The path's name is dynamic and consists of the selected **Cloud Provider** resource and **Deployment** type. You can change the name of the path by clicking the field. | ||
|
|
||
|  | ||
|
|
||
| 1. From the **Deployment** drop down list, select the deployment type. | ||
|
|
||
| The selected deployment type's attributes are displayed. | ||
|
|
||
| :::note | ||
| Deployment types related to 2<sup>nd</sup> Gen cloud provider shells include "2G" in the title (for example: "vCenter VM From Template 2G"). | ||
| ::: | ||
|
|
||
| 2. Enter the required information based on the selected deployment path: | ||
| 1. For AWS EC2 Instance attributes - [Read here](./deployment-path/aws-ec2-dp-attributes). | ||
| 2. For Azure VM From Custom Image attributes - [Read here](./deployment-path/azure-custom-image-dp-attributes.md). | ||
| 3. For Azure VM From Marketplace attributes - [Read here](./deployment-path/azure-marketplace-dp-attributes.md). | ||
| 4. For Azure VM From Gallery Image 2nd Gen attributes - [Read here](./deployment-path/azure-galery-dp-attributes.md). | ||
| 5. For OpenStack Deploy Glance Image 2G attributes - [Read here](./deployment-path/openstack-glance-dp-attributes.md). | ||
| 6. For vCenter Clone VM From VM attributes - [Read here](./deployment-path/vcenter-clone-vm-dp-attributes.md). | ||
| 7. For vCenter Deploy VM From Linked Clone attributes - [Read here](./deployment-path/vcenter-link-clone-vm-dp-attributes.md). | ||
| 8. For vCenter VM From Image attributes - [Read here](./deployment-path/vcenter-clone-image-dp-attributes.md). | ||
| 9. For vCenter VM From Template attributes - [Read here](./deployment-path/vcenter-clone-template-dp-attributes.md). | ||
|
|
||
| 7. To add additional deployment paths to the App template, click the **Add New Deployment Path** link at the bottom of the wizard and fill in the required information. | ||
|
|
||
| Note that for Apps with multiple deployment paths, the user who adds the App to the blueprint or sandbox diagram will be prompted to select the suitable deployment path to use out of the deployment paths that are based on cloud provider resources in that user’s domain. | ||
|
|
||
|  | ||
|
|
||
| 8. In the left pane, click **Configuration Management** and configure the application to be installed on the VM. | ||
|
|
||
| Read about the different options [here](./configuration-management.md). | ||
|
|
||
|
|
||
| 9. In the left pane, click **App Resource** to optionally set the VM's operating system user credentials (for example, to connect to the VM via RDP or SSH). You can also change the deployed App's Shell. | ||
|
|
||
| Read about the different options [here](./app-resource.md). | ||
|
|
||
| 10. Click **Done**. | ||
|
|
||
| The new App template is displayed in the Apps page. |
59 changes: 59 additions & 0 deletions
59
...n/cloudshell-manage-dashboard/manage-app-templates/app-template/app-resource.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| # Setting up the App Resource | ||
|
|
||
| When adding or editing an App, click **App Resource** in the left page, to optionally set the VM's operating system user credentials (for example, to connect to the VM via RDP or SSH). You can also change the deployed App's Shell. | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
| To help sandbox end-users connect to the VM, it is recommended to include the **User** and **Password** in the blueprint's instructions. For additional information, see [Add Instructions](https://help.quali.com/Online%20Help/0.0/Portal/Content/CSP/LAB-MNG/Crt-Blprnt/Blprnt-Instr.htm). | ||
| ::: | ||
|
|
||
| <table> | ||
| <thead> | ||
| <th>Attribute</th> | ||
| <th>Description</th> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>Shell</td> | ||
| <td> | ||
| <p>The Shell on which the App's VMs are based. When an App is deployed in a sandbox, it changes into a "deployed App resource", which is based on the selected Shell. By default, the "Generic App Model" Shell is used.</p> | ||
| <p> | ||
| Deployed Apps include a default set of commands such as Power On and Refresh IP, and the VM's User and Password attributes, as explained below. | ||
| </p> | ||
| :::note | ||
| Changing the Shell might cause additional fields to become visible and you may need to enter further information. | ||
| ::: | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>User</td> | ||
| <td> | ||
| <p>User defined in the App's image. The **User/Password** credentials are used by QualiX to create in-browser connections to the VM from within the sandbox.</p> | ||
| :::note Notes | ||
| - For AWS instances,make sure to set the User of a user that already exists on the Amazon machine image. For custom images, the image owner should know the credentials, while community/marketplace images have the image's credentials listed in their documentation. | ||
| - Azure VM username and password restrictions apply. For details, see [Frequently asked question about Windows Virtual Machines](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/faq). | ||
| - For Azure Marketplace images, CloudShell will create a user on the VM based on the User/Password credentials you specify. | ||
| - For Azure Marketplace VMs, if the user is not set, CloudShell will set adminuser as the default user name. | ||
| ::: | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>Password</td> | ||
| <td> | ||
| VM user's password. | ||
| :::note Notes | ||
| - For AWS Marketplace images, leave the Password empty. The AWS shell generates a new key-pair for each sandbox, which QualiX will use to establish the in-browser connection. | ||
| - For Azure Marketplace images: | ||
| - If the password is not set, only the user name will be required. For Linux VMs, CloudShell will create an SSH key-pair to enable a secure connection. | ||
| - If the password is set, it will be displayed as asterisks (\*\*\*\*\*\*) in the blueprint or sandbox. | ||
| ::: | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
Oops, something went wrong.