Chapter 5. Creating an instance

Before you can create an instance, other Red Hat OpenStack Platform (RHOSP) components must be available, such as the flavor, boot source, network, key pair, and security group. These components are used in the creation of an instance and are not available by default.

When you create an instance, you choose a boot source that has the bootable operating system that you require for your instance, a flavor that has the hardware profile you require for your instance, the network you want to connect your instance to, and any additional storage you need, such as data volumes and ephemeral storage.

5.1. Prerequisites

  • The required image or volume is available as the boot source:

  • A flavor is available that specifies the required number of CPUs, memory, and storage capacity. The flavor settings must meet the minimum requirements for disk and memory size specified by your chosen image, otherwise the instance will fail to launch.
  • The required network is available. For more information about how to create a network, see Creating a network in the Networking Guide.

5.2. Creating an instance from an image

You can create an instance by using an image as the boot source.

Procedure

  1. Retrieve the name or ID of the flavor that has the hardware profile that your instance requires: 

    $ openstack flavor list
    Note

    Choose a flavor with sufficient size for the image to successfully boot, otherwise the instance will fail to launch.

  2. Retrieve the name or ID of the image that has the software profile that your instance requires: 

    $ openstack image list

    If the image that you require is not available, you can download or create a new image. For information about how to create or download cloud images, see Creating images.

    Note

    If you need to attach more than 26 volumes to your instance, then the image you use to create your instance must have the following properties:

    • hw_scsi_model=virtio-scsi
    • hw_disk_bus=scsi

  3. Retrieve the name or ID of the network that you want to connect your instance to: 

    $ openstack network list

  4. Create your instance: 

    $ openstack server create --flavor <flavor> \
  --image <image> --network <network> \
  --wait myInstanceFromImage
    • Replace <flavor> with the name or ID of the flavor that you retrieved in step 1.
    • Replace <image> with the name or ID of the image that you retrieved in step 2.
    • Replace <network> with the name or ID of the network that you retrieved in step 3. You can use the --network option more than once to connect your instance to several networks, as required.

5.3. Creating an instance from a bootable volume

You can create an instance by using a bootable volume as the boot source. Boot your instance from a volume when you need to improve the availability of the instance data in the event of a failure.

Note

When you use a block storage volume for your instance disk data, the block storage volume persists for any instance rebuilds, even when an instance is rebuilt with a new image that requests that a new volume is created.

Procedure

  1. Retrieve the name or ID of the image that has the software profile that your instance requires: 

    $ openstack image list

    If the image that you require is not available, you can download or create a new image. For information about how to create or download cloud images, see Creating images.

    Note

    If you need to attach more than 26 volumes to your instance, then the image you use to create your instance must have the following properties:

    • hw_scsi_model=virtio-scsi
    • hw_disk_bus=scsi

  2. Create a bootable volume from the image: 

    $ openstack volume create --image <image> \
--size <size_gb> --bootable myBootableVolume
    • Replace <image> with the name or ID of the image to write to the volume, retrieved in step 1.
    • Replace <size_gb> with the size of the volume in GB.

  3. Retrieve the name or ID of the flavor that has the hardware profile that your instance requires: 

    $ openstack flavor list

  4. Retrieve the name or ID of the network that you want to connect your instance to: 

    $ openstack network list

  5. Create an instance with the bootable volume: 

    $ openstack server create --flavor <flavor> \
 --volume myBootableVolume --network <network> \
 --wait myInstanceFromVolume
    • Replace <flavor> with the name or ID of the flavor that you retrieved in step 3.
    • Replace <network> with the name or ID of the network that you retrieved in step 4. You can use the --network option more than once to connect your instance to several networks, as required.

5.4. Creating an instance with a SR-IOV network interface

To create an instance with a single root I/O virtualization (SR-IOV) network interface you need to create the required SR-IOV port.

Procedure

  1. Retrieve the name or ID of the flavor that has the hardware profile that your instance requires: 

    $ openstack flavor list
    Note

    Choose a flavor with sufficient size for the image to successfully boot, otherwise the instance will fail to launch.

    Tip

    You can specify the NUMA affinity policy that is applied to your instance for PCI passthrough devices and SR-IOV interfaces, by selecting a flavor that has the policy you require. For more information on the available policies, see Instance PCI NUMA affinity policy in Flavor metadata in the Configuring the Compute Service for Instance Creation guide. If you choose a flavor with a NUMA affinity policy, then the image that you use must have either the same NUMA affinity policy or no NUMA affinity policy.

  2. Retrieve the name or ID of the image that has the software profile that your instance requires: 

    $ openstack image list

    If the image that you require is not available, you can download or create a new image. For information about how to create or download cloud images, see Creating images.

    Tip

    You can specify the NUMA affinity policy that is applied to your instance for PCI passthrough devices and SR-IOV interfaces, by selecting an image that has the policy you require. For more information on the available policies, see Instance PCI NUMA affinity policy in Flavor metadata in the Configuring the Compute Service for Instance Creation guide. If you choose an image with a NUMA affinity policy, then the flavor that you use must have either the same NUMA affinity policy or no NUMA affinity policy.

  3. Retrieve the name or ID of the network that you want to connect your instance to: 

    $ openstack network list

  4. Create the type of port that you require for your SR-IOV interface: 

    $ openstack port create --network <network> \
 --vnic-type <vnic_type> mySriovPort
    • Replace <network> with the name or ID of the network you retrieved in step 3.

    • Replace <vnic_type> with the one of the following values:

      • direct: Creates a direct mode SR-IOV virtual function (VF) port.
      • direct-physical: Creates a direct mode SR-IOV physical function (PF) port.
      • macvtap: Creates an indirect mode SR-IOV VF port that uses MacVTap to expose the virtio interface to the instance.

  5. Create your instance: 

    $ openstack server create --flavor <flavor> \
  --image <image> --port <port> \
  --wait mySriovInstance
    • Replace <flavor> with the name or ID of the flavor that you retrieved in step 1.
    • Replace <image> with the name or ID of the image that you retrieved in step 2.
    • Replace <port> with the name or ID of the port that you created in step 4.

5.5. Creating an instance with NUMA affinity on the port

To create an instance with NUMA affinity on the port you create the port with the required NUMA affinity policy, then specify the port when creating the instance.

Note

Port NUMA affinity policies have a higher precedence than flavors, images, and PCI NUMA affinity policies. Cloud operators can set a default NUMA affinity policy for each PCI passthrough device. You can use the instance flavor, image, or port to override the default NUMA affinity policy applied to an instance.

Prerequisites

  • The port-numa-affinity-policy extension must be enabled in the cloud platform.
  • The service plugin must be configured in the Networking service (neutron).

Procedure

  1. Create a port with the NUMA affinity policy that you require: 

    $ openstack port create --network <network> \
  [--numa-policy-required | --numa-policy-preferred | --numa-policy-legacy] \
  myNUMAAffinityPort
    • Replace <network> with the name or ID of the tenant network that you want to connect your instance to.

    • Use one of the following options to specify the NUMA affinity policy to apply to the port:

      • --numa-policy-required - NUMA affinity policy required to schedule this port.
      • --numa-policy-preferred - NUMA affinity policy preferred to schedule this port.
      • --numa-policy-legacy - NUMA affinity policy using legacy mode to schedule this port.

  2. Create your instance: 

    $ openstack server create --flavor <flavor> \
  --image <image> --port <port> \
  --wait myNUMAAffinityInstance
    • Replace <flavor> with the name or ID of the flavor that has the hardware profile that you require for your instance.
    • Replace <image> with the name or ID of the image that has the software profile that you require for your instance.
    • Replace <port> with the name or ID of the port that you created in step 1.

5.6. Additional resources