OpenStack Integrator

  • By Canonical Kubernetes
Channel Revision Published Runs on
latest/stable 78 21 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
latest/candidate 78 15 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
latest/beta 79 19 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
latest/edge 80 01 May 2024
Ubuntu 22.04 Ubuntu 20.04
1.30/beta 79 19 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
1.30/edge 80 01 May 2024
Ubuntu 22.04 Ubuntu 20.04
1.29/stable 78 21 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
1.29/candidate 78 15 Apr 2024
Ubuntu 22.04 Ubuntu 20.04
1.29/beta 74 24 Jan 2024
Ubuntu 22.04 Ubuntu 20.04
1.29/edge 75 25 Jan 2024
Ubuntu 22.04 Ubuntu 20.04
1.28/stable 69 22 Aug 2023
Ubuntu 22.04 Ubuntu 20.04
1.28/candidate 59 07 Jun 2023
Ubuntu 22.04 Ubuntu 20.04
1.28/beta 69 07 Aug 2023
Ubuntu 22.04 Ubuntu 20.04
1.28/edge 71 17 Aug 2023
Ubuntu 22.04 Ubuntu 20.04
1.27/stable 59 12 Jun 2023
Ubuntu 22.04 Ubuntu 20.04
1.27/candidate 59 12 Jun 2023
Ubuntu 22.04 Ubuntu 20.04
1.27/beta 56 09 Apr 2023
Ubuntu 22.04 Ubuntu 20.04
1.27/edge 54 07 Apr 2023
Ubuntu 22.04 Ubuntu 20.04
1.26/stable 53 27 Feb 2023
Ubuntu 22.04 Ubuntu 20.04
1.26/candidate 53 25 Feb 2023
Ubuntu 22.04 Ubuntu 20.04
1.26/beta 46 09 Apr 2023
Ubuntu 22.04 Ubuntu 20.04
1.26/edge 46 23 Nov 2022
Ubuntu 22.04 Ubuntu 20.04
1.25/stable 45 30 Sep 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.25/candidate 45 28 Sep 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.25/beta 47 01 Dec 2022
Ubuntu 22.04 Ubuntu 20.04
1.25/edge 35 09 Sep 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.24/stable 28 04 Aug 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.24/candidate 28 01 Aug 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.24/beta 19 03 May 2022
Ubuntu 20.04 Ubuntu 18.04 Ubuntu 16.04
1.24/edge 27 22 Jul 2022
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
1.23/beta 8 22 Mar 2022
Ubuntu 20.04 Ubuntu 18.04 Ubuntu 16.04
1.23/edge 6 24 Feb 2022
Ubuntu 20.04 Ubuntu 18.04 Ubuntu 16.04
juju deploy openstack-integrator
Show information

Platform:

Ubuntu
22.04 20.04

This charm acts as a proxy to OpenStack and provides an interface to provide a set of credentials for a somewhat limited project user to the applications that are related to this charm.

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.

For example, Charmed Kubernetes has support for this, and can be deployed with the following bundle overlay (download it here ):

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

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

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

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.

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