---
myst:
  html_meta:
    "description lang=en": "Openstack VM Provider Settings."
    "keywords": "Kasm, Openstack"
    "property=og:locale": "en_US"
---

```{figure} /images/compute/vm_openstack.webp
:align: center
**OpenStack VM**
```

```{eval-rst}
.. table:: OpenStack VM Provider Settings
    :widths: 75

    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | Name                              | Description                                                                                                                     |
    +===================================+=================================================================================================================================+
    | **Name**                          | A name to use to identify the config.                                                                                           |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Max Instances**                 | The maximum number of OpenStack compute instances to provision regardless of the need for additional resources.                 |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Identity Endpoint**   | The endpoint address of the OpenStack Keystone endpoint (e.g. :code:`https://openstack.domain:5000`)                            |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Nova Endpoint**       | The endpoint address of the OpenStack Nova (Compute) endpoint (e.g. :code:`https://openstack.domain:8774/v2/`)                  |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Nova Version**        | The version to use with the OpenStack Nova (Compute) endpoint (e.g. :code:`2.90`)                                               |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Glance Endpoint**     | The endpoint address of the OpenStack Glance (Image) endpoint (e.g. :code:`https://openstack.domain:9292`)                      |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Glance Version**      | The version to use with the OpenStack Glance (Image) endpoint (e.g. :code:`2`)                                                  |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Cinder Endpoint**     | The endpoint address of the OpenStack Cinder (Volume) endpoint. **Note: The address contains the OpenStack Project ID**         |
    |                                   | (e.g. :code:`https://openstack.domain:8776/v3/383a0dad105e460ab5a863ea0a45932b`)                                                |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **OpenStack Cinder Version**      | The version to use with the OpenStack Cinder (Volume) endpoint. (e.g. :code:`3`)                                                |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Project Name**                  | The name of the OpenStack Project where VMs will be provisioned.                                                                |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Authentication Method**         | The kind of credential used to authenticate against the OpenStack Endpoints.                                                    |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Application Credential ID**     | The Credential ID of the OpenStack Application Credential.                                                                      |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Application Credential Secret** | The OpenStack Application Credential secret.                                                                                    |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Project Domain Name**           | The Domain that OpenStack Project belongs to (e.g. :code:`domain-1353722761`)                                                   |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **User Domain Name**              | The Domain that the OpenStack User belongs to (e.g. :code:`domain-1353722761`)                                                  |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Username**                      | The Username of the OpenStack User used to authentication against OpenStack.                                                    |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Password**                      | The Password of the OpenStack User used to authenticate against OpenStack.                                                      |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Metadata**                      | A Json Dictionary containing the metadata tags applied to the OpenStack VMs (e.g. :code:`{"my_tag": "my_value"}`)               |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Image ID**                      | The ID of the Image used to provision OpenStack VMs.                                                                            |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Flavor**                        | The name of the desired Flavor for the OpenStack VM (e.g. :code:`gen.medium`)                                                   |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Create Volume**                 | Enable to create a new Block storage (Cinder) volume for the OpenStack VM. (When disabled, ephemeral Compute (Nova) storage is  |
    |                                   | used.)                                                                                                                          |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Volume Size (GB)**              | The desired size of the VM Volume in GB. This can only be specified when "Create Volume" is enabled.                            |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Volume Type**                   | The type of volume to use for the new OpenStack VM Volume (e.g. :code:`__DEFAULT__`)                                            |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Startup Script**                | When OpenStack VMs are provision this script is executed. The script is responsible for installing and configuring the Kasm     |
    |                                   | Agent.                                                                                                                          |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Security Groups**               | A list containing the security groups applied to the OpenStack VM (e.g. :code:`["sg1", "sg2"]`)                                 |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Network ID**                    | The ID of the network that the OpenStack VMs will be connected to.                                                              |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Key Name**                      | The name of the SSH Key used to connect to the instance.                                                                        |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Availability Zone**             | The Name of the Availability Zone that the OpenStack VM will be placed into.                                                    |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
    | **Config Override**               | A JSON dictionary that can be used to customize attributes of the VM request                                                    |
    +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------+

```