Improve the README (stackhpc#18)

* Separate out the README * Fill out feature description * Add note on CNI choice. * Pin oslo_db to unbreak tests * Fix up tox by pinning to Antelope * Add readme note on the version * more info * Add note about endpoint_type config * Add note about creating a template --------- Co-authored-by: scrungus <[email protected]>
dalees · Oct 9, 2023 · 6726c7c · 6726c7c
1 parent e7aba39
commit 6726c7c
Showing 1 changed file with 159 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -4,10 +4,164 @@ magnum-capi-helm
 
 OpenStack Magnum driver using helm to create k8s clusters
 with Cluster API.
-The long stated aim of this driver is to merge
-in upstream Magnum:
+
+The driver uses capi-helm-charts to create the
+k8s resources needed to create a k8s cluster
+using Cluster API, including various useful
+add ons like a CNI and a monitoring stack.
+https://github.com/stackhpc/capi-helm-charts
+
+Note, the above helm charts are intended to be
+a way to share a reference method to create K8s
+on OpenStack. The charts are not expected or
+indented to be specific to Magnum. The hope is
+they can also be used by ArgoCD, Flux or Azimuth
+to create k8s clusters on OpenStack.
+
+Work on this driver started upstream aroun October 2021.
+After failing to get merged during Bobcat,
+we created this downstream repo as a stop gap to help
+those wanting to use this driver now.
 https://specs.openstack.org/openstack/magnum-specs/specs/bobcat/clusterapi-driver.html
 
+Installation and Dependencies
+=============================
+
+For a kolla-ansible deployment, you can follow `this <https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-yoga/configuration/magnum-capi.html>`__ guide.
+
+If you install this python package within your Magnum virtual env,
+it should be picked up by Magnum:::
+
+  git clone https://github.com/stackhpc/magnum-capi-helm.git
+  cd magnum-capi-helm
+  pip install -e .
+
+We currently run the unit tests against the 2023.1 version of Magnum.
+
+The driver requires access to a Cluster API management cluster.
+For more information, please see:
+https://cluster-api.sigs.k8s.io/user/quick-start
+
+To access the above Cluster API management cluster,
+you need to configure where the kubeconfig file
+lives:::
+
+  [capi_helm]
+  kubeconfig_file = /etc/magnum/kubeconfig
+
+Note that the driver makes use of the nova_client config that will
+already be setup in your Magnum configuration to generate application
+credentials that reference the correct endpoint. You need to make
+sure this uses an endpoint that can be reached from inside the
+magnum clusters you create, by having something like this:::
+
+  [nova_client]
+  endpoint_type = publicURL
+
+To create a cluster, first you will need an image that
+has been built to include kubernetes.
+There are community maintained packer build pipelines here:
+https://image-builder.sigs.k8s.io/capi/capi.html
+
+Or you can grab prebuilt images from our `azimuth image releases <https://github.com/stackhpc/azimuth-images/releases/latest>`__.
+Images are available in the `manifest.json` file, and are named in the format `ubuntu-<ubuntu release>-<kube version>-<date and time of build>`.
+
+The above image needs to have the correct os-distro
+property set when uploaded to Glance. For example:::
+
+  curl -fo ubuntu-focal-kube-v1.28.1-230831-1150.qcow2 'https://object.arcus.openstack.hpc.cam.ac.uk/azimuth-images/ubuntu-focal-kube-v1.28.1-230831-1150.qcow2?AWSAccessKeyId=c5bd0fa15bae4e08b305a52aac97c3a6&Expires=1725019898&Signature=%2FXW2ywkA%2FQ8bCUiJkiLCWBAf81M%3D'
+  openstack image create ubuntu-focal-kube-v1.28.1 \
+    --file ubuntu-focal-kube-v1.28.1-230831-1150.qcow2  \
+    --disk-format qcow2 \
+    --container-format bare \
+    --public
+  openstack image set ubuntu-focal-kube-v1.28.1 --os-distro capi-kubeadm-cloudinit --os-version 20.04
+    openstack image set ubuntu-focal-kube-v1.28.1 \
+        --os-distro capi-kubeadm-cloudinit
+
+Finally, this means you can now create a template, and then a cluster,
+get the kubeconfig to access it, then run sonaboy to test it,
+doing something like this:::
+
+  openstack coe cluster template create new_driver \
+    --coe kubernetes \
+    --label octavia_provider=ovn \
+    --image $(openstack image show ubuntu-focal-kube-v1.28.1 -c id -f value) \
+    --external-network public \
+    --master-flavor ds2G20 \
+    --flavor ds2G20 \
+    --public \
+    --master-lb-enabled
+
+  openstack coe cluster create devstacktest \
+    --cluster-template new_driver \
+    --master-count 1 \
+    --node-count 2
+  openstack coe cluster list
+
+  mkdir -p ~/clusters/devstacktest
+  cd ~/clusters/devstacktest
+  openstack coe cluster config devstacktest
+  export KUBECONFIG=~/clusters/kubernetes-cluster/config
+  kubectl get nodes
+  sonobuoy run --mode quick --wait
+
+DevStack Setup
+==============
+
+Did you want to try this driver in DevStack?
+Please try our setup script in this repo:
+`devstack/contrib/new-devstack.sh`
+
+The above devstack script includes creating k3s based
+Cluster API management cluster.
+
+Features
+========
+
+The driver currently supports, create, delete, upgrade and
+updates to node groups and their sizes.
+
+The CAPI helm charts are currently being tested
+with K8s 1.26, 1.27 and 1.28:
+https://github.com/stackhpc/capi-helm-charts/blob/main/.github/workflows/ensure-capi-images.yaml#L9
+
+The driver respects the following cluster and template properties:
+
+* image_id
+* keypair
+* fixed_network, fixed_subnet (if missing, new one is created)
+* external_network_id
+* dns_nameserver
+
+The driver supports the following labels:
+
+* monitoring_enabled: default is off, change to "true" to enable
+* kube_dashboard_enabled: defalt is on, change to "false" to disable
+* octavia_provider: default is "amphora", ovn is also an option
+* fixed_subnet_cidr: default is "10.0.0.0/24"
+* extra_network_name: default is "", change to name of additional network,
+  which can be useful if using Manila with the CephFS Native driver.
+
+Currently all clusters use the Calico CNI. While Cilium is also supported
+in the helm charts, it is not currently reguarlly tested.
+
+We have found upgrade with ClusterAPI doesn't work well without
+using a loadbalancer, even with a single node control plane,
+so we currently ignore the "master-lb-enabled" flag.
+
+NOTE:
+We are working in Cluster API provider OpenStack to add the ability
+to store the etcd state on a cinder volume, separate from the root
+disk. This is a big feature gap for clouds where most of your
+root disks are on spinning disk Ceph, which is not fast enough
+for etcd to operate correctly, but equally you don't have enough
+ssd based Ceph to put all controller root disks on that Ceph:
+https://github.com/kubernetes-sigs/cluster-api-provider-openstack/pull/1668
+
+History
+=======
+
 The helm charts used by this driver started
 out in August 2021 to build a template for
 creating K8s on OpenStack using Cluster API.
@@ -51,3 +205,6 @@ The hope is that helm provides a better interface for per operator
 additions to clusters, and should allow for helm to be updated to
 support new Kubernetes versions, independently from the core
 Magnum code.
+
+
+