From a9e00ad15ba37d5c0e83c5f0c352d1c52b8597c7 Mon Sep 17 00:00:00 2001
From: Pierre Riteau <pierre@stackhpc.com>
Date: Thu, 14 Nov 2024 16:49:12 +0100
Subject: [PATCH] Synchronise README with Kayobe

Change-Id: Id02d5c192ae33e5807a64187b1cade3785cdf091
---
 README.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/README.rst b/README.rst
index 10002e8..dfd37b3 100644
--- a/README.rst
+++ b/README.rst
@@ -30,7 +30,51 @@ To this solid base, kayobe adds:
 
 All this and more, automated from top to bottom using Ansible.
 
-* Documentation: https://docs.openstack.org/kayobe/latest/
-* Source: https://opendev.org/openstack/kayobe
-* Bugs: https://storyboard.openstack.org/#!/project/openstack/kayobe-config
-* IRC: #openstack-kolla
+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 <https://docs.openstack.org/bifrost/latest/>`_
+* Deployment of an OpenStack control plane using `OpenStack kolla-ansible
+  <https://docs.openstack.org/kolla-ansible/latest/>`_
+* Discovery, introspection and provisioning of bare metal compute hosts
+  using `OpenStack ironic <https://docs.openstack.org/ironic/latest/>`_ and
+  `ironic inspector <https://docs.openstack.org/ironic-inspector/latest/>`_
+* Virtualised compute using `OpenStack nova
+  <https://docs.openstack.org/nova/latest/>`_
+* Containerised workloads on bare metal using `OpenStack magnum
+  <https://docs.openstack.org/magnum/latest/>`_
+* Control plane monitoring using `Prometheus <https://prometheus.io/>`__ and
+  `Grafana <https://grafana.com/>`__.
+* Log aggregation using `OpenSearch <https://opensearch.org/docs/latest/>`__
+  and `OpenSearch Dashboards
+  <https://opensearch.org/docs/latest/dashboards/index/>`__.
+
+Documentation
+-------------
+
+https://docs.openstack.org/kayobe/latest/
+
+Release Notes
+-------------
+
+https://docs.openstack.org/releasenotes/kayobe/
+
+Bugs
+----
+
+https://bugs.launchpad.net/kayobe
+
+Community
+---------
+
+OFTC's `IRC channel <http://webchat.oftc.net/?channels=openstack-kolla>`_: #openstack-kolla
+
+License
+-------
+
+Kayobe is distributed under the `Apache 2.0 License <https://www.apache.org/licenses/LICENSE-2.0>`__.