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.

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

Documentation

Getting Started

We advise new users start by reading the Architecture documentation first in order to understand Kayobe’s various components.

For users wishing to learn interactively we recommend starting at either the all-in-one overcloud deployment or the ‘A Universe From Nothing’ deployment guide.

Once familiar with Kayobe’s constituent parts, move on to the Installation section to prepare a baremetal environment and then Deployment to deploy to it.

  • Architecture - The function of Kayobe’s host and networking components
  • Installation - The prerequisites and options for installing Kayobe
  • Usage - An introduction to the Kayobe CLI
  • Configuration - How to configure Kayobe’s various components
  • Deployment- Using Kayobe to deploy OpenStack
  • Upgrading - Upgrading from one OpenStack release to another
  • Administration - Post-deploy administration tasks
  • Resources - External links to Kayobe resources
  • Development - Deploying Kayobe development environments