tripleo-heat-templates/roles
Emilien Macchi d86025593b Handle undercloud upgrades via host_prep_tasks
Using host_prep_tasks interface to handle undercloud teardown before we
run the undercloud install.
The reason of not using upgrade_tasks is because the existing tasks were
created for the overcloud upgrade first and there are too much logic
right now so we can easily re-use the bits for the undercloud. In the
future, we'll probably use upgrade_tasks for both the undercloud and
overcloud but right now this is not possible and a simple way to move
forward was to implement these tasks that work fine for the undercloud
containerization case.

Workflow will be:
- Services will be stopped and disabled (except mariadb)
- Neutron DB will be renamed, then mariadb stopped & disabled
- Remove cron jobs
- All packages will be upgraded with yum update.

Change-Id: I36be7f398dcd91e332687c6222b3ccbb9cd74ad2
2018-04-12 18:14:28 -07:00
..
BlockStorage.yaml Fix invalid Ceph and BlockStorage role template 2018-02-22 11:08:36 +01:00
CephAll.yaml remove OS::TripleO::Services::CephClient from CephAll 2018-03-26 02:35:53 +00:00
CephFile.yaml Add PTP composable service 2018-02-08 15:20:17 +08:00
CephObject.yaml Add PTP composable service 2018-02-08 15:20:17 +08:00
CephStorage.yaml Fix invalid Ceph and BlockStorage role template 2018-02-22 11:08:36 +01:00
Compute.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeAlt.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeHCI.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeInstanceHA.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeLiquidio.yaml Removed unnecessary services from the LiquidioCompute role. 2018-04-10 15:36:24 +05:30
ComputeOvsDpdk.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeOvsDpdkRT.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeRealTime.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeSriov.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
ComputeSriovRT.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
Controller.yaml Designate Integration 2018-03-27 15:45:39 +00:00
ControllerAllNovaStandalone.yaml Designate Integration 2018-03-27 15:45:39 +00:00
ControllerNoCeph.yaml Designate Integration 2018-03-27 15:45:39 +00:00
ControllerNovaStandalone.yaml Merge "FFU: Fix glance tasks" 2018-03-19 08:23:35 +00:00
ControllerOpenstack.yaml Designate Integration 2018-03-27 15:45:39 +00:00
ControllerStorageNfs.yaml Merge "FFU: Fix glance tasks" 2018-03-19 08:23:35 +00:00
Database.yaml Implements AIDE Intrusion Detection System 2018-01-15 13:10:16 +00:00
HciCephAll.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
HciCephFile.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
HciCephMon.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
HciCephObject.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
IronicConductor.yaml Implements AIDE Intrusion Detection System 2018-01-15 13:10:16 +00:00
Messaging.yaml Implements AIDE Intrusion Detection System 2018-01-15 13:10:16 +00:00
Networker.yaml Add OVNController service to Networker role 2018-01-25 15:45:27 +01:00
Novacontrol.yaml Introduce OS::TripleO::Services::Rhsm 2017-12-27 11:03:49 -08:00
ObjectStorage.yaml Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
README.rst Remove no longer used disable_upgrade_deployment flag 2018-03-29 15:27:30 +03:00
Telemetry.yaml Include pacemaker in Telemetry role 2018-03-22 11:40:55 +00:00
Undercloud.yaml Handle undercloud upgrades via host_prep_tasks 2018-04-12 18:14:28 -07:00
UndercloudLight.yaml Implement MasqueradeNetworks services 2018-03-27 17:22:02 +02:00

Roles

The yaml files in this directory can be combined into a single roles_data.yaml and be used with TripleO to create custom deployments.

Use tripleoclient to build your own custom roles_data.yaml for your environment.

roles_data.yaml

The roles_data.yaml specifies which roles (groups of nodes) will be deployed. Note this file is used as an input the the various *.j2.yaml jinja2 templates, so that they are converted into *.yaml during the plan creation. This occurs via a mistral action/workflow. The file format of this file is a yaml list.

Role YAML files

Each role yaml file should contain only a single role. The filename should match the role name. The name of the role is mandatory and must be unique.

The role files in this folder should contain at least a role name and the default list of services for the role.

Role Options

  • CountDefault: (number) optional, default number of nodes, defaults to 0 sets the default for the {{role.name}}Count parameter in overcloud.yaml
  • HostnameFormatDefault: (string) optional default format string for hostname defaults to '%stackname%-{{role.name.lower()}}-%index%' sets the default for {{role.name}}HostnameFormat parameter in overcloud.yaml
  • ImageDefault: (string) optional default image name or ID, defaults to overcloud-full
  • FlavorDefault: (string) optional default flavor name or ID, defaults to baremetal
  • RoleParametersDefault: (map) optional default to the per-role RoleParameters value, this enables roles to specify specific values appropriate to their configuration, defaults to an empty map.
  • disable_constraints: (boolean) optional, whether to disable Nova and Glance constraints for each role specified in the templates.
  • upgrade_batch_size: (number): batch size for upgrades where tasks are specified by services to run in batches vs all nodes at once. This defaults to 1, but larger batches may be specified here.
  • ServicesDefault: (list) optional default list of services to be deployed on the role, defaults to an empty list. Sets the default for the {{role.name}}Services parameter in overcloud.yaml
  • tags: (list) list of tags used by other parts of the deployment process to find the role for a specific type of functionality. Currently a role with both 'primary' and 'controller' is used as the primary role for the deployment process. If no roles have have 'primary' and 'controller', the first role in this file is used as the primary role.
  • description: (string) as few sentences describing the role and information pertaining to the usage of the role.
  • networks: (list), optional list of networks which the role will have access to when network isolation is enabled. The names should match those defined in network_data.yaml.
  • networks_skip_config: (list), optional list of networks for which the configuration would be skipped for the role. The names should match those defined in network_data.yaml

Working with Roles

The tripleoclient provides a series of commands that can be used to view roles and generate a roles_data.yaml file for deployment.

Listing Available Roles

The openstack overcloud role list command can be used to view the list of roles provided by tripleo-heat-templates.

Usage

usage: openstack overcloud role list [-h] [--roles-path <roles directory>]

List availables roles

optional arguments:
  -h, --help            show this help message and exit
  --roles-path <roles directory>
                        Filesystem path containing the role yaml files. By
                        default this is /usr/share/openstack-tripleo-heat-
                        templates/roles

Example

[user@host ~]$ openstack overcloud role list
BlockStorage
CephStorage
Compute
ComputeOvsDpdk
ComputeSriov
Controller
ControllerOpenstack
Database
Messaging
Networker
ObjectStorage
Telemetry
Undercloud

Viewing Role Details

The openstack overcloud role show command can be used as a quick way to view some of the information about a role.

Usage

usage: openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

Show information about a given role

positional arguments:
  <role>                Role to display more information about.

optional arguments:
  -h, --help            show this help message and exit
  --roles-path <roles directory>
                        Filesystem path containing the role yaml files. By
                        default this is /usr/share/openstack-tripleo-heat-
                        templates/roles

Example

[user@host ~]$ openstack overcloud role show Compute
###############################################################################
# Role Data for 'Compute'
###############################################################################
HostnameFormatDefault: '%stackname%-novacompute-%index%'
ServicesDefault:
 * OS::TripleO::Services::AuditD
 * OS::TripleO::Services::CACerts
 * OS::TripleO::Services::CephClient
 * OS::TripleO::Services::CephExternal
 * OS::TripleO::Services::CertmongerUser
 * OS::TripleO::Services::Collectd
 * OS::TripleO::Services::ComputeCeilometerAgent
 * OS::TripleO::Services::ComputeNeutronCorePlugin
 * OS::TripleO::Services::ComputeNeutronL3Agent
 * OS::TripleO::Services::ComputeNeutronMetadataAgent
 * OS::TripleO::Services::ComputeNeutronOvsAgent
 * OS::TripleO::Services::Docker
 * OS::TripleO::Services::Fluentd
 * OS::TripleO::Services::Iscsid
 * OS::TripleO::Services::Kernel
 * OS::TripleO::Services::MySQLClient
 * OS::TripleO::Services::NeutronSriovAgent
 * OS::TripleO::Services::NeutronVppAgent
 * OS::TripleO::Services::NovaCompute
 * OS::TripleO::Services::NovaLibvirt
 * OS::TripleO::Services::NovaMigrationTarget
 * OS::TripleO::Services::Ntp
 * OS::TripleO::Services::OpenDaylightOvs
 * OS::TripleO::Services::Securetty
 * OS::TripleO::Services::SensuClient
 * OS::TripleO::Services::Snmp
 * OS::TripleO::Services::Sshd
 * OS::TripleO::Services::Timezone
 * OS::TripleO::Services::TripleoFirewall
 * OS::TripleO::Services::TripleoPackages
 * OS::TripleO::Services::Vpp
name: 'Compute'

Generate roles_data.yaml

The openstack overcloud roles generate command can be used to generate a roles_data.yaml file for deployments.

Usage

usage: openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>]
                                          <role> [<role> ...]

Generate roles_data.yaml file

positional arguments:
  <role>                List of roles to use to generate the roles_data.yaml
                        file for the deployment. NOTE: Ordering is important
                        if no role has the "primary" and "controller" tags. If
                        no role is tagged then the first role listed will be
                        considered the primary role. This usually is the
                        controller role.

optional arguments:
  -h, --help            show this help message and exit
  --roles-path <roles directory>
                        Filesystem path containing the role yaml files. By
                        default this is /usr/share/openstack-tripleo-heat-
                        templates/roles
  -o <output file>, --output-file <output file>
                        File to capture all output to. For example,
                        roles_data.yaml

Example

[user@host ~]$ openstack overcloud roles generate -o roles_data.yaml Controller Compute BlockStorage ObjectStorage CephStorage