Chapter 14. Adding metadata to instances

Procedure

1. Create or update the ConfigMap CR named nova-extra-config.yaml and set the value of force_config_drive under [DEFAULT] to false:

   apiVersion: v1
   kind: ConfigMap
   metadata:
      name: nova-extra-config
      namespace: openstack
   data:
      35-nova-config-drive.conf: |
         [DEFAULT]
         force_config_drive = false

   For more information about creating ConfigMap objects, see Creating and using config maps in Nodes.

2. Create a new OpenStackDataPlaneDeployment CR to configure the services on the data plane nodes and deploy the data plane, and save it to a file named compute_config_drive_deploy.yaml on your workstation:

   apiVersion: core.openstack.org/v1beta1
   kind: OpenStackDataPlaneDeployment
   metadata:
       name: compute-config-drive

3. In the compute_config_drive_deploy.yaml CR, specify nodeSets to include all the OpenStackDataPlaneNodeSet CRs you want to deploy. Ensure that you include the OpenStackDataPlaneNodeSet CR that you selected as a prerequisite. That OpenStackDataPlaneNodeSet CR defines which nodes you are disabling config drive on.

   Warning

   If your deployment has more than one node set, changes to the nova-extra-config.yaml ConfigMap might directly affect more than one node set, depending on how the node sets and the DataPlaneServices are configured. To check if a node set uses the nova-extra-config ConfigMap and therefore will be affected by the reconfiguration, complete the following steps:

   1. Check the services list of the node set and find the name of the DataPlaneService that points to nova.

   2. Ensure that the value of the edpmServiceType field of the DataPlaneService is set to nova.

      If the dataSources list of the DataPlaneService contains a configMapRef named nova-extra-config, then this node set uses the nova-extra-config.yaml ConfigMap and therefore will be affected by the configuration changes in this ConfigMap. If some of the node sets that are affected should not be reconfigured, you must create a new DataPlaneService pointing to a separate ConfigMap for these node sets.

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneDeployment
   metadata:
     name: compute-config-drive
   spec:
     nodeSets:
       - openstack-edpm
       - compute-config-drive
       - ...
       - <nodeSet_name>

   • Replace <nodeSet_name> with the names of the OpenStackDataPlaneNodeSet CRs that you want to include in your data plane deployment.
4. Save the compute_config_drive_deploy.yaml deployment file.

5. Deploy the data plane:

   $ oc create -f compute_config_drive_deploy.yaml

6. Verify that the data plane is deployed:

   $ oc get openstackdataplanenodeset
   
   NAME                    STATUS    MESSAGE
   compute-config-drive   True            Deployed

   Tip

   Append the -w option to the end of the get command to track deployment progress.

7. Access the remote shell for openstackclient and verify that the deployed Compute nodes are visible on the control plane:

   $ oc rsh -n openstack openstackclient
   
   $ openstack hypervisor list

Procedure

1. Configure the data plane:

   1. Create or update the ConfigMap CR named nova-extra-config and add the following configuration to the data section of the ConfigMap to enable the DynamicJSON provider and define your metadata targets:

      apiVersion: v1
      kind: ConfigMap
      metadata:
         name: nova-extra-config
         namespace: openstack
      data:
         40-nova-vendordata.conf: |
           [api]
           vendordata_providers=DynamicJSON,StaticJSON
           vendordata_dynamic_targets=<name>@<external-http-service-url>
           vendordata_dynamic_targets=<name>@<external-http-service-url>

      • Replace <name>@<external-http-service-url> with the external service that provides the dynamic metadata, for example, target@http://127.0.0.1:125. You can configure multiple different external services and the Compute (nova) service gathers the dynamic metadata for an instance from each external service, merges the results, and provides the merged metadata to the instance.

        For more information about creating ConfigMap objects, see Creating and using config maps in Nodes.

   2. Create a new OpenStackDataPlaneDeployment CR to configure the services on the data plane nodes and deploy the data plane, and save it to a file named compute_vendordata_deploy.yaml on your workstation:

      apiVersion: dataplane.openstack.org/v1beta1
      kind: OpenStackDataPlaneDeployment
      metadata:
        name: compute_vendordata

      For more information about creating an OpenStackDataPlaneDeployment CR, see Deploying the data plane in Deploying Red Hat OpenStack Services on OpenShift.

   3. In the compute_vendordata_deploy.yaml, specify nodeSets to include all the OpenStackDataPlaneNodeSet CRs that you want to deploy. Ensure that you include the OpenStackDataPlaneNodeSet CR that you selected as a prerequisite. That OpenStackDataPlaneNodeSet CR defines the nodes for which you want to configure dynamic metadata.

      Warning

      In certain deployment configurations, when you modify the nova-extra-config.yaml ConfigMap, you might directly affect more than one node set. To check if a node set uses the nova-extra-config ConfigMap and is affected by the reconfiguration, complete the following steps:

      1. Check the services list of the node set and find the name of the DataPlaneService that points to the Compute (nova) service.

      2. Ensure that the value of the edpmServiceType field of the DataPlaneService is set to nova.

         If the dataSources list of the DataPlaneService contains a configMapRef named nova-extra-config, then this node set uses this ConfigMap and is affected by the configuration changes in this ConfigMap. You must create a new DataPlaneService pointing to a separate ConfigMap for the node sets that you do not want to reconfigure.

      apiVersion: dataplane.openstack.org/v1beta1
      kind: OpenStackDataPlaneDeployment
      metadata:
        name: compute-vendordata
      spec:
        nodeSets:
          - openstack-edpm
          - vendordata
          - ...
          - <nodeSet_name>

      • Replace <nodeSet_name> with the names of the OpenStackDataPlaneNodeSet CRs that you want to include in your data plane deployment.
   4. Save the compute_vendordata_deploy.yaml deployment file.

   5. Deploy the data plane:

      $ oc create -f compute_vendordata_deploy.yaml

   6. Verify that the data plane is deployed:

      $ oc get openstackdataplanenodeset

      NAME           STATUS MESSAGE
      compute-vendordata True   Deployed

   7. Access the remote shell for openstackclient and verify that the deployed Compute nodes are visible on the control plane:

      $ oc rsh -n openstack openstackclient

      $ openstack resource provider list

2. Configure the control plane:

   1. Open your OpenStackControlPlane custom resource file, openstack_control_plane.yaml.

   2. In openstack_control_plane.yaml, identify the location for the customServiceConfig:

      • If nova.template.metadataServiceTemplate.enabled is True, add the configuration under nova.template.metadataServiceTemplate.
      • If the nova.template.metadataServiceTemplate.enabled is False, add the configuration under nova.template.cellTemplates.<cell_name>.metadataServiceTemplate.

   3. Add the following configuration to the appropriate customServiceConfig section based on your metadata service deployment:

           [api]
           vendordata_providers=DynamicJSON,StaticJSON
           vendordata_dynamic_targets=<name>@<external-http-service-url>
           vendordata_dynamic_targets=<name>@<external-http-service-url>

      • Replace <name>@<external-http-service-url> with the external service providing the dynamic metadata, for example, target@http://127.0.0.1:125. You can configure multiple external services and the Compute (nova) service gathers the dynamic metadata for an instance from each external service, merges the results, and provides the merged metadata to the instance.

   4. Update the control plane:

      $ oc apply -f openstack_control_plane.yaml -n openstack

   5. Check if Red Hat OpenShift Container Platform (RHOCP) created the resources related to the OpenStackControlPlane CR:

      $ oc get openstackcontrolplane -n openstack

      The OpenStackControlPlane resources are created when the status is "Setup complete".

      Tip

      Use the -w option with the get command to track deployment progress:

      $ oc get -w openstackcontrolplane -n openstack

   6. Optional: Confirm that the control plane is deployed by reviewing the pods in the openstack namespace for each of your cells:

      $ oc get pods -n openstack

Verification

1. Create a new instance:

   $ openstack server create --flavor <flavor> --image <image> --nic <nic> --use-config-drive vm1

2. Use a remote console or SSH to access the instance. Within the instance, use one of the following methods to query the dynamic metadata:

   • The metadata service from the address http://169.254.169.254/openstack/latest/vendor_data2.json, for example:

     $ curl http://169.254.169.254/openstack/latest/vendor_data2.json
     {"target1": {...}, "target2":{...}}

   • The config drive by mounting the extra disk drive provided to the instance and accessing the file openstack/latest/vendor_data2.json on it, for example:

     $ lsblk

     NAME    MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
     sr0      11:0    1  474K  0 rom
     vda     252:0    0    1G  0 disk
     |-vda1  252:1    0 1015M  0 part /
     `-vda15 252:15   0    8M  0 part
     vdb     252:16   0    1G  0 disk /mnt

     $ mkdir /tmp/conf
     $ mount /dev/sr0 /tmp/conf
     $ cat /tmp/conf/openstack/latest/vendor_data2.json
     {"target1": {...}, "target2":{...}}

     The control plane is deployed when all the pods are either completed or running.