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

# VMware vSphere 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 a55d6e8

```
juju deploy vsphere-integrator
```

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

---

#### Relevant links

* [Contact](mailto:Kevin Monroe <kevin.monroe@canonical.com>)

---

#### Contacts

##### Maintainers

+ [Kevin Monroe](mailto:kevin.monroe@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 VMware vSphere and provides an [interface](https://github.com/juju-solutions/interface-vsphere-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/vsphere-integrator#p-17736-usage)

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

For example, [Charmed Kubernetes](https://charmhub.io/charmed-kubernetes) has support for this, and can be
deployed with the following bundle overlay:

```
applications:
  vsphere-integrator:
    charm: cs:~containers/vsphere-integrator
    num_units: 1
relations:
  - ['vsphere-integrator', 'kubernetes-control-plane']
  - ['vsphere-integrator', 'kubernetes-worker']
```

Using Juju 2.4 or later:

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

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

```
cat <<EOJ > /path/to/cloud.json
{
  "vsphere_ip": "a.b.c.d",
  "user": "joe",
  "password": "passw0rd",
  "datacenter": "dc0"
}
EOJ

juju config vsphere-integrator credentials="$(base64 /path/to/cloud.json)"
```

## [Configuration](https://charmhub.io/vsphere-integrator#p-17736-configuration)

This charm supports multiple config options that can be used to describe they
vSphere environment.

The only required option is `datastore`, as it is not included in the Juju
credential that this charm relies on. By default, this is set to *datastore1*.
This can be changed with:

```
juju config vsphere-integrator datastore='mydatastore'
```

You may also configure a *folder* and *resource pool path* for this charm.
Details about these options can be found in the [vmware documentation](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/existing.html):

```
juju config vsphere-integrator folder='juju-kubernetes' respool_path='foo'
```

As mentioned in the **Usage** section, `credentials` may be set with a
base64-encoded json file. When set, this data will take precedent over all
other methods of specifying credentials for this charm.

If `credentials` is empty, there are config options for each key that
constitute a Juju credential. These can be set with:

```
juju config vsphere-integrator \
  vsphere_ip='a.b.c.d' \
  user='joe' \
  password='passw0rd' \
  datacenter='dc0'
```

> Note: If any of the credential config options are set, they must all be set.

When all of the credential config options are empty, this charm will fall
back to the credential data it received with `juju trust vsphere-integrator`.

## [Resource Usage Note](https://charmhub.io/vsphere-integrator#p-17736-resource-usage-note)

By relating to this charm, other charms can directly allocate resources, such
as PersistentDisk volumes, 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
vCenter console or API.

## [Examples](https://charmhub.io/vsphere-integrator#p-17736-examples)

The following are some examples using vSphere integration with Charmed
Kubernetes.

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

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

```
#!/bin/bash

# create a storage class using the `kubernetes.io/vsphere-volume` provisioner
kubectl create -f - <<EOY
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: mystorage
provisioner: kubernetes.io/vsphere-volume
parameters:
  diskformat: zeroedthick
EOY

# create a persistent volume claim using that storage class
kubectl create -f - <<EOY
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: testclaim
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 100Mi
  storageClassName: mystorage
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
```

---

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