openstack integrator #0

Supports: xenial

Add to new model


This charm can grant select permissions to instances of applications
related to it which enable integration with OpenStack specific features,
such as firewalls, load balancing, block storage, object storage, etc.


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.


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, CDK has support for this, and can be deployed with the
following bundle overlay:

yaml applications: openstack-integrator: charm: cs:~containers/openstack-integrator num_units: 1 relations: - ['openstack-integrator', 'kubernetes-master'] - ['openstack-integrator', 'kubernetes-worker']

Using Juju 2.4-beta1 or later:

juju deploy cs:canonical-kubernetes --overlay ./k8s-openstack-overlay.yaml juju trust openstack-integrator

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.


Following are some examples using OpenStack integration with CDK.

Creating a pod with a PersistentDisk-backed volume

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



create a storage class using the provisioner

kubectl create -f - <<EOY
kind: StorageClass
name: openstack-standard provisioner:

create a persistent volume claim using that storage class

kubectl create -f - <<EOY
kind: PersistentVolumeClaim
apiVersion: v1
name: testclaim spec:
accessModes: - ReadWriteOnce resources: requests: storage: 100Mi storageClassName: openstack-standard EOY

create the busybox pod with a volume using that PVC:

kubectl create -f - <<EOY
apiVersion: v1
kind: Pod
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 run hello-world --replicas=5 --labels="run=load-balancer-example" --port=8080
kubectl expose deployment hello-world --type=LoadBalancer --name=hello
watch kubectl get svc -o wide --selector=run=load-balancer-example


(string) The URL of the keystone API used to authenticate. On OpenStack control panels, this can be found at Access and Security > API Access > Credentials.
(string) The base64-encoded contents of a JSON file containing OpenStack credentials. The credentials must contain the following keys: auth-url, username, password, project-name, user-domain-name, and project-domain-name. It could also contain a base64-encoded CA certificate in endpoint-tls-ca key value. This can be used from bundles with 'include-base64://' (see, or from the command-line with 'juju config openstack credentials="$(base64 /path/to/file)"'. It is strongly recommended that you use 'juju trust' instead, if available.
(string) A CA certificate that can be used to verify the target cloud API endpoints. Use 'include-base64://' in a bundle to include a certificate. Otherwise, pass a base64-encoded certificate (base64 of "-----BEGIN" to "-----END") as a config option in a Juju CLI invocation.
(string) Password of a valid user set in keystone.
(string) Name of the project domain where you want to create your resources.
(string) Name of project where you want to create your resources.
(string) Name of the user domain where you want to create your resources.
(string) Username of a valid user set in keystone.