---
title: Charmhub | Deploy OpenStack Integrator using Charmhub - The Open Operator Collection
description: Deploy the latest version of OpenStack Integrator on any cloud. Proxy
  charm to enable OpenStack integrations via Juju relations.
url: https://charmhub.io/openstack-integrator
---

# OpenStack Integrator

[Canonical Kubernetes](https://charmhub.io/publisher/containers "View all packages from Canonical Kubernetes")

* [Canonical Kubernetes](https://charmhub.io/publisher/containers "View all packages from Canonical Kubernetes")

Platform:

24.04

22.04

20.04

18.04

16.04

stable d164aca

```
juju deploy openstack-integrator
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Relevant links

* [Contact](mailto:Cory Johns <cory.johns@canonical.com>)

---

#### Contacts

##### Maintainers

+ [Cory Johns](mailto:cory.johns@canonical.com)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

**This charm acts as a proxy to OpenStack** and provides an [interface](https://github.com/juju-solutions/interface-openstack-integration) to provide a set of credentials for a somewhat limited project user to the applications that are related to this charm.

## [Usage](https://charmhub.io/openstack-integrator#p-29715-usage)

When on OpenStack, this charm can be deployed, granted trust via Juju to access OpenStack, and then related to an application that supports the [interface](https://github.com/juju-solutions/interface-openstack-integration).

For example, [Charmed Kubernetes](https://charmhub.io/charmed-kubernetes) has support for this, and can be deployed with the following bundle overlay ([download it here](https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/overlays/openstack-overlay.yaml) ):

```
applications:
  kubernetes-control-plane:
    options:
      allow-privileged: "true"
  openstack-integrator:
    annotations:
    charm: openstack-integrator
    num_units: 1
    trust: true
  openstack-cloud-controller:
    charm: openstack-cloud-controller
  cinder-csi:
    charm: cinder-csi
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]
```

Using Juju 2.4 or later:

```
juju deploy charmed-kubernetes --overlay ./k8s-openstack-overlay.yaml --trust
```

To deploy with earlier versions of Juju, you will need to provide the cloud credentials via the `credentials`, charm config options.

# Resource Usage Note

By relating to this charm, other charms can directly allocate resources, such as PersistentDisk volumes and Load Balancers, which could lead to cloud charges and count against quotas. Because these resources are not managed by Juju, they will not be automatically deleted when the models or applications are destroyed, nor will they show up in Juju’s status or GUI. It is therefore up to the operator to manually delete these resources when they are no longer needed, using the OpenStack console or API.

# Examples

Following are some examples using OpenStack integration with Charmed Kubernetes.

## [Creating a pod with a PersistentDisk-backed volume](https://charmhub.io/openstack-integrator#p-29715-creating-a-pod-with-a-persistentdisk-backed-volume)

This script creates a busybox pod with a persistent volume claim backed by OpenStack’s PersistentDisk.

```
#!/bin/bash

# create a persistent volume claim using the StorageClass which is
# automatically created by cinder-csi when it is related to
# the openstack-integrator
kubectl create -f - <<EOY
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: testclaim
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 100Mi
  storageClassName: cinder-csi-default
EOY

# create the busybox pod with a volume using that PVC:
kubectl create -f - <<EOY
apiVersion: v1
kind: Pod
metadata:
  name: busybox
  namespace: default
spec:
  containers:
    - image: busybox
      command:
        - sleep
        - "3600"
      imagePullPolicy: IfNotPresent
      name: busybox
      volumeMounts:
        - mountPath: "/pv"
          name: testvolume
  restartPolicy: Always
  volumes:
    - name: testvolume
      persistentVolumeClaim:
        claimName: testclaim
EOY
```

## [Creating a service with a OpenStack load-balancer](https://charmhub.io/openstack-integrator#p-29715-creating-a-service-with-a-openstack-load-balancer)

The following script starts the hello-world pod behind a OpenStack-backed load-balancer.

```
kubectl create deployment hello-world --image=gcr.io/google-samples/node-hello:1.0
kubectl scale deployment hello-world --replicas=5
kubectl expose deployment hello-world --type=LoadBalancer --name=hello --port=8080
watch kubectl get svc hello -o wide
```

## [Project and community](https://charmhub.io/openstack-integrator#p-29715-project-and-community)

**openstack-integrator** is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

* [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct)
* Get support
* Join our online chat
* Contribute
* Roadmap

Thinking about using Example Charm / Charm Bundle for your next project? Get in touch!

---

[Help improve this document in the forum](https://discourse.charmhub.io/t/openstack-integrator-docs-index/12980) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 2 years ago.