Using Already Deployed Servers

TripleO can be used with servers that have already been deployed and provisioned with a running operating system.

In this deployment scenario, Nova and Ironic from the Undercloud are not used to do any server deployment, installation, or power management. An external to TripleO and already existing provisioning tool is expected to have already installed an operating system on the servers that are intended to be used as nodes in the Overcloud.

Note

It’s an all or nothing approach when using already deployed servers. Mixing using deployed servers with servers provisioned with Nova and Ironic is not currently possible.

Benefits to using this feature include not requiring a dedicated provisioning network, and being able to use a custom partitioning scheme on the already deployed servers.

Deployed Server Requirements

Networking

Network interfaces

It’s recommended that each server have a dedicated management NIC with externally configured connectivity so that the servers are reachable outside of any networking configuration done by the OpenStack deployment.

A separate interface, or set of interfaces should then be used for the OpenStack deployment itself, configured in the typical fashion with a set of NIC config templates during the Overcloud deployment. See Configuring Network Isolation for more information on configuring networking.

Note

When configuring network isolation be sure that the configuration does not result in a loss of network connectivity from the deployed servers to the undercloud. The interface(s) that are being used for this connectivity should be excluded from the NIC config templates so that the configuration does not unintentionally drop all networking access to the deployed servers.

Undercloud

Neutron in the Undercloud is not used for providing DHCP services for the Overcloud nodes, hence a dedicated provisioning network with L2 connectivity is not a requirement in this scenario. Neutron is however still used for IPAM for the purposes of assigning IP addresses to the port resources created by tripleo-heat-templates.

Network L3 connectivity is still a requirement between the Undercloud and Overcloud nodes. The Overcloud nodes will communicate over HTTP(s) to poll the Undercloud for software configuration to be applied by their local agents.

The polling process requires L3 routable network connectivity from the deployed servers to the Undercloud OpenStack API’s.

If the ctlplane is a routable network from the deployed servers, then the deployed servers can connect directly to the IP address specified by local_ip from undercloud.conf. Alternatively, they could connect to the virtual IP address (VIP) specified by undercloud_public_host, if VIP’s are in use.

In the scenario where the ctlplane is not routable from the deployed servers, then undercloud_public_host in undercloud.conf must be set to a hostname that resolves to a routable IP address for the deployed servers. SSL also must be configured on the Undercloud so that HAProxy is bound to that configured hostname. Specify either undercloud_service_certifcate or generate_service_certificate to enable SSL during the Undercloud installation. See Deploying with SSL for more information on configuring SSL.

Additionally, when the ctlplane is not routable from the deployed servers, Heat on the Undercloud must be configured to use the public endpoints for OpenStack service communication during the polling process and be configured to use Swift temp URL’s for signaling. Add the following hiera data to a new or existing hiera file:

heat_clients_endpoint_type: public
heat::engine::default_deployment_signal_transport: TEMP_URL_SIGNAL

Specify the path to the hiera file with the hieradata_override configuration in undercloud.conf:

hieradata_override = /path/to/custom/hiera/file.yaml

Overcloud

Configure the deployed servers that will be used as nodes in the Overcloud with L3 connectivity to the Undercloud as needed. The configuration could be done via static or DHCP IP assignment.

Further networking configuration of Overcloud nodes is the same as in a typical TripleO deployment, except for:

  • Initial configuration of L3 connectivity to the Undercloud

  • No requirement for dedicating a separate L2 network for provisioning

Testing Connectivity

On each Overcloud node run the following commands that test connectivity to the Undercloud’s IP address where OpenStack services are bound. Use either local_ip or undercloud_public_host in the following examples.

Test basic connectivity to the Undercloud:

ping <undercloud local_ip>

Test HTTP/HTTPS connectivity to Heat API on the Undercloud:

curl <undercloud local_ip>:8000

Sample output:

{"versions": [{"status": "CURRENT", "id": "v1.0", "links": [{"href": "http://10.12.53.41:8000/v1/", "rel": "self"}]}]}

Test HTTP/HTTPS connectivity to Swift on the Undercloud The html output shown here is expected! While it indicates no resource was found, it demonstrates successful connectivity to the HTTP service:

curl <undercloud local_ip>:8080

Sample output:

<html><h1>Not Found</h1><p>The resource could not be found.</p></html>

The output from the above curl commands demonstrates successful connectivity to the web services bound at the Undercloud’s local_ip IP address. It’s important to verify this connectivity prior to starting the deployment, otherwise the deployment may be unsuccessful and difficult to debug.

Package repositories

The servers will need to already have the appropriately enabled yum repositories as packages will be installed on the servers during the Overcloud deployment. The enabling of repositories on the Overcloud nodes is the same as it is for other areas of TripleO, such as Undercloud installation. See <no title> for the detailed steps on how to enable the standard repositories for TripleO.

Initial Package Installation

Once the repositories have been enabled on the deployed servers, the initial packages for the Heat agent need to be installed. Run the following command on each server intending to be used as part of the Overcloud:

sudo yum install python-heat-agent*

Certificate Authority Configuration

If SSL is enabled on the Undercloud endpoints, the deployed servers need to be configured to trust the Certificate Authority (CA) that signed the SSL certificates.

On a default Undercloud install with SSL where the CA is automatically generated, the CA file will be at /etc/pki/ca-trust/source/anchors/cm-local-ca.pem. Copy this CA file to the /etc/pki/ca-trust/source/anchors/ directory on each deployed server. Then run the following command on each server to update the CA trust:

sudo update-ca-trust extract

Deploying the Overcloud

Deployment Command

The functionality of using already deployed servers is enabled by passing additional Heat environment files to the openstack overcloud deploy command.:

openstack overcloud deploy \
  <other cli arguments> \
  --disable-validations \
  -e /usr/share/openstack-tripleo-heat-templates/environments/deployed-server-environment.yaml

The --disable-validations option disables the basic Nova, Ironic, and Glance related validations executed by python-tripleoclient. These validations are not necessary since those services will not be used to deploy the Overcloud.

The deployed-server.yaml environment takes advantage of the template composition nature of Heat and tripleo-heat-templates to substitute OS::Heat::DeployedServer resources in place of OS::Nova::Server.

Note

Previously a custom roles file was needed when using deployed-server. The custom roles file was located in the templates directory at deployed-server/deployed-server-roles-data.yaml. The custom roles file addressed setting disable_constraints: true on each of the roles. This is no longer required starting in the train release.

Note

Previously, environment files were used to enable bootstrap tasks on the deployed servers. These files were environments/deployed-server-bootstrap-environment-centos.yaml and environments/deployed-server-bootstrap-environment-rhel.yaml. Starting in the train release, these environment files are no longer required and they have been removed from tripleo-heat-templates.

Note

Starting in the train release, support for setting DeploymentSwiftDataMap parameter and configuring deployed servers using heat has been removed.

deployed-server with config-download

When using config-download with deployed-server (pre-provisioned nodes), a HostnameMap parameter must be provided. Create an environment file to define the parameter, and assign the node hostnames in the parameter value. The following example shows a sample value:

parameter_defaults:
  HostnameMap:
    overcloud-controller-0: controller-00-rack01
    overcloud-controller-1: controller-01-rack02
    overcloud-controller-2: controller-02-rack03
    overcloud-novacompute-0: compute-00-rack01
    overcloud-novacompute-1: compute-01-rack01
    overcloud-novacompute-2: compute-02-rack01

Write the contents to an environment file such as hostnamemap.yaml, and pass it the environment as part of the deployment command. It’s imperative that the HostnameMap keys correspond to the HostnameFormatDefault for the appropriate role. For example, using overcloud-controller-0 matches HostnameFormatDefault: '%stackname%-controller-%index%' in the Controller role. Similarly, overcloud-novacompute-0 matches HostnameFormatDefault: '%stackname%-novacompute-%index%' for the Compute role. If you decide to change the HostnameFormatDefault to a different value, you’ll need to account for this in your hostnamemap.yaml file. Mismatched values between the HostnameMap keys and HostnameFormatDefault causes failures during overcloud installation because TripleO can’t find the appropriate hosts, as it’s using the wrong names.

Network Configuration

The default network interface configuration mappings for the deployed-server roles are:

OS::TripleO::ControllerDeployedServer::Net::SoftwareConfig: net-config-static-bridge.yaml
OS::TripleO::ComputeDeployedServer::Net::SoftwareConfig: net-config-static.yaml
OS::TripleO::BlockStorageDeployedServer::Net::SoftwareConfig: net-config-static.yaml
OS::TripleO::ObjectStorageDeployedServer::Net::SoftwareConfig: net-config-static.yaml
OS::TripleO::CephStorageDeployedServer::Net::SoftwareConfig: net-config-static.yaml

The default NIC configs use static IP assignment instead of the default of DHCP. This is due to there being no requirement of L2 connectivity between the undercloud and overcloud. However, the NIC config templates can be overridden to use whatever configuration is desired (including DHCP).

As is the case when not using deployed-servers, the following parameters need to also be specified:

parameter_defaults:
  NeutronPublicInterface: eth1
  ControlPlaneDefaultRoute: 192.168.24.1
  EC2MetadataIp: 192.168.24.1

ControlPlaneDefaultRoute and EC2MetadataIp are not necessarily meaningful parameters depending on the network architecture in use with deployed servers. However, they still must be specified as they are required parameters for the template interface.

The DeployedServerPortMap parameter can be used to assign fixed IP’s from either the ctlplane network or the IP address range for the overcloud.

If the deployed servers were preconfigured with IP addresses from the ctlplane network for the initial undercloud connectivity, then the same IP addresses can be reused during the overcloud deployment. Add the following to a new environment file and specify the environment file as part of the deployment command:

resource_registry:
  OS::TripleO::DeployedServer::ControlPlanePort: ../deployed-server/deployed-neutron-port.yaml
parameter_defaults:
  DeployedServerPortMap:
    controller0-ctlplane:
      fixed_ips:
        - ip_address: 192.168.24.9
      subnets:
        - cidr: 192.168.24.0/24
      network:
        tags:
          - 192.168.24.0/24
    compute0-ctlplane:
      fixed_ips:
        - ip_address: 192.168.24.8
      subnets:
        - cidr: 192.168.24..0/24
      network:
        tags:
          - 192.168.24.0/24

The value of the DeployedServerPortMap variable is a map. The keys correspond to the <short hostname>-ctlplane of the deployed servers. Specify the ip addresses and subnet CIDR to be assigned under fixed_ips.

In the case where the ctlplane is not routable from the deployed servers, you can use DeployedServerPortMap to assign an IP address from any CIDR:

resource_registry:
  OS::TripleO::DeployedServer::ControlPlanePort: /usr/share/openstack-tripleo-heat-templates/deployed-server/deployed-neutron-port.yaml
  OS::TripleO::Network::Ports::ControlPlaneVipPort: /usr/share/openstack-tripleo-heat-templates/deployed-server/deployed-neutron-port.yaml

  # Set VIP's for redis and OVN to noop to default to the ctlplane VIP
  # The cltplane VIP is set with control_virtual_ip in
  # DeployedServerPortMap below.
  #
  # Alternatively, these can be mapped to deployed-neutron-port.yaml as
  # well and redis_virtual_ip and ovn_dbs_virtual_ip added to the
  # DeployedServerPortMap value to set fixed IP's.
  OS::TripleO::Network::Ports::RedisVipPort: /usr/share/openstack-tripleo-heat-templates/network/ports/noop.yaml
  OS::TripleO::Network::Ports::OVNDBsVipPort: /usr/share/openstack-tripleo-heat-templates/network/ports/noop.yaml

parameter_defaults:
  NeutronPublicInterface: eth1
  EC2MetadataIp: 192.168.100.1
  ControlPlaneDefaultRoute: 192.168.100.1

  DeployedServerPortMap:
    control_virtual_ip:
      fixed_ips:
        - ip_address: 192.168.100.1
      subnets:
        - cidr: 192.168.100.0/24
      network:
        tags:
          - 192.168.100.0/24
    controller0-ctlplane:
      fixed_ips:
        - ip_address: 192.168.100.2
      subnets:
        - cidr: 192.168.100.0/24
      network:
        tags:
          - 192.168.100.0/24
    compute0-ctlplane:
      fixed_ips:
        - ip_address: 192.168.100.3
      subnets:
        - cidr: 192.168.100.0/24
      network:
        tags:
          - 192.168.100.0/24

In the above example, notice how RedisVipPort and OVNDBsVipPort are mapped to network/ports/noop.yaml. This mapping is due to the fact that these VIP IP addresses comes from the ctlplane by default, and they will use the same VIP address that is used for ControlPlanePort. Alternatively these VIP’s can be mapped to their own fixed IP’s, in which case a VIP will be created for each. In this case, the following mappings and values would be added to the above example:

resource_registry:
  OS::TripleO::Network::Ports::RedisVipPort: /usr/share/openstack-tripleo-heat-templates/deployed-server/deployed-neutron-port.yaml
  OS::TripleO::Network::Ports::OVNDBsVipPort: /usr/share/openstack-tripleo-heat-templates/deployed-server/deployed-neutron-port.yaml

parameter_defaults:

  DeployedServerPortMap:
    redis_virtual_ip:
      fixed_ips:
        - ip_address: 192.168.100.10
      subnets:
        - cidr: 192.168.100.0/24
      network:
        tags:
          - 192.168.100.0/24
    ovn_dbs_virtual_ip:
      fixed_ips:
        - ip_address: 192.168.100.11
      subnets:
        - cidr: 192.168.100.0/24
      network:
        tags:
          - 192.168.100.0/24

The EC2MetadataIp and ControlPlaneDefaultRoute parameters are set to the value of the control virtual IP address. These parameters are required to be set by the sample NIC configs, and must be set to a pingable IP address in order to pass the validations performed during deployment. Alternatively, the NIC configs could be further customized to not require these parameters.

When using network isolation, refer to the documentation on using fixed IP addresses for further information at Predictable IPs.

Scaling the Overcloud

Scaling Up

When scaling out compute nodes, the steps to be completed by the user are as follows:

  1. Prepare the new deployed server(s) as shown in Deployed Server Requirements.

  2. Start the scale out command. See Scaling overcloud roles for reference.

Scaling Down

Train

Starting in Train and onward, openstack overcloud node delete can take a list of server hostnames instead of instance ids. However they can’t be mixed while running the command. Example: if you use hostnames, it would have to be for all the nodes to delete.

The following instructions are only useful when the cloud is deployed on Stein or backward. When scaling down the Overcloud, follow the scale down instructions as normal as shown in Deleting Overcloud Nodes, however use the following command to get the uuid values to pass to openstack overcloud node delete instead of using nova list:

openstack stack resource list overcloud -n5 --filter type=OS::TripleO::<RoleName>Server

Replace <RoleName> in the above command with the actual name of the role that you are scaling down. The stack_name column in the command output can be used to identify the uuid associated with each node. The stack_name will include the integer value of the index of the node in the Heat resource group. For example, in the following sample output:

$ openstack stack resource list overcloud -n5 --filter type=OS::TripleO::ComputeDeployedServerServer
+-----------------------+--------------------------------------+------------------------------------------+-----------------+----------------------+-------------------------------------------------------------+
| resource_name         | physical_resource_id                 | resource_type                            | resource_status | updated_time         | stack_name                                                  |
+-----------------------+--------------------------------------+------------------------------------------+-----------------+----------------------+-------------------------------------------------------------+
| ComputeDeployedServer | 66b1487c-51ee-4fd0-8d8d-26e9383207f5 | OS::TripleO::ComputeDeployedServerServer | CREATE_COMPLETE | 2017-10-31T23:45:18Z | overcloud-ComputeDeployedServer-myztzg7pn54d-0-pixawichjjl3 |
| ComputeDeployedServer | 01cf59d7-c543-4f50-95df-6562fd2ed7fb | OS::TripleO::ComputeDeployedServerServer | CREATE_COMPLETE | 2017-10-31T23:45:18Z | overcloud-ComputeDeployedServer-myztzg7pn54d-1-ooCahg1vaequ |
| ComputeDeployedServer | 278af32c-c3a4-427e-96d2-3cda7e706c50 | OS::TripleO::ComputeDeployedServerServer | CREATE_COMPLETE | 2017-10-31T23:45:18Z | overcloud-ComputeDeployedServer-myztzg7pn54d-2-xooM5jai2ees |
+-----------------------+--------------------------------------+------------------------------------------+-----------------+----------------------+-------------------------------------------------------------+

The index 0, 1, or 2 can be seen in the stack_name column. These indices correspond to the order of the nodes in the Heat resource group. Pass the corresponding uuid value from the physical_resource_id column to openstack overcloud node delete command.

The physical deployed servers that have been removed from the deployment need to be powered off. In a deployment not using deployed servers, this would typically be done with Ironic. When using deployed servers, it must be done manually, or by whatever existing power management solution is already in place. If the nodes are not powered down, they will continue to be operational and could be part of the deployment, since there are no steps to unconfigure, uninstall software, or stop services on nodes when scaling down.

Once the nodes are powered down and all needed data has been saved from the nodes, it is recommended that they be reprovisioned back to a base operating system configuration so that they do not unintentionally join the deployment in the future if they are powered back on.

Note

Do not attempt to reuse nodes that were previously removed from the deployment without first reprovisioning them using whatever provisioning tool is in place.

Deleting the Overcloud

When deleting the Overcloud, the Overcloud nodes need to be manually powered off, otherwise, the cloud will still be active and accepting any user requests.

After archiving important data (log files, saved configurations, database files), that needs to be saved from the deployment, it is recommended to reprovision the nodes to a clean base operating system. The reprovision will ensure that they do not start serving user requests, or interfere with future deployments in the case where they are powered back on in the future.

Note

As with scaling down, do not attempt to reuse nodes that were previously part of a now deleted deployment in a new deployment without first reprovisioning them using whatever provisioning tool is in place.