Fix documentation syntax and license
This command fixes several issues on the README, including syntax highlight and license. Change-Id: I750e37c00e164705df8140ccfd4c6b5c7c3151f5
This commit is contained in:
Raoul Scarazzini
parent
f17e85d3fc
commit
3631e3a90d
408
README.md
408
README.md
|
|
@ -1,5 +1,5 @@
|
|||
ansible-role-tripleo-baremetal-undercloud
|
||||
=========
|
||||
=========================================
|
||||
|
||||
This role aims to build a baremetal undercloud machine from scratch. Using tripleo-quickstart, this means that you will be able to provide, prepare and install the undercloud on a physical machine.
|
||||
|
||||
|
|
@ -26,63 +26,92 @@ Software requirements
|
|||
* Directory nic-configs - mandatory if declared inside the resource_registry section in network-environment.yaml and must contain all the needed files
|
||||
* File instackenv.json - mandatory, must contain the ipmi credentials for the nodes
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
Quickstart invocation
|
||||
---------------------
|
||||
|
||||
You can invoke *quickstart.sh* like this:
|
||||
|
||||
```console
|
||||
./quickstart.sh \
|
||||
--clean \
|
||||
--playbook baremetal-undercloud-validate-ha.yml \
|
||||
--working-dir /path/to/workdir \
|
||||
--requirements /path/to/quickstart-extras-requirements.txt \
|
||||
--config /path/to/config.yml \
|
||||
--release <RELEASE> \
|
||||
--tags all \
|
||||
<HOSTNAME or IP>
|
||||
```
|
||||
|
||||
Basically this command:
|
||||
|
||||
* Uses the playbook **baremetal-undercloud.yml**
|
||||
* Uses a custom workdir that is rebuilt from scratch (so if it already exists, it is dropped, see *--clean*)
|
||||
* Get all the extra requirements
|
||||
* Select the config file
|
||||
* Chooses release (liberty, mitaka or “master” for newton)
|
||||
* Performs all the tasks in the playbook
|
||||
* Starts the installation on virthost
|
||||
|
||||
Role usage
|
||||
----------
|
||||
|
||||
A typical config file will contain something like this:
|
||||
|
||||
undercloud_type: baremetal
|
||||
|
||||
# Specify the secondary net interface for overcloud provisioning
|
||||
undercloud_local_interface: eth1
|
||||
|
||||
# Specify the external network for undercloud that will be used to route overcloud traffic
|
||||
undercloud_external_network_cidr: 172.20.0.0/24
|
||||
|
||||
# Declare the additional interface on undercloud to route overcloud traffic
|
||||
undercloud_networks:
|
||||
external:
|
||||
address: 172.20.0.254
|
||||
netmask: 255.255.255.0
|
||||
device_type: ovs
|
||||
type: OVSIntPort
|
||||
ovs_bridge: br-ctlplane
|
||||
ovs_options: '"tag=1105"'
|
||||
tag: 1105
|
||||
|
||||
# Define all the flavors
|
||||
flavor_map:
|
||||
control: baremetal
|
||||
compute: baremetal
|
||||
storage: baremetal
|
||||
ceph: baremetal
|
||||
swift: baremetal
|
||||
```yaml
|
||||
undercloud_type: baremetal
|
||||
|
||||
# To be used ansible-role-tripleo-baremetal-undercloud
|
||||
step_provide_undercloud: true
|
||||
# To be used in ansible-role-tripleo-overcloud-prep-baremetal
|
||||
step_install_upstream_ipxe: true
|
||||
# To be used in ansible-role-tripleo-overcloud-prep-images
|
||||
step_introspect: true
|
||||
|
||||
# Explicitly declare kvm since we are on BM
|
||||
libvirt_type: kvm
|
||||
libvirt_args: "--libvirt-type kvm"
|
||||
|
||||
# Environment specific variables
|
||||
baremetal_provisioning_script: "/path/to/undercloud-provisioning.sh"
|
||||
baremetal_network_environment: "/path/to/network-environment.yaml"
|
||||
baremetal_instackenv: "/path/to/instackenv.json"
|
||||
baremetal_nic_configs: "/path/to/nic_configs"
|
||||
|
||||
# Public (Floating) network definition
|
||||
public_physical_network: "floating"
|
||||
floating_ip_cidr: "<FLOATING NETWORK CIDR>"
|
||||
public_net_pool_start: "<FLOATING NETWORK POOL START>"
|
||||
public_net_pool_end: "<FLOATING NETWORK POOL END>"
|
||||
public_net_gateway: "<FLOATING NETWORK GATEWAY>"
|
||||
|
||||
extra_args: "--ntp-server <NTP SERVER IP> --control-scale 3 --compute-scale 2 --ceph-storage-scale 0 --block-storage-scale 0 --swift-storage-scale 0 --templates -e /usr/share/openstack-tripleo-heat-templates/environments/puppet-pacemaker.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/network-isolation.yaml -e /home/stack/network-environment.yaml --neutron-bridge-mappings datacentre:br-floating"
|
||||
# Specify the secondary net interface for overcloud provisioning
|
||||
undercloud_local_interface: eth1
|
||||
|
||||
# Specify the external network for undercloud that will be used to route overcloud traffic
|
||||
undercloud_external_network_cidr: 172.20.0.0/24
|
||||
|
||||
# Declare the additional interface on undercloud to route overcloud traffic
|
||||
undercloud_networks:
|
||||
external:
|
||||
address: 172.20.0.254
|
||||
netmask: 255.255.255.0
|
||||
device_type: ovs
|
||||
type: OVSIntPort
|
||||
ovs_bridge: br-ctlplane
|
||||
ovs_options: '"tag=1105"'
|
||||
tag: 1105
|
||||
|
||||
# Define all the flavors
|
||||
flavor_map:
|
||||
control: baremetal
|
||||
compute: baremetal
|
||||
storage: baremetal
|
||||
ceph: baremetal
|
||||
swift: baremetal
|
||||
|
||||
# To be used ansible-role-tripleo-baremetal-undercloud
|
||||
step_provide_undercloud: true
|
||||
# To be used in ansible-role-tripleo-overcloud-prep-baremetal
|
||||
step_install_upstream_ipxe: true
|
||||
# To be used in ansible-role-tripleo-overcloud-prep-images
|
||||
step_introspect: true
|
||||
|
||||
# Explicitly declare kvm since we are on BM
|
||||
libvirt_type: kvm
|
||||
libvirt_args: "--libvirt-type kvm"
|
||||
|
||||
# Environment specific variables
|
||||
baremetal_provisioning_script: "/path/to/undercloud-provisioning.sh"
|
||||
baremetal_network_environment: "/path/to/network-environment.yaml"
|
||||
baremetal_instackenv: "/path/to/instackenv.json"
|
||||
baremetal_nic_configs: "/path/to/nic_configs"
|
||||
|
||||
# Public (Floating) network definition
|
||||
public_physical_network: "floating"
|
||||
floating_ip_cidr: "<FLOATING NETWORK CIDR>"
|
||||
public_net_pool_start: "<FLOATING NETWORK POOL START>"
|
||||
public_net_pool_end: "<FLOATING NETWORK POOL END>"
|
||||
public_net_gateway: "<FLOATING NETWORK GATEWAY>"
|
||||
|
||||
extra_args: "--ntp-server <NTP SERVER IP> --control-scale 3 --compute-scale 2 --ceph-storage-scale 0 --block-storage-scale 0 --swift-storage-scale 0 --templates -e /usr/share/openstack-tripleo-heat-templates/environments/puppet-pacemaker.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/network-isolation.yaml -e /home/stack/network-environment.yaml --neutron-bridge-mappings datacentre:br-floating"
|
||||
```
|
||||
|
||||
A brief explanation of the variables:
|
||||
|
||||
|
|
@ -101,30 +130,32 @@ A brief explanation of the variables:
|
|||
|
||||
The main task of the role is this one:
|
||||
|
||||
---
|
||||
# tasks file for ansible-role-tripleo-baremetal-undercloud
|
||||
|
||||
# Do machine provisioning
|
||||
- include: machine-provisioning.yml
|
||||
tags:
|
||||
- machine-provision
|
||||
|
||||
# Prepare machine to be used with TripleO
|
||||
- include: machine-setup.yml
|
||||
tags:
|
||||
- machine-setup
|
||||
|
||||
# Configure repos and packages
|
||||
- include: undercloud-repos-conf.yml
|
||||
delegate_to: "{{ virthost }}"
|
||||
tags:
|
||||
- undercloud-repos-conf
|
||||
|
||||
# Get overcloud images
|
||||
- include: overcloud-images.yml
|
||||
delegate_to: "{{ virthost }}"
|
||||
tags:
|
||||
- overcloud-images
|
||||
```yaml
|
||||
---
|
||||
# tasks file for ansible-role-tripleo-baremetal-undercloud
|
||||
|
||||
# Do machine provisioning
|
||||
- include: machine-provisioning.yml
|
||||
tags:
|
||||
- machine-provision
|
||||
|
||||
# Prepare machine to be used with TripleO
|
||||
- include: machine-setup.yml
|
||||
tags:
|
||||
- machine-setup
|
||||
|
||||
# Configure repos and packages
|
||||
- include: undercloud-repos-conf.yml
|
||||
delegate_to: "{{ virthost }}"
|
||||
tags:
|
||||
- undercloud-repos-conf
|
||||
|
||||
# Get overcloud images
|
||||
- include: overcloud-images.yml
|
||||
delegate_to: "{{ virthost }}"
|
||||
tags:
|
||||
- overcloud-images
|
||||
```
|
||||
|
||||
This is basically what each specific tasks does:
|
||||
|
||||
|
|
@ -161,109 +192,110 @@ Example Playbook
|
|||
|
||||
Here's is an example on host to use this role in combination to all the others coming from various related to tripleo-quickstart:
|
||||
|
||||
---
|
||||
# Provision and initial undercloud setup
|
||||
- name: Baremetal undercloud install
|
||||
hosts: localhost
|
||||
roles:
|
||||
- tripleo-baremetal-undercloud
|
||||
tags:
|
||||
- undercloud-bm-install
|
||||
|
||||
# Machine at this point is provided
|
||||
- name: Add the undercloud node to the generated inventory
|
||||
hosts: localhost
|
||||
gather_facts: yes
|
||||
tags:
|
||||
- undercloud-scripts
|
||||
roles:
|
||||
- tripleo-inventory
|
||||
|
||||
# Deploy the undercloud
|
||||
- name: Install undercloud
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
tags:
|
||||
- undercloud-install
|
||||
roles:
|
||||
- tripleo/undercloud
|
||||
|
||||
# Baremetal preparation (with workarounds)
|
||||
- name: Prepare baremetal for the overcloud deployment
|
||||
hosts: undercloud
|
||||
roles:
|
||||
- overcloud-prep-baremetal
|
||||
tags:
|
||||
- overcloud-prep-baremetal
|
||||
|
||||
# Prepare any additional configuration files required by the overcloud
|
||||
- name: Prepare configuration files for the overcloud deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-config
|
||||
|
||||
# Prepare the overcloud images for deployment
|
||||
- name: Prepare the overcloud images for deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-images
|
||||
|
||||
# Prepare the overcloud flavor configuration
|
||||
- name: Prepare overcloud flavors
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-flavors
|
||||
|
||||
# Prepare the undercloud networks for the overcloud deployment
|
||||
- name: Prepare the undercloud networks for the overcloud deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-network
|
||||
|
||||
# Deploy the overcloud
|
||||
- name: Deploy the overcloud
|
||||
hosts: undercloud
|
||||
gather_facts: yes
|
||||
roles:
|
||||
- tripleo-overcloud
|
||||
|
||||
- name: Add the overcloud nodes to the generated inventory
|
||||
hosts: undercloud
|
||||
gather_facts: yes
|
||||
tags:
|
||||
- overcloud-deploy
|
||||
vars:
|
||||
inventory: all
|
||||
roles:
|
||||
- tripleo-inventory
|
||||
|
||||
# Check the results of the deployment, note after inventory has executed
|
||||
- name: Check the result of the deployment
|
||||
hosts: localhost
|
||||
tags:
|
||||
- overcloud-deploy
|
||||
tasks:
|
||||
- name: ensure the deployment result has been read into memory
|
||||
include_vars: "{{ local_working_dir }}/overcloud_deployment_result.json"
|
||||
|
||||
# overcloud_deploy_result = ["failed", "passed"]
|
||||
- name: did the deployment pass or fail?
|
||||
debug: var=overcloud_deploy_result
|
||||
failed_when: overcloud_deploy_result == "failed"
|
||||
|
||||
# HA Validation
|
||||
- name: Validate the overcloud using HA tests
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- tripleo-overcloud-validate-ha
|
||||
tags:
|
||||
- overcloud-validate-ha
|
||||
```yaml
|
||||
---
|
||||
# Provision and initial undercloud setup
|
||||
- name: Baremetal undercloud install
|
||||
hosts: localhost
|
||||
roles:
|
||||
- tripleo-baremetal-undercloud
|
||||
tags:
|
||||
- undercloud-bm-install
|
||||
|
||||
# Machine at this point is provided
|
||||
- name: Add the undercloud node to the generated inventory
|
||||
hosts: localhost
|
||||
gather_facts: yes
|
||||
tags:
|
||||
- undercloud-scripts
|
||||
roles:
|
||||
- tripleo-inventory
|
||||
|
||||
# Deploy the undercloud
|
||||
- name: Install undercloud
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
tags:
|
||||
- undercloud-install
|
||||
roles:
|
||||
- tripleo/undercloud
|
||||
|
||||
# Baremetal preparation (with workarounds)
|
||||
- name: Prepare baremetal for the overcloud deployment
|
||||
hosts: undercloud
|
||||
roles:
|
||||
- overcloud-prep-baremetal
|
||||
tags:
|
||||
- overcloud-prep-baremetal
|
||||
|
||||
# Prepare any additional configuration files required by the overcloud
|
||||
- name: Prepare configuration files for the overcloud deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-config
|
||||
|
||||
# Prepare the overcloud images for deployment
|
||||
- name: Prepare the overcloud images for deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-images
|
||||
|
||||
# Prepare the overcloud flavor configuration
|
||||
- name: Prepare overcloud flavors
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-flavors
|
||||
|
||||
# Prepare the undercloud networks for the overcloud deployment
|
||||
- name: Prepare the undercloud networks for the overcloud deployment
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- overcloud-prep-network
|
||||
|
||||
# Deploy the overcloud
|
||||
- name: Deploy the overcloud
|
||||
hosts: undercloud
|
||||
gather_facts: yes
|
||||
roles:
|
||||
- tripleo-overcloud
|
||||
|
||||
- name: Add the overcloud nodes to the generated inventory
|
||||
hosts: undercloud
|
||||
gather_facts: yes
|
||||
tags:
|
||||
- overcloud-deploy
|
||||
vars:
|
||||
inventory: all
|
||||
roles:
|
||||
- tripleo-inventory
|
||||
|
||||
# Check the results of the deployment, note after inventory has executed
|
||||
- name: Check the result of the deployment
|
||||
hosts: localhost
|
||||
tags:
|
||||
- overcloud-deploy
|
||||
tasks:
|
||||
- name: ensure the deployment result has been read into memory
|
||||
include_vars: "{{ local_working_dir }}/overcloud_deployment_result.json"
|
||||
|
||||
# overcloud_deploy_result = ["failed", "passed"]
|
||||
- name: did the deployment pass or fail?
|
||||
debug: var=overcloud_deploy_result
|
||||
failed_when: overcloud_deploy_result == "failed"
|
||||
|
||||
# HA Validation
|
||||
- name: Validate the overcloud using HA tests
|
||||
hosts: undercloud
|
||||
gather_facts: no
|
||||
roles:
|
||||
- tripleo-overcloud-validate-ha
|
||||
tags:
|
||||
- overcloud-validate-ha
|
||||
```
|
||||
|
||||
The steps of the sample playbook are these:
|
||||
|
||||
|
|
@ -272,24 +304,10 @@ The steps of the sample playbook are these:
|
|||
* Undercloud is prepared for deploying
|
||||
* Overcloud is then deployed, inventoried and validated
|
||||
|
||||
So you can invoke *quickstart.sh* like this:
|
||||
|
||||
./quickstart.sh -v --clean --playbook baremetal-undercloud-validate-ha.yml --working-dir /path/to/workdir --requirements /path/to/quickstart-extras-requirements.txt --config /path/to/config.yml --release <RELEASE> --tags all <HOSTNAME or IP>
|
||||
|
||||
Basically this command:
|
||||
|
||||
* Uses the playbook **baremetal-undercloud.yml**
|
||||
* Uses a custom workdir that is rebuilt from scratch (so if it already exists, it is dropped)
|
||||
* Get all the extra requirements
|
||||
* Select the config file
|
||||
* Chooses release (liberty, mitaka or “master” for newton)
|
||||
* Performs all the tasks in the playbook
|
||||
* Starts the installation on virthost
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
Apache
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
|
|
|||
Loading…
Reference in New Issue