Jump to: navigation, search

Difference between revisions of "Openstack-helm"

(Contributing)
(Version matrix)
 
(62 intermediate revisions by 17 users not shown)
Line 2: Line 2:
  
 
== OpenStack-Helm ==
 
== OpenStack-Helm ==
Openstack-Helm is a fully self-contained Helm-based OpenStack deployment on Kubernetes. It will provide baremetal provisioning, persistent storage, full-stack resiliency, full-stack scalability, performance monitoring and tracing, and an optional development pipeline (using Jenkins). This project, along with the tools used within are community-based and open sourced.
+
 
 +
[[File:OpenStack Project OpenStackHelm vertical png.png|thumb]]
 +
 
 +
The objective of OpenStack-Helm is to facilitate the deployment, maintenance, and upgrading of modular OpenStack services and their associated dependencies. These can be managed either individually or within complex environments, all atop a Kubernetes platform. To this end, the project offers Helm charts not just for OpenStack components, but also for essential infrastructure elements such as Ceph, MariaDB, RabbitMQ, Memcached and others. While OpenStack-Helm is designed to be image-agnostic—allowing for the use of any compatible images—it also provides pre-built images for most OpenStack projects to ensure a seamless user experience.
 +
 
 +
All the charts are available via two Helm repositories. To use them run the following:
 +
<pre>
 +
helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm
 +
helm repo add openstack-helm-infra https://tarballs.opendev.org/openstack/openstack-helm-infra
 +
</pre>
 +
 
 +
== Version matrix ==
 +
Below is the table exposing all the combinations of Openstack/Platform/Kubernetes versions that are tested and supposed to work. Not all Helm charts are well supported. The table shows working combinations for compute-kit (Keystone, Glance, Nova, Placement, Neutron (ovs/ovn), Cinder, Heat) deployments.  
  
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
| '''Docs'''
+
|'''Openstack version'''
| http://openstack-helm.readthedocs.io
+
|'''Host OS'''
 +
|'''Image OS'''
 +
|'''Kubernetes version'''
 +
|-
 +
|Zed
 +
|Ubuntu Focal
 +
|Ubuntu Focal
 +
|>=1.24,<=1.28
 
|-
 
|-
 
+
|Zed
| '''Project Contact'''
+
|Ubuntu Jammy
| Steve Wilkerson (srwilkers)
+
|Ubuntu Jammy
 +
|>=1.24,<=1.28
 
|-
 
|-
| '''Meetings'''
+
|Antelope (aka 2023.1)
| Every Tuesday @ 3PM UTC, [http://webchat.freenode.net/?channels=openstack-meeting-5 #openstack-meeting-5]
+
|Ubuntu Focal
 +
|Ubuntu Focal
 +
|>=1.24,<=1.28
 
|-
 
|-
| '''IRC Channel'''
+
|Antelope (aka 2023.1)
| [http://webchat.freenode.net/?channels=openstack-helm #openstack-helm]
+
|Ubuntu Jammy
 +
|Ubuntu Jammy
 +
|>=1.24,<=1.28
 
|-
 
|-
| '''Meeting Agenda'''
+
|Bobcat (aka 2023.2)
| [https://etherpad.openstack.org/p/openstack-helm-meeting-agenda Agenda]
+
|Ubuntu Jammy
 +
|Ubuntu Jammy
 +
|>=1.24,<=1.28
 
|-
 
|-
| '''Kubernetes Slack'''
+
|Caracal (aka 2024.1)
| [https://kubernetes.slack.com/messages/C3WERB7DE/ #openstack-helm]
+
|Ubuntu Jammy
 +
|Ubuntu Jammy
 +
|>=1.24,<=1.28
 
|-
 
|-
| '''Launchpad'''
 
| [https://launchpad.net/openstack-helm OpenStack-Helm Launchpad]
 
 
|}
 
|}
  
== Mission ==
+
== Project links ==
The goal for Openstack-Helm is to provide an incredibly customizable framework for operators and developers alike. This framework will enable end-users to deploy, maintain, and upgrade a fully functioning Openstack environment for both simple and complex environments. Administrators or developers can either deploy all or individual Openstack components along with their required dependancies. It heavily borrows concepts from [https://github.com/stackanetes/stackanetes Stackanetes] and [https://github.com/sapcc/openstack-helm other complex Helm application deployments]. This project is meant to be a collaborative project that brings Openstack applications into a [https://www.cncf.io/about/charter Cloud-Native] model.
+
{| border="1" cellpadding="2" cellspacing="0"
 
+
| '''Docs'''
== Installation and Development ==
+
|
This project is under heavy development. We encourage anyone who is interested in Openstack-Helm to review our [http://openstack-helm.readthedocs.io/en/latest/install/index.html Installation documentation], complete with verification procedures. Feel free to ask questions or check out our current [https://bugs.launchpad.net/openstack-helm Issues and Bugs].
+
* https://docs.openstack.org/openstack-helm
 +
* https://docs.openstack.org/openstack-helm-infra
 +
* https://docs.openstack.org/openstack-helm-images
 +
|-
 +
| '''Project repositories'''
 +
|
 +
* https://opendev.org/openstack/openstack-helm
 +
* https://opendev.org/openstack/openstack-helm-infra
 +
* https://opendev.org/openstack/openstack-helm-images
 +
* https://opendev.org/openstack/loci
 +
|-
 +
| '''Roadmap'''
 +
| [https://storyboard.openstack.org/#!/project_group/64 Storyboard]
 +
|-
 +
|}
  
Please review our documentation at [http://openstack-helm.readthedocs.io/ Read the Docs]. For quick installation, evaluation, and convenience, you can use our online Helm repository and configure your environment with [http://openstack-helm.readthedocs.io/en/latest/install/all-in-one.html Kubeadm-AIO].
+
-----
  
For a production-like install, follow the [http://openstack-helm.readthedocs.io/en/latest/install/multinode.html Bare Metal] install guide.
 
 
== Project Links ==
 
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
| '''OpenStack-Helm'''
+
| '''Project Contact'''
| https://github.com/openstack/openstack-helm
+
| Vladimir Kozhukalov (kozhukalov)
 
|-
 
|-
| '''OpenStack-Helm-Addons'''
+
| '''IRC Channel'''  
| https://github.com/openstack/openstack-helm-addons
+
| [http://webchat.freenode.net/?channels=openstack-helm #openstack-helm]
 
|-
 
|-
| '''OpenStack-Helm-Infra'''
+
| '''Kubernetes Slack'''
| https://github.com/openstack/openstack-helm-infra
+
| [https://kubernetes.slack.com/messages/C3WERB7DE #openstack-helm] (preferable)
 
|-
 
|-
 
|}
 
|}
  
== Contributing ==
+
-----
Please see the project's [https://github.com/openstack/openstack-helm/blob/master/CONTRIBUTING.rst CONTRIBUTING.rst]
 

Latest revision as of 01:16, 9 April 2024


OpenStack-Helm

OpenStack Project OpenStackHelm vertical png.png

The objective of OpenStack-Helm is to facilitate the deployment, maintenance, and upgrading of modular OpenStack services and their associated dependencies. These can be managed either individually or within complex environments, all atop a Kubernetes platform. To this end, the project offers Helm charts not just for OpenStack components, but also for essential infrastructure elements such as Ceph, MariaDB, RabbitMQ, Memcached and others. While OpenStack-Helm is designed to be image-agnostic—allowing for the use of any compatible images—it also provides pre-built images for most OpenStack projects to ensure a seamless user experience.

All the charts are available via two Helm repositories. To use them run the following:

helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm
helm repo add openstack-helm-infra https://tarballs.opendev.org/openstack/openstack-helm-infra

Version matrix

Below is the table exposing all the combinations of Openstack/Platform/Kubernetes versions that are tested and supposed to work. Not all Helm charts are well supported. The table shows working combinations for compute-kit (Keystone, Glance, Nova, Placement, Neutron (ovs/ovn), Cinder, Heat) deployments.

Openstack version Host OS Image OS Kubernetes version
Zed Ubuntu Focal Ubuntu Focal >=1.24,<=1.28
Zed Ubuntu Jammy Ubuntu Jammy >=1.24,<=1.28
Antelope (aka 2023.1) Ubuntu Focal Ubuntu Focal >=1.24,<=1.28
Antelope (aka 2023.1) Ubuntu Jammy Ubuntu Jammy >=1.24,<=1.28
Bobcat (aka 2023.2) Ubuntu Jammy Ubuntu Jammy >=1.24,<=1.28
Caracal (aka 2024.1) Ubuntu Jammy Ubuntu Jammy >=1.24,<=1.28

Project links

Docs
Project repositories
Roadmap Storyboard

Project Contact Vladimir Kozhukalov (kozhukalov)
IRC Channel #openstack-helm
Kubernetes Slack #openstack-helm (preferable)