From 830429211d6bfd501a4c1089ec87755c6605d0b5 Mon Sep 17 00:00:00 2001
From: louiseschmidtgen <louise.schmidtgen@canonical.com>
Date: Thu, 28 Nov 2024 15:53:53 +0100
Subject: [PATCH] how to openstack integration

---
 docs/src/charm/howto/index.md     |   1 +
 docs/src/charm/howto/openstack.md | 104 ++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)
 create mode 100644 docs/src/charm/howto/openstack.md

diff --git a/docs/src/charm/howto/index.md b/docs/src/charm/howto/index.md
index 82438604b..3ce19dc0e 100644
--- a/docs/src/charm/howto/index.md
+++ b/docs/src/charm/howto/index.md
@@ -16,6 +16,7 @@ Overview <self>
 
 charm
 install-lxd
+openstack
 Integrate with etcd <etcd>
 Integrate with ceph-csi <ceph-csi>
 proxy
diff --git a/docs/src/charm/howto/openstack.md b/docs/src/charm/howto/openstack.md
new file mode 100644
index 000000000..89aee67a9
--- /dev/null
+++ b/docs/src/charm/howto/openstack.md
@@ -0,0 +1,104 @@
+# Integrating with OpenStack
+
+This guide explains how to integrate {{product}} with the OpenStack cloud
+platform.
+
+## Prerequisites
+
+To follow this guide, you will need:
+
+- An [OpenStack][openstack] cloud environment.
+- Juju set-up as the deployment tool for Openstack. Please refer to
+  [Juju and Openstack][juju-openstack] documentation for more information.
+- An OpenStack [project][project] with the necessary permissions to deploy
+  {{product}}.
+- A juju [controller][controller] with [access][credentials] to the OpenStack 
+  cloud environment.
+- A juju [model][model] for deploying {{product}} on OpenStack.
+- Configured [proxy configuration][proxy] in constrained environments.
+
+## Deploying {{product}} on OpenStack
+
+
+To deploy the {{product}} [bundle][bundle] on OpenStack you need an overlay
+bundle which serves as an extension of the core bundle. The overlay bundle
+contains the necessary configuration to deploy {{product}} on OpenStack.
+
+Refer to the base overlay [openstack-lb-overlay.yaml][openstack-overlay] and
+modify it as needed.
+
+### OpenStack overlay configurations:
+
+Run `openstack project list` to retrieve your project id and include the
+[project id][project] in the overlay template:
+
+```yaml
+applications:
+  openstack-integrator:
+    options:
+      project-id: <my-openstack-project-id>
+```
+
+
+Adjust [easyrsa][easyrsa] to avoid creating an LXD machine:
+
+```yaml
+applications:
+  easyrsa:
+    to:
+      - 0
+```
+
+The modified overlay template should look like this:
+
+```yaml
+applications:
+  kubeapi-load-balancer: null
+  kubernetes-control-plane:
+    options:
+      allow-privileged: "true"
+  openstack-integrator:
+    charm: openstack-integrator
+    num_units: 1
+    trust: true
+    options:
+      project-id: <my-openstack-project-id>
+  openstack-cloud-controller:
+    charm: openstack-cloud-controller
+  cinder-csi:
+    charm: cinder-csi
+  easyrsa: 
+    to:   
+      - 0 
+relations:
+  - [openstack-cloud-controller:certificates,            easyrsa:client]
+  - [openstack-cloud-controller:kube-control,            kubernetes-control-plane:kube-control]
+  - [openstack-cloud-controller:external-cloud-provider, kubernetes-control-plane:external-cloud-provider]
+  - [openstack-cloud-controller:openstack,               openstack-integrator:clients]
+  - [easyrsa:client,                                     cinder-csi:certificates]
+  - [kubernetes-control-plane:kube-control,              cinder-csi:kube-control]
+  - [openstack-integrator:clients,                       cinder-csi:openstack]
+  - [kubernetes-control-plane:loadbalancer-external,     openstack-integrator:lb-consumers]
+```
+
+Deploy the {{product}} bundle on OpenStack using the modified overlay:
+
+```bash
+juju deploy canonical-kubernetes --overlay openstack-lb-overlay.yaml --trust
+```
+
+The {{product}} bundle is now deployed and integrated with OpenStack. Run 
+`juju status --watch 1s` to monitor the deployment. It is possible that your
+deployment will take a few minutes until all the components are up and running.
+
+<!-- LINKS -->
+[openstack]: https://www.openstack.org/
+[project]: https://docs.openstack.org/python-openstackclient/queens/cli/command-objects/project.html
+[juju-openstack]: https://juju.is/docs/juju/openstack
+[controller]: https://juju.is/docs/juju/manage-controllers
+[model]: https://juju.is/docs/juju/manage-models
+[proxy]: https://documentation.ubuntu.com/canonical-kubernetes/main/src/charm/howto/proxy/
+[credentials]: https://juju.is/docs/juju/manage-credentials
+[bundle]: https://juju.is/docs/juju/bundle
+[openstack-overlay]: https://github.com/charmed-kubernetes/bundle/blob/main/overlays/openstack-lb-overlay.yaml
+[easyrsa]: https://easy-rsa.readthedocs.io/en/latest/