Welcome to Yaook’s documentation!

Welcome to the documentation of Yaook. We are happy that you are here.

Yaook is providing a fully automated OpenStack lifecycle management. It thereby not only focuses on OpenStack itself, but also on all other relevant aspects (e.g. hardware inventory, monitoring). Generic day 2 operation tasks are also included in Yaook’s scope.

A general overview about the Yaook project is given in Overview.

The source code is made available under Apache License and is located at: https://gitlab.com/yaook

A step-by-step guide on how to build your first Yaook cluster is given in Development Setup.

If you want to start developing for Yaook you can start with a look at the Resources, State Graph and the Yaook Operator.

User Explanations

Technical reference documentation of Yaook from the user perspective.

User Explanations
Developer Explanations

Things you need to know before developing for Yaook.

Developer Explanations
User Guides

Keep this under your pillow when running Yaook clusters.

User Guides
Developer Guides

Getting started and from a developers perspective.

Developer Guides
User Reference

References to everything important for running Yaook clusters.

User References
Developer Reference

Extensive API and internals reference documentation for developers.

Developer References