OpenStack Documentation

https://docs.openstack.org/
Admin
Complete documentation repository for OpenStack, a cloud operating system that manages compute,...
Tokens:16,538,286
Snippets:169,977
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Generate installation guide skeleton

Source: https://docs.openstack.org/doc-contrib-guide/project-install-guide.html

Run the cookiecutter template to create the directory structure for the project installation guide.

```bash
$ cookiecutter https://opendev.org/openstack/installguide-cookiecutter.git

```

--------------------------------

### Example Output of Setup Scripts

Source: https://docs.openstack.org/tacker/latest/reference/script_ft_v1.html

Sample output generated after executing the setup scripts.

```text
stack@controller:~$ ./openstack-controller.sh
d02ebf6e-9b4b-474f-9eb4-6492454653d4
    Manager "ptcp:6640:127.0.0.1"
        is_connected: true
    Bridge br-ex
        Port eth1
            Interface eth1
        Port br-ex
            Interface br-ex
                type: internal
    Bridge br-int
        fail_mode: secure
        datapath_type: system
        Port ovn-0d4c53-0
            Interface ovn-0d4c53-0
                type: geneve
                options: {csum="true", key=flow, remote_ip="192.168.56.12"}
        Port ovn-19aa8a-0
            Interface ovn-19aa8a-0
                type: geneve
                options: {csum="true", key=flow, remote_ip="192.168.56.14"}
        Port br-int
            Interface br-int
                type: internal
        Port ovn-b5aa08-0
            Interface ovn-b5aa08-0
                type: geneve
                options: {csum="true", key=flow, remote_ip="192.168.56.13"}
    ovs_version: "2.17.9"
mysql: [Warning] Using a password on the command line interface can be insecure.
host    hypervisor_hostname     mapped  uuid
compute1        compute1        0       36fa9820-f25d-4ee9-8ec6-348c61230367
compute2        compute2        0       52cb3474-aaba-4168-bcbe-d5eb2ec9c2d2
INFO dbcounter [None req-fa994509-fb86-4112-a675-88f62d29f404 None None] Registered counter for database nova_api
DEBUG dbcounter [-] [102425] Writer thread running {{(pid=102425) stat_writer /opt/stack/data/venv/lib/python3.10/site-packages/dbcounter.py:102}}
INFO dbcounter [None req-fa994509-fb86-4112-a675-88f62d29f404 None None] Registered counter for database nova_cell1
DEBUG dbcounter [-] [102425] Writer thread running {{(pid=102425) stat_writer /opt/stack/data/venv/lib/python3.10/site-packages/dbcounter.py:102}}
mysql: [Warning] Using a password on the command line interface can be insecure.
host    hypervisor_hostname     mapped  uuid
compute1        compute1        1       36fa9820-f25d-4ee9-8ec6-348c61230367
compute2        compute2        1       52cb3474-aaba-4168-bcbe-d5eb2ec9c2d2
```

--------------------------------

### Install Undercloud

Source: https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/features/tls-everywhere.html

Start the undercloud installation process after verifying all configuration options.

```bash
$ openstack undercloud install

```

--------------------------------

### Install Freezer from Source

Source: https://docs.openstack.org/freezer/latest/admin/agent-scheduler-install.html

Execute the setup script to install the Freezer Agent on the system.

```bash
sudo python setup.py install
```

--------------------------------

### Setup from source

Source: https://docs.openstack.org/python-designateclient/latest/install/index.html

Clone the repository and install the package from source to obtain the latest features.

```bash
git clone git@github.com:openstack/python-designateclient.git
cd python-designateclient
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py install
```

--------------------------------

### Example Keystone Installation Playbook

Source: https://docs.openstack.org/openstack-ansible-os_keystone/2023.1

An Ansible playbook demonstrating the installation and setup of the Keystone role, including numerous configuration variables.

```yaml
---
- name: Installation and setup of Keystone
  hosts: keystone_all
  user: root
  roles:
    - { role: "os_keystone", tags: [ "os-keystone" ] }
  vars:
    external_lb_vip_address: 10.100.100.102
    internal_lb_vip_address: 10.100.100.102
    keystone_galera_address: 10.100.100.101
    keystone_galera_database: keystone
    keystone_venv_tag: "testing"
    keystone_developer_mode: true
    keystone_git_install_branch: master
    keystone_auth_admin_password: "SuperSecretePassword"
    keystone_oslomsg_rpc_password: "secrete"
    keystone_oslomsg_notify_password: "secrete"
    keystone_container_mysql_password: "SuperSecrete"
    keystone_oslomsg_rpc_transport: rabbit
    keystone_oslomsg_rpc_servers: 10.100.100.101
    keystone_oslomsg_rpc_port: 5671
    keystone_oslomsg_rpc_use_ssl: true
    keystone_oslomsg_rpc_userid: keystone
    keystone_oslomsg_rpc_vhost: /keystone
    keystone_oslomsg_notify_transport: rabbit
    keystone_oslomsg_notify_servers: 10.100.100.101
    keystone_oslomsg_notify_port: 5671
    keystone_oslomsg_notify_use_ssl: true
    keystone_oslomsg_notify_userid: keystone
    keystone_oslomsg_notify_vhost: /keystone
    galera_client_drop_config_file: false
    galera_root_user: root
  vars_prompt:
    - name: "galera_root_password"
      prompt: "What is galera_root_password?"


```

--------------------------------

### Example setup.cfg configuration

Source: https://docs.openstack.org/pbr/latest/user/using.html

A comprehensive example of project metadata and options defined in setup.cfg.

```ini
[metadata]
name = my_project
description = A brief one-line descriptive title of my project
author = John Doe
author_email = john@example.com
classifiers =
    Development Status :: 5 - Production/Stable
    Environment :: Console
    Intended Audience :: Developers
    Intended Audience :: Information Technology
    License :: OSI Approved :: Apache Software License
    Operating System :: OS Independent
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Programming Language :: Python :: 3.12
    Programming Language :: Python :: 3.13
    Topic :: Utilities
keywords = commandline utility
long_description = file: README.rst
long_description_content_type = text/x-rst; charset=UTF-8
project_urls =
    Homepage = https://my-project.example.org/
    Bug Tracker = https://my-project.example.org/bugs/
    Documentation = https://my-project.example.org/docs/
    Release Notes = https://my-project.example.org/releasenotes/
    Source Code = https://my-project.example.org/code/

[options]
python_requires = >=3.10
packages =
    my_project

[options.entry_points]
console_scripts =
    my-project = my_project.cmd:main
```

--------------------------------

### Retrieve Swift installation info

Source: https://docs.openstack.org/swift/latest/middleware.html

Example JSON response from a GET request to the /info endpoint.

```json
{"swift": {"version": "1.11.0"}, "staticweb": {}, "tempurl": {}}
```

--------------------------------

### Bootstrap and Start Bifrost Services

Source: https://docs.openstack.org/kolla-ansible/latest/reference/deployment-and-bootstrapping/bifrost.html

Run the environment setup script and execute the Ansible playbook to install Bifrost services.

```bash
cd /bifrost
./scripts/env-setup.sh
export OS_CLOUD=bifrost
cat > /etc/rabbitmq/rabbitmq-env.conf << EOF
HOME=/var/lib/rabbitmq
EOF
ansible-playbook -vvvv \
-i /bifrost/playbooks/inventory/target \
/bifrost/playbooks/install.yaml \
-e @/etc/bifrost/bifrost.yml \
-e @/etc/bifrost/dib.yml \
-e skip_package_install=true
```

--------------------------------

### Standard setuptools project structure and setup.py

Source: https://docs.openstack.org/pbr/latest/user/features.html

Example of a traditional project structure and the corresponding setup.py file using standard setuptools.

```bash
$ tree -L 1
.
├── AUTHORS
├── CHANGES
├── LICENSE
├── MANIFEST.in
├── README.rst
├── requirements.txt
├── setup.cfg
├── setup.py
└── somepackage
```

```python
$ cat setup.py
setuptools.setup(
    name='mypackage',
    version='1.0.0',
    description='A short description',
    long_description="""A much longer description...""",
    author="John Doe",
    author_email='john.doe@example.com',
    license='BSD',
)
```

--------------------------------

### Create installation instance

Source: https://docs.openstack.org/openstack-ansible-os_nova/latest/operational-tips/install-from-iso.html

Launches an instance with a CD-ROM and a target blank volume for OS installation.

```bash
openstack server create \
    --flavor my_flavor \
    --block-device source_type=blank,destination_type=volume,volume_size=20,boot_index=1 \
    --block-device source_type=image,uuid=<IMAGE_ID>,destination_type=volume,volume_size=2,disk_bus=ide,device_type=cdrom,boot_index=0 \
    --network <NETWORK_ID> \
    install-vm
```

--------------------------------

### Basic Swift Configuration Example

Source: https://docs.openstack.org/openstack-ansible-os_swift/2023.1

An example of a basic Swift configuration, specifying storage network, replication network, drives, mount point, and storage policies. This serves as a starting point for cluster setup.

```yaml
swift:
  part_power: 8
  storage_network: 'br-storage'
  replication_network: 'br-storage'
  drives:
    - name: swift1.img
    - name: swift2.img
    - name: swift3.img
  mount_point: /srv
  storage_policies:
    - policy:
        name: default
        index: 0
        default: True
```

--------------------------------

### Etcd Get Metrics Setup

Source: https://docs.openstack.org/developer/performance-docs/methodologies/monitoring/index.html

Prepares to fetch etcd metrics by locating `etcdctl`, `jq`, and `curl`, and identifying leader and slave endpoints. Exits if `jq` or `curl` are not installed.

```bash
#!/bin/bash -e

ETCD=/usr/local/bin/etcdctl

type jq >/dev/null 2>&1 || ( echo "Jq is not installed" ; exit 1 )
type curl >/dev/null 2>&1 || ( echo "Curl is not installed" ; exit 1 )

# get etcd members credentials
MEMBERS="${ETCD} --endpoints https://127.0.0.1:2379 member list"
LEADER_ID=$(eval "$MEMBERS" | awk -F ':' '/isLeader=true/ {print $1}')
LEADER_ENDPOINT=$(eval "$MEMBERS" | awk '/isLeader=true/ {print $4}' | cut -d"=" -f2)
SLAVE_ID=$(eval "$MEMBERS" | grep 'isLeader=false' | head -n 1 | awk -F ":" '{print $1}')
SLAVE_ENDPOINT=$(eval "$MEMBERS" | grep 'isLeader=false' | head -n 1 | awk '{print $4}' | cut -d"=" -f2)


```

--------------------------------

### Install Sample Configuration Files

Source: https://docs.openstack.org/cloudkitty/latest/admin/install/install-source.html

Creates the configuration directory, generates sample files using tox, and copies them to the system configuration path.

```bash
mkdir /etc/cloudkitty
tox -e genconfig
cp etc/cloudkitty/cloudkitty.conf.sample /etc/cloudkitty/cloudkitty.conf
cp etc/cloudkitty/policy.yaml /etc/cloudkitty
cp etc/cloudkitty/api_paste.ini /etc/cloudkitty
```

--------------------------------

### Create and start a virtual machine with virt-install

Source: https://docs.openstack.org/image-guide/create-images-manually-tools-libvirt.html

Creates a 10GB qcow2 image and initiates a virtual machine installation using a local ISO file.

```bash
# qemu-img create -f qcow2 /tmp/centos.qcow2 10G
# virt-install --virt-type kvm --name centos --ram 1024 \
  --disk /tmp/centos.qcow2,format=qcow2 \
  --network network=default \
  --graphics vnc,listen=0.0.0.0 --noautoconsole \
  --os-type=linux --os-variant=centos7.0 \
  --location=/data/isos/CentOS-7-x86_64-NetInstall-1611.iso
```

--------------------------------

### Example OpenStack-Ansible Playbook for Nova

Source: https://docs.openstack.org/openstack-ansible-os_nova/2024.1

This playbook demonstrates the installation and setup of the Nova service using the os_nova role. It includes variable definitions for Galera and prompts for the Galera root password.

```yaml
---
- name: Installation and setup of Nova
  hosts: nova_all
  user: root
  roles:
    - role: "os_nova"
      tags:
        - os-nova
  vars:
    nova_galera_address: "{{ internal_lb_vip_address }}"
    galera_root_user: root
  vars_prompt:
    - name: "galera_root_password"
      prompt: "What is galera_root_password?"

```

--------------------------------

### Build installation guide locally

Source: https://docs.openstack.org/doc-contrib-guide/project-install-guide.html

Execute the tox environment to generate the HTML documentation locally.

```bash
$ tox -e install-guide

```

--------------------------------

### Install and start memcached

Source: https://docs.openstack.org/zaqar/latest/install/install-ubuntu.html

Install and start the memcached service to handle token and catalog caching.

```bash
# apt-get install memcached
```

```bash
# service memcached start
```

--------------------------------

### ProjectSetup Main Entry Point

Source: https://docs.openstack.org/keystone/latest/_modules/keystone/cmd/cli.html

Class method to instantiate and run the project setup.

```python
    @classmethod
    def main(cls):
        klass = cls()
        klass.do_project_setup()
```

--------------------------------

### Example Notification Server Start

Source: https://docs.openstack.org/developer/performance-docs/test_plans/mq/plan.html

An example command to start the notification server with specific credentials and host.

```bash
python simulator.py --url rabbit://nova:DUoqsyrq@192.168.0.4:5673/ notify-server

```

--------------------------------

### Install Ceph Client Playbook Example

Source: https://docs.openstack.org/openstack-ansible-ceph_client/victoria

An example Ansible playbook to install the Ceph client role on all hosts.

```yaml
- name: Install Ceph client
  hosts: all
  user: root
  roles:
    - role: "openstack-ansible-ceph_client"
```

--------------------------------

### Start installation with virt-install

Source: https://docs.openstack.org/image-guide/create-images-manually-example-centos-image.html

Use this command to initiate a virtual machine installation from a local ISO file. Ensure a VNC client is connected to complete the installation process.

```bash
$ sudo virt-install --virt-type kvm --name my-centos --ram 2048 \
  --network network=default \
  --graphics vnc,listen=0.0.0.0 --noautoconsole \
  --os-type=linux --os-variant=centos-stream9 \
  --location=~/Downloads/CentOS-Stream-9-20240819.0-x86_64-dvd1.iso
```

--------------------------------

### Install and initialize devpi-server

Source: https://docs.openstack.org/diskimage-builder/latest/elements/pypi/README.html

Commands to install devpi and perform a quickstart initialization for a local PyPI mirror.

```bash
pip install -U devpi
devpi-server quickstart
devpi use http://machinename:3141
```

--------------------------------

### Example Notification Client Start

Source: https://docs.openstack.org/developer/performance-docs/test_plans/mq/plan.html

An example command to start the notification client with specific parameters for threads and messages.

```bash
python simulator.py --url rabbit://nova:DUoqsyrq@192.168.0.4:5673/ notify-client -p 10 -m 100

```

--------------------------------

### Example RPC Cast Server Start

Source: https://docs.openstack.org/developer/performance-docs/test_plans/mq/plan.html

An example command to start the RPC server with specific credentials and host.

```bash
python simulator.py --url rabbit://nova:DUoqsyrq@192.168.0.4:5673/ --debug true rpc-server

```

--------------------------------

### GET /v2.1/ Response Example

Source: https://docs.openstack.org/api-ref/compute/index.html

Example JSON response for a GET request to the /v2.1/ endpoint on a current server.

```json
{
    "version": {
        "id": "v2.1",
        "links": [
            {
                "href": "http://openstack.example.com/v2.1/",
                "rel": "self"
            },
            {
                "href": "http://docs.openstack.org/",
                "rel": "describedby",
                "type": "text/html"
            }
        ],
        "media-types": [
            {
                "base": "application/json",
                "type": "application/vnd.openstack.compute+json;version=2.1"
            }
        ],
        "status": "CURRENT",
        "version": "2.104",
        "min_version": "2.1",
        "updated": "2013-07-23T11:33:21Z"
    }
}
```

--------------------------------

### Complete Multi-Cloud Example with Shade

Source: https://docs.openstack.org/developer/shade/multi-cloud-demo.html

This example demonstrates initializing Shade for multiple clouds, uploading an image, finding a suitable flavor, and booting a server with automatic IP assignment. Ensure you have the necessary image file ('devuan-jessie.qcow2') available.

```python
import shade

# Initialize and turn on debug logging
shade.simple_logging(debug=True)

for cloud_name, region_name in [
        ('my-vexxhost', 'ca-ymq-1'),
        ('my-citycloud', 'Buf1'),
        ('my-internap', 'ams01')]:
    # Initialize cloud
    cloud = shade.openstack_cloud(cloud=cloud_name, region_name=region_name)

    # Upload an image to the cloud
    image = cloud.create_image(
        'devuan-jessie', filename='devuan-jessie.qcow2', wait=True)

    # Find a flavor with at least 512M of RAM
    flavor = cloud.get_flavor_by_ram(512)

    # Boot a server, wait for it to boot, and then do whatever is needed
    # to get a public ip for it.
    cloud.create_server(
        'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)


```

--------------------------------

### Install Virtualization Packages

Source: https://docs.openstack.org/cyborg/latest/contributor/vm-setup.html

Install QEMU, libvirt, and related tools on the host system.

```bash
$ sudo apt update
$ sudo apt install -y qemu-kvm libvirt-daemon-system libvirt-clients \
  bridge-utils virt-manager virt-viewer virtinst ovmf
```

```bash
$ sudo dnf install -y qemu-kvm libvirt virt-manager virt-viewer \
  virt-install edk2-ovmf
```

--------------------------------

### Create and Boot Server with Shade

Source: https://docs.openstack.org/developer/shade/index.html

Python code demonstrating how to initialize Shade, upload an image, find a flavor, and boot a server with automatic IP assignment.

```python
import shade

# Initialize and turn on debug logging
shade.simple_logging(debug=True)

# Initialize cloud
# Cloud configs are read with os-client-config
cloud = shade.openstack_cloud(cloud='mordred')

# Upload an image to the cloud
image = cloud.create_image(
    'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)

# Find a flavor with at least 512M of RAM
flavor = cloud.get_flavor_by_ram(512)

# Boot a server, wait for it to boot, and then do whatever is needed
# to get a public ip for it.
cloud.create_server(
    'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)

```

--------------------------------

### Start DevStack Installation

Source: https://docs.openstack.org/kuryr-kubernetes/latest/installation/devstack/basic.html

Execute the stack.sh script to start the DevStack installation process. This can take 20 to 40 minutes.

```bash
$ devstack/stack.sh

```

--------------------------------

### PBR project structure and configuration

Source: https://docs.openstack.org/pbr/latest/user/features.html

Example of a project using PBR, showing the simplified setup.py and the use of setup.cfg for metadata.

```bash
$ tree -L 1
.
├── LICENSE
├── README.rst
├── setup.cfg
├── setup.py
└── somepackage
```

```python
$ cat setup.py
setuptools.setup(
    pbr=True
)
```

```ini
$ cat setup.cfg
[metadata]
name = mypackage
description = A short description
description_file = README.rst
author = John Doe
author_email = john.doe@example.com
license = BSD
```

--------------------------------

### Example Playbook for Tacker Server Installation

Source: https://docs.openstack.org/openstack-ansible-os_tacker/2025.1

An example Ansible playbook to install the Tacker server using the os_tacker role.

```yaml
---
- name: Install tacker server
  hosts: tacker_all
  user: root
  roles:
    - role: "os_tacker"
      tags:
        - "os-tacker"

```

--------------------------------

### Clone and navigate to the repository

Source: https://docs.openstack.org/neutron/latest/contributor/ovn_vagrant/sparse-architecture.html

Initial steps to prepare the local environment for deployment.

```bash
$ git clone https://opendev.org/openstack/neutron.git
$ cd neutron/vagrant/ovn/sparse
```

--------------------------------

### Example RPC Cast Client Start

Source: https://docs.openstack.org/developer/performance-docs/test_plans/mq/plan.html

An example command to start the RPC client with specific parameters for threads and messages.

```bash
python simulator.py --url rabbit://nova:DUoqsyrq@192.168.0.4:5673/ rpc-client --is-cast true -p 10 -m 100

```

--------------------------------

### Horizon Installation Playbook Example

Source: https://docs.openstack.org/developer/openstack-ansible-os_horizon

A complete example playbook for installing and configuring Horizon, including required variables and prompts.

```yaml
---
- name: Installation and setup of horizon
  hosts: horizon_all
  user: root
  roles:
    - role: "os_horizon"
      tags:
        - "os-horizon"
  vars:
    galera_client_drop_config_file: false
    external_lb_vip_address: 10.100.100.101
    internal_lb_vip_address: 10.100.100.101
    horizon_galera_address: 10.100.100.101
    horizon_container_mysql_password: "SuperSecrete"
    horizon_secret_key: "SuperSecreteHorizonKey"
    horizon_external_ssl: true
    rabbitmq_servers: 10.100.100.101
    rabbitmq_use_ssl: false
    rabbitmq_port: 5671
    keystone_admin_user_name: admin
    keystone_auth_admin_password: "SuperSecretePassword"
    keystone_admin_tenant_name: admin
    keystone_service_adminuri_insecure: false
    keystone_service_internaluri_insecure: false
    keystone_service_internaluri: "http://{{ internal_lb_vip_address }}:5000"
    keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
    keystone_service_adminuri: "http://{{ internal_lb_vip_address }}:5000"
    keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
    openrc_os_password: "{{ keystone_auth_admin_password }}"
    openrc_os_domain_name: "Default"
    memcached_servers: 10.100.100.101
    memcached_encryption_key: "secrete"
    galera_root_user: root
  vars_prompt:
    - name: "galera_root_password"
      prompt: "What is galera_root_password?"
```

--------------------------------

### Configure setup.py for the plugin

Source: https://docs.openstack.org/horizon/latest/contributor/tutorials/plugin.html

Standard setup script using pbr for packaging.

```python
import setuptools

setuptools.setup(
    setup_requires=['pbr>=2.0.0'],
    pbr=True)
```

--------------------------------

### Prepare new hosts and deploy containers

Source: https://docs.openstack.org/openstack-ansible/latest/admin/scale-environment/add-new-infrastructure-host.html

Run the setup-hosts playbook with a limit argument to initialize the new infrastructure node.

```bash
# openstack-ansible openstack.osa.setup_hosts --limit localhost,infra<node-ID>,infra<node-ID>-host_containers
```

--------------------------------

### Configure tox environment for installation guide

Source: https://docs.openstack.org/doc-contrib-guide/project-install-guide.html

Define the tox environment in tox.ini to build the installation guide using sphinx-build.

```ini
[testenv:install-guide]
whitelist_externals = rm
commands =
        rm -rf install-guide/build
        sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html

```

--------------------------------

### Install and start uwsgi services

Source: https://docs.openstack.org/heat/latest/operating_guides/httpd.html

Commands to install uwsgi and start the Heat API services using the provided ini files.

```bash
sudo pip install uwsgi
uwsgi --ini /etc/heat/heat-api-uwsgi.ini
uwsgi --ini /etc/heat/heat-api-cfn-uwsgi.ini
```

--------------------------------

### Install pip and setuptools

Source: https://docs.openstack.org/mistral/latest/contributor/extensions/extending_yaql.html

Commands to bootstrap pip and upgrade setuptools.

```bash
$ curl https://bootstrap.pypa.io/pip/3.2/get-pip.py | python
$ pip install --upgrade setuptools
$ cd -
```

--------------------------------

### Run the Installer

Source: https://docs.openstack.org/image-guide/create-images-manually-example-freebsd-image.html

Executes the downloaded installer script to set up bsd-cloudinit.

```bash
# sh ./installer.sh
```

--------------------------------

### Example CloudKitty Installation Playbook

Source: https://docs.openstack.org/openstack-ansible-os_cloudkitty/2025.2

An example Ansible playbook for installing the CloudKitty service, specifying hosts, roles, and necessary variables.

```yaml
- name: Install cloudkitty service
  hosts: cloudkitty_all
  user: root
  roles:
    - { role: "os_cloudkitty", tags: [ "os-cloudkitty" ] }
  vars:
    external_lb_vip_address: 172.16.24.1
    internal_lb_vip_address: 192.168.0.1
    cloudkitty_galera_address: "{{ internal_lb_vip_address }}"
    cloudkitty_container_mysql_password: "SuperSecretePassword1"
    cloudkitty_service_password: "SuperSecretePassword2"
    cloudkitty_oslomsg_rpc_password: "SuperSecretePassword3"
    cloudkitty_oslomsg_notify_password: "SuperSecretePassword4"

```

--------------------------------

### Initialize VPN Demo

Source: https://docs.openstack.org/kolla-ansible/latest/reference/networking/neutron-extensions.html

Run the initialization scripts to set up a VPN demo environment.

```bash
tools/init-runonce
tools/init-vpn

```

--------------------------------

### Example Playbook for Adjutant Installation

Source: https://docs.openstack.org/openstack-ansible-os_adjutant/latest

An example Ansible playbook to install the Adjutant server role. Includes setting necessary variables.

```yaml
- name: Install adjutant server
  hosts: adjutant_all
  user: root
  roles:
    - { role: "os_adjutant", tags: [ "os-adjutant" ] }
  vars:
    external_lb_vip_address: 172.16.24.1
    internal_lb_vip_address: 192.168.0.1
    adjutant_galera_address: "{{ internal_lb_vip_address }}"
    adjutant_galera_password: "SuperSecretePassword1"
    adjutant_service_password: "SuperSecretePassword2"
    adjutant_rabbitmq_password: "SuperSecretePassword3"
```

--------------------------------

### Get SSL Certificate MD5 Sum API Examples

Source: https://docs.openstack.org/octavia/latest/contributor/api/haproxy-amphora-api.html

Examples of GET requests for retrieving the MD5 sum of an uploaded certificate.

```http
JSON response:
{
  'md5sum': 'd8f6629d5e3c6852fa764fb3f04f2ffd',
}
```

```http
JSON Response:
  {
    'message': 'Listener Not Found',
    'details': 'No loadbalancer with UUID: 04bff5c3-5862-4a13-b9e3-9b440d0ed50a',
  }
```

```http
JSON Response:
  {
    'message': 'Certificate Not Found',
    'details': 'No certificate with file name: www.example.com.pem',
  }
```

--------------------------------

### Start Windows installation with virt-install

Source: https://docs.openstack.org/image-guide/create-images-manually-example-windows-image.html

Launches the virtual machine installation process using the specified ISOs and hardware configuration.

```bash
# virt-install --connect qemu:///system \
  --name ws2012 --ram 2048 --vcpus 2 \
  --network network=default,model=virtio \
  --disk path=ws2012.qcow2,format=qcow2,device=disk,bus=virtio \
  --cdrom /path/to/en_windows_server_2012_x64_dvd.iso \
  --disk path=/path/to/virtio-win-0.1-XX.iso,device=cdrom \
  --vnc --os-type windows --os-variant win2k12 \
  --os-distro windows --os-version 2012
```

--------------------------------

### Install cloud-init

Source: https://docs.openstack.org/image-guide/create-images-manually-example-ubuntu-image.html

Install the cloud-init package to enable metadata fetching on instance boot.

```bash
# apt install cloud-init
```

--------------------------------

### Example Playbook for Tacker Installation

Source: https://docs.openstack.org/openstack-ansible-os_tacker/2023.2

An example Ansible playbook demonstrating how to install the Tacker server using the 'os_tacker' role. Ensure pip version 7.1 or higher is installed on the target host.

```yaml
---
- name: Install tacker server
  hosts: tacker_all
  user: root
  roles:
    - role: "os_tacker"
      tags:
        - "os-tacker"
```

--------------------------------

### Install cookiecutter

Source: https://docs.openstack.org/doc-contrib-guide/project-install-guide.html

Install the cookiecutter tool required to generate the installation guide skeleton.

```bash
# pip install cookiecutter

```

--------------------------------

### Run Infrastructure Setup Playbook

Source: https://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/run-playbooks.html

Run the `setup-infrastructure.yml` playbook to install essential infrastructure services like Memcached, RabbitMQ, and Galera.

```bash
# openstack-ansible setup-infrastructure.yml
```

--------------------------------

### Example Ansible Playbook for Zun Installation

Source: https://docs.openstack.org/openstack-ansible-os_zun/2023.2

An example Ansible playbook to gather Zun facts and install Zun services on target hosts.

```yaml
---

- name: Gather zun facts
  hosts: zun_all
  gather_facts: True
  tags:
    - always

- name: Install zun services
  hosts: zun_all
  gather_facts: False
  serial:
    - 1
    - "100%"
  user: root
  environment: "{{ deployment_environment_variables | default({}) }}"
  tags:
    - zun
  roles:
    - role: "os_zun"
```

--------------------------------

### Initialize demo resources

Source: https://docs.openstack.org/kolla-ansible/latest/user/quickstart-development.html

Runs the init-runonce script to create example networks and images.

```bash
kolla-ansible/tools/init-runonce
```

--------------------------------

### Example Keystone installation playbook

Source: https://docs.openstack.org/openstack-ansible-os_keystone/2025.2

A complete playbook example for installing and configuring Keystone with specific variables and a prompt for the Galera root password.

```yaml
---
- name: Installation and setup of Keystone
  hosts: keystone_all
  user: root
  roles:
    - role: os_keystone
      tags:
        - os-keystone
  vars:
    external_lb_vip_address: 10.100.100.102
    internal_lb_vip_address: 10.100.100.102
    keystone_galera_address: 10.100.100.101
    keystone_galera_database: keystone
    keystone_venv_tag: "testing"
    keystone_developer_mode: true
    keystone_git_install_branch: master
    keystone_auth_admin_password: "SuperSecretePassword"
    keystone_oslomsg_rpc_password: "secrete"
    keystone_oslomsg_notify_password: "secrete"
    keystone_container_mysql_password: "SuperSecrete"
    keystone_oslomsg_rpc_transport: rabbit
    keystone_oslomsg_rpc_servers: 10.100.100.101
    keystone_oslomsg_rpc_port: 5671
    keystone_oslomsg_rpc_use_ssl: true
    keystone_oslomsg_rpc_userid: keystone
    keystone_oslomsg_rpc_vhost: /keystone
    keystone_oslomsg_notify_transport: rabbit
    keystone_oslomsg_notify_servers: 10.100.100.101
    keystone_oslomsg_notify_port: 5671
    keystone_oslomsg_notify_use_ssl: true
    keystone_oslomsg_notify_userid: keystone
    keystone_oslomsg_notify_vhost: /keystone
    galera_client_drop_config_file: false
    galera_root_user: root
  vars_prompt:
    - name: "galera_root_password"
      prompt: "What is galera_root_password?"
```
Tokens:
Raw