Getting Started
Part I - Background and Workshop
Please refer to the respective documentation section to learn more about the Architecture and Concepts. Alternatively book a workshop directly at [email protected].
Understanding the architecture and the conceptual design of Cloud-of-the-box.
Part II - Access and Inventory
To access and change your custer, you first need ipmi access to control the life cycle of the physical machines. Please refer to the following sections in order to set up access:
- IPMI Access /operation/ipmi/access
- Kubernetes Access /operation/kubernetes/access
In order to actually control the life cycle of the physical machines the boot deployment needs to be in place. A brief guideline on how this works is documented in the architecture documentation. Please refer to the following sections in order to set up the boot deployment:
- Boot Deployment /repositories/deployments/apps/boot
The actual configuration of the physical machines is part of the inventory. Every change to the inventory has to be applied to the previously mentioned boot deployment. This typically involves changing the image tag of the refereed inventory configuration within this deployment. To apply changes from the inventory for a physical machine you have to reboot it. Use the aforementioned method via ipmi.
- Inventory configuration /configuration/inventory/
To login to the physical machines please refer to the /operation/ssh/access documentation.
At this point we have all the machines running and have access to them via ipmi, ssh and kubeconfig.
Part III - Auxiliary Services
After configuring the Inventory and bootstrapping your infrastructure with Cloud-Of-The-Box as described above, you are ready to deploy the support/auxiliary services.
The following services are prerequisites for running OpenStack on your infrastructure. These are:
- ipmitool for infrastructure lifecycle management
- Rook-Ceph cluster on storage nodes
- Deployment for an ingress controller such as envoy or traefik.
- Optional deployments like Longhorn if required by the customer.
Longhorn or other optional services are not included in Cloud-of-the-Box. They have to be deployed and maintained at the customers own risk.
Auxiliary services must be configured and tailored to your needs before deployment. These services can be deployed independently in any order, but are intended to be operational before the deployment of OpenStack.
To deploy these services please refer to the respective sectiions in our repository documentation.
Documentation for the repositories:
- /repositories/deployments/apps/ipmitool
- /repositories/deployments/apps/ceph
- /repositories/deployments/apps/ingress-traefik
- /repositories/deployments/apps/longhorn
Documentation for the application deployments:
- /operation/kubernetes/deployments/ipmi
- /operation/kubernetes/deployments/ceph
- /operation/kubernetes/deployments/ingress-traefik
- /operation/kubernetes/deployments/longhorn
At this point all auxiliary services needed for operating OpenStack in your infrastructure are up and running.
This specificially includes storage and ingress.
Part IV - Configure and deploy OpenStack
To configure and deploy OpenStack please refer to the respective documentation sections.
- Make sure you have followed the configuration section for Openstack in /operation/kubernetes/deployments/ceph.
- Configure environment variables for the OpenStack services (e.g. Credentials, Databases, StorageClasses, etc) according to the documentation /repositories/deployments/apps/openstack.
At this point OpenStack and its API is available.
Part V - Proof of Operations
As acceptance test to verify operations of OpenStack we provide a deployment for OpenStack-Rally.
Please see the /operation/kubernetes/deployments/rally section for further information.
We now have verified the operational state of OpenStack.