<a id="manage-clouds"></a>

# How to manage clouds

> See also: [Cloud (substrate)](https://documentation.ubuntu.com/juju/2.9/reference/cloud.md#cloud), [List of supported clouds](https://documentation.ubuntu.com/juju/2.9/reference/cloud/list-of-supported-clouds.md#list-of-supported-clouds)

This document shows how to manage your existing cloud(s) with Juju.

<a id="add-a-cloud"></a>

## Add a cloud

> See also: [List of supported clouds](https://documentation.ubuntu.com/juju/2.9/reference/cloud/list-of-supported-clouds.md#list-of-supported-clouds) > `<cloud name>`

#### IMPORTANT
This step is typically required only for non-local private clouds.

The procedure for how to add a cloud definition to Juju depends on whether the cloud is a machine (traditional, non-Kubernetes) cloud or rather a Kubernetes cloud.

#### IMPORTANT
In either case, the cloud definition is saved to directory defined in the `JUJU_DATA` environment variable (default path: `~/.local/share/juju/`), in a file called `clouds.yaml`.

<a id="add-a-machine-cloud"></a>

### Add a machine cloud

#### TIP
**If your cloud is a public cloud or a local LXD cloud:** <br>
Juju likely already knows about it, so you can skip this step. Run `juju clouds` to confirm.

To add a machine cloud to Juju, run the `add-cloud` command:

```text
juju add-cloud
```

This will start an interactive session where you’ll be asked to choose a cloud type (from a given list), the name that you want to use for your cloud, the API endpoint, the authentication type, etc. Juju will use this to create a cloud definition.

<!--
, which it will save to the directory defined in the \`JUJU_DATA\` environment variable (default path: \`~/.local/share/juju/\`), in a file called \`clouds.yaml\`
-->

The command also has a manual mode where you can specify the desired cloud name and cloud definition file in-line; whether you want this definition to be known just to the Juju client or also to an existing controller (the latter creates what is known as a multi-cloud controller); etc.

> See more: [juju add-cloud](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/add-cloud.md#command-juju-add-cloud), [Cloud definition](https://documentation.ubuntu.com/juju/2.9/reference/cloud.md#cloud-definition), [JUJU_DATA](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/juju-environment-variables.md#envvar-juju-data)

<a id="add-a-kubernetes-cloud"></a>

### Add a Kubernetes cloud

#### TIP
**If your cloud is a local MicroK8s cloud:** <br>
Juju likely already knows about it, so you can skip this step. Run `juju clouds` to confirm.

To add a Kubernetes cloud to Juju:

1. Prepare your kubeconfig file.
2. Run the `add-k8s` command followed by the desired cloud name:

```text
juju add-k8s <cloud name>
```

Juju will check the default location for the kubeconfig file and  use the information in there to create a cloud definition.

The command also allows you to specify a non-default kubeconfig file path (via the `KUBECONFIG` environment variable); in the case where you have multiple cluster definitions and credentials in your kubeconfig file, which cluster and credential to use; what name you want to assign to your new cloud; whether you want to make this cloud known just to the client or also to an existing controller (the latter gives rise to what is known as a multi-cloud controller); etc.

> See more: [juju add-k8s](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/add-k8s.md#command-juju-add-k8s)

## View all the known clouds

To get a list of all the clouds that your Juju client is currently aware of, run the `clouds` command with the `--client` and `-all` flags:

```text
juju clouds --client --all
```

This will return something similar to:

```text
You can bootstrap a new controller using one of these clouds...

Clouds available on the client:
Cloud        Regions  Default        Type     Credentials  Source    Description
aws          22       us-east-1      ec2      0            public    Amazon Web Services
aws-china    2        cn-north-1     ec2      0            public    Amazon China
aws-gov      2        us-gov-west-1  ec2      0            public    Amazon (USA Government)
azure        43       centralus      azure    0            public    Microsoft Azure
azure-china  4        chinaeast      azure    0            public    Microsoft Azure China
equinix      25       px             equinix  0            public
google       25       us-east1       gce      0            public    Google Cloud Platform
localhost    1        localhost      lxd      1            built-in  LXD Container Hypervisor
microk8s     1        localhost      k8s      1            built-in  A Kubernetes Cluster
oracle       4        us-phoenix-1   oci      0            public    Oracle Compute Cloud Service
```

where each line represents a cloud that Juju can interact with – the cloud name (that you will have to use to interact with the cloud), the number of cloud regions Juju is aware of, the default region (for the current Juju client), the type/API used to control it, the number of credentials associated with a cloud, the source of the cloud, and a brief description.

By omitting the flags, you will see a list of the clouds available on the client for which you have also registered the credentials. Alternatively, by passing other flags you can specify an output format or file, etc.

> See more: [juju clouds](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/clouds.md#command-juju-clouds)

## View details about a cloud

To get more detail about a particular cloud, run the `show-cloud` command followed by the cloud name, e.g.,

```text
juju show-cloud azure
```

The command also has flags that allow you to specify whether you want this information from the client or rather a controller; whether you want the output to include the configuration options specific to the cloud; an output format or file; etc.

> See more: [juju show-cloud](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/show-cloud.md#command-juju-show-cloud)

## Manage cloud regions

### View all the known regions

To see which regions Juju is aware of for any given cloud, use the `regions` command. For example, for the ‘aws’ cloud, run:

```text
juju regions aws
```

This should output something similar to:

```text
Client Cloud Regions
us-east-1
us-east-2
us-west-1
us-west-2
ca-central-1
eu-west-1
eu-west-2
eu-west-3
eu-central-1
eu-north-1
eu-south-1
af-south-1
ap-east-1
ap-south-1
ap-southeast-1
ap-southeast-2
ap-southeast-3
ap-northeast-1
ap-northeast-2
ap-northeast-3
me-south-1
sa-east-1
```

The command also has flags that allow you to select a specific controller, choose an output format or file, etc.

> See more: [juju regions](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/regions.md#command-juju-regions)

### Manage the default region

**Set the default region.** To set the default region for a cloud, run the `default-region` command followed by the name of the cloud and the name of the region that you want to start using as a default. For example:

```text
juju default-region aws eu-central-1
```

If at any point you want to reset this value, drop the region argument and pass the `--reset` flag.

> See more: [juju default-region](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/default-region.md#command-juju-default-region)

**Get the default region.** To get the current default region for a cloud, run the `default-region` command followed by the name of the cloud. For example:

```text
juju default-region azure-china
```

> See more: [juju default-region](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/default-region.md#command-juju-default-region)

## Manage cloud credentials

> See more: [How to manage credentials](https://documentation.ubuntu.com/juju/2.9/howto/manage-credentials.md#manage-credentials)

## Update a cloud

The procedure for how to update a cloud on Juju depends on whether the cloud is public or private.

### Update a public cloud

To synchronise the Juju client with changes occurring on public clouds (e.g. cloud API changes, new cloud regions) or on Juju’s side (e.g. support for a new cloud), run the `update-public-clouds` command:

```text
juju update-public-clouds
```

The command also allows you to specify whether you want this update to happen on the client or rather a controller.

> See more: [juju update-public-clouds](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/update-public-clouds.md#command-juju-update-public-clouds)

### Update a private cloud

To update Juju’s definition for a private cloud, run the `update-cloud` command followed by the cloud name and the `-f` flag followed by the path to the new cloud definition file. For example:

```text
juju update-cloud mymaas -f path/to/maas.yaml
```

The command also allows you to indicate whether the update should happen on the client or the controller; to to update the definition on a controller to match the one on the client; etc.

> See more: [juju update-cloud](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/update-cloud.md#command-juju-update-cloud)
<!--
The definition of an existing cloud can be done locally or, since \`v.2.5.3\`, remotely (on a controller).

For the 'oracle' cloud, for instance, create a [YAML-formatted](http://www.yaml.org/spec/1.2/spec.html) file, say \`oracle.yaml\`, with contents like:

\`\`\`yaml
clouds:
   oracle:
      type: oci
      config:
         compartment-id: <some value>
\`\`\`

Here, the local (client cache) definition is modified:

\`\`\`text
juju update-cloud --local oracle -f oracle.yaml
\`\`\`

This will avoid having to include \`--config compartment-id=<value\` at controller-creation time (\`bootstrap\`).

Here, the remote definition is updated by specifying the controller:

\`\`\`bash
juju update-cloud oracle -f oracle.yaml -c oracle-controller
\`\`\`

If you specify a controller without supplying a YAML file then the remote cloud will be updated according to the client's current knowledge of that cloud.

-->

## Remove a cloud

> See also: [Removing things](https://documentation.ubuntu.com/juju/2.9/reference/removing-things.md#removing-things)

#### IMPORTANT
This only applies to cloud definitions added explicitly via `add-cloud` or `add-k8s`. It removes the cloud definition from the client and/or the controller.

To remove a cloud definition from Juju, run the `remove-cloud` command followed by the name of the cloud. For example:

```text
juju remove-cloud lxd-remote
```

The command also allows you to specify whether this operation should be performed on the client or rather on a specific controller.

> See more: [juju remove-cloud](https://documentation.ubuntu.com/juju/2.9/reference/juju-cli/list-of-juju-cli-commands/remove-cloud.md#command-juju-remove-cloud)