Chapter 3. Documenting your RHOSP environment

Procedure

1. Check the existing templates for your deployment for files that specify the roles currently in use. There is a NIC configuration file for each role in use in your environment. In the following example, the RHOSP environment includes the ComputeHCI role, the Compute role, and the Controller role:

   $ cd ~/templates
   $ tree
   .
   ├── environments
   │   └── network-environment.yaml
   ├── hci.yaml
   ├── network
   │   └── config
   │       └── multiple-nics
   │           ├── computehci.yaml
   │           ├── compute.yaml
   │           └── controller.yaml
   ├── network_data.yaml
   ├── plan-environment.yaml
   └── roles_data_hci.yaml

2. Each role for your RHOSP environment performs many interrelated services. You can document the services used by each role by inspecting a roles file.

   1. If a roles file was generated for your templates, you can find it in the ~/templates directory:

      $ cd ~/templates
      $ find . -name *role*
      > ./templates/roles_data_hci.yaml

   2. If a roles file was not generated for your templtes, you can generate one for the roles you currently use to inspect for documentation purposes:

      $ openstack overcloud roles generate \
      > --roles-path /usr/share/openstack-tripleo-heat-templates/roles \
      > -o roles_data.yaml Controller Compute

Procedure

1. From the undercloud, source the stackrc file:

   $ source ~/stackrc

2. List the nodes in your environment:

   $ openstack baremetal node list -c Name
   +--------------+
   | Name         |
   +--------------+
   | controller-0 |
   | controller-1 |
   | controller-2 |
   | compute-0    |
   | compute-1    |
   | compute-2    |
   +--------------+

3. For each baremetal node from which to gather information, and run the following command to retrieve the introspection data:

   $ openstack baremetal introspection data save <node> | jq

   Replace <node> with the name of the node from the list you retrieved in step 1.

4. Optional: To limit the output to a specific type of hardware, you can retrieve a list of the inventory keys and view introspection data for a specific key:

   1. Run the following command to get a list of top level keys from introspection data:

      $ openstack baremetal introspection data save controller-0 | jq '.inventory | keys'
      
      [
        "bmc_address",
        "bmc_v6address",
        "boot",
        "cpu",
        "disks",
        "hostname",
        "interfaces",
        "memory",
        "system_vendor"
      ]

   2. Select a key, for example disks, and run the following to get more information:

      $ openstack baremetal introspection data save controller-1 | jq '.inventory.disks'
      [
        {
          "name": "/dev/sda",
          "model": "QEMU HARDDISK",
          "size": 85899345920,
          "rotational": true,
          "wwn": null,
          "serial": "QM00001",
          "vendor": "ATA",
          "wwn_with_extension": null,
          "wwn_vendor_extension": null,
          "hctl": "0:0:0:0",
          "by_path": "/dev/disk/by-path/pci-0000:00:01.1-ata-1"
        }
      ]

Procedure

1. Ensure that you know the entry points for systems and services that can be subject to malicious activity. Run the following commands on the undercloud:

   $ cat /etc/hosts
   $ source stackrc ; openstack endpoint list
   $ source overcloudrc ; openstack endpoint list

2. RHOSP is deployed in containerized services, therefore you can view the software components on an overcloud node by checking the running containers on that node. Use ssh to connect to an overcloud node and list the running containers. For example, to view the overcloud services on compute-0, run a command similar to the following:

   $ ssh tripleo-admin@compute-0 podman ps