Welcome to Kayobe’s documentation!

Overview

Welcome to the Kayobe documentation, the official source of information for understanding and using Kayobe.

This documentation is maintained at opendev.org here. Feedback and contributions welcome, see contributing for information on how.

Kayobe

Kayobe enables deployment of containerised OpenStack to bare metal.

Containers offer a compelling solution for isolating OpenStack services, but running the control plane on an orchestrator such as Kubernetes or Docker Swarm adds significant complexity and operational overheads.

The hosts in an OpenStack control plane must somehow be provisioned, but deploying a secondary OpenStack cloud to do this seems like overkill.

Kayobe stands on the shoulders of giants:

• OpenStack bifrost discovers and provisions the cloud

• OpenStack kolla builds container images for OpenStack services

• OpenStack kolla-ansible delivers painless deployment and upgrade of containerised OpenStack services

To this solid base, kayobe adds:

• Configuration of cloud host OS & flexible networking

• Management of physical network devices

• A friendly openstack-like CLI

All this and more, automated from top to bottom using Ansible.

• Free software: Apache license

• Documentation: https://docs.openstack.org/kayobe/latest/

• Source: https://opendev.org/openstack/kayobe

• Bugs: https://storyboard.openstack.org/#!/project/openstack/kayobe

• Release Notes: https://docs.openstack.org/releasenotes/kayobe/

• IRC: #openstack-kolla on OFTC

Features

• Heavily automated using Ansible

• kayobe Command Line Interface (CLI) for cloud operators

• Deployment of a seed VM used to manage the OpenStack control plane

• Configuration of physical network infrastructure

• Discovery, introspection and provisioning of control plane hardware using OpenStack bifrost

• Deployment of an OpenStack control plane using OpenStack kolla-ansible

• Discovery, introspection and provisioning of bare metal compute hosts using OpenStack ironic and ironic inspector

• Virtualised compute using OpenStack nova

• Containerised workloads on bare metal using OpenStack magnum

• Big data on bare metal using OpenStack sahara

• Control plane and workload monitoring and log aggregation using OpenStack monasca

Contents

• Getting Started
• Architecture
  • Hosts in the System
  • Networks
• Support Matrix
  • Supported Operating Systems
  • Supported container images
• Installation
  • Prerequisites
  • Local directory structure
  • Installation from PyPI
  • Installation from source
• Usage
  • Command Line Interface
• Configuration Guide
  • Configuration Scenarios
  • Configuration Reference
• Deployment
  • Ansible Control Host
  • Physical Network
  • Seed Hypervisor
  • Seed
  • Overcloud
• Upgrading
  • Preparation
  • Updating Kayobe Configuration
  • Upgrading Kayobe
  • Upgrading the Ansible Control Host
  • Upgrading the Seed Hypervisor
  • Upgrading the Seed
  • Upgrading the Overcloud
• Administration
  • General Administration
  • Seed Administration
  • Overcloud Administration
  • Baremetal Compute Node Management
• Resources
  • A Universe From Nothing

Advanced Documentation

• Control Plane Service Placement
  • Configuration
  • Examples
• Custom Ansible Playbooks
  • Kayobe Custom Playbook API
  • Running Custom Ansible Playbooks
  • Packaging Custom Playbooks With Configuration
  • Example
  • Hooks

Contributor Guide

• Contributor Guide
  • So You Want to Contribute…
  • Development
  • Vagrant
  • Manual Setup
  • Automated Setup
  • Testing
  • Release notes
  • Releases