See also: Cloud, List of supported clouds
This document shows how to manage your existing cloud(s) with Juju.
Add a cloud
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.
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.
Add a machine cloud
If your cloud is a public cloud or a local LXD cloud:
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:
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.
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, Cloud definition,jujuenvironment variables >JUJU_DATA
Add a Kubernetes cloud
If your cloud is a local MicroK8s cloud:
Juju likely already knows about it, so you can skip this step. Run juju clouds to confirm.
To add a Kubernetes cloud to Juju:
-
Prepare your kubeconfig file.
-
Run the
add-k8scommand followed by the desired cloud name:
You must replace the client from the strictly confined snap (juju) with its ‘raw’ version from the snap directory (/snap/juju/current/bin/juju). So, instead of the command below, run /snap/juju/current/bin/juju add-k8s <cloud name>.
This is required because, starting with Juju 3.0, the juju CLI client is a strictly confined snap, whereas the public cloud CLIs are not (see discussion), and it is only necessary for this step – for any other step you can go back to using the client from the strictly confined snap (so, you can keep typing just juju).
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
Terraform Juju supports only managing kubernetes clouds. Please use the juju CLI instead in case you need to manage regular clouds.
To add a kubernetes cloud on the controller specified in the juju provider definition, in your Terraform plan create a resource of the juju_kubernetes_cloud type, specifying, at the very least, a name. For example:
resource "juju_kubernetes_cloud" "my-k8s-cloud" {
name = "my-k8s-cloud"
kubernetes_config = file("<path-to-my-kubennetes-cloud-config>.yaml")
}
resource "juju_model" "my-model" {
name = "my-model"
credential = juju_kubernetes_cloud.my-k8s-cloud.credential
cloud {
name = juju_kubernetes_cloud.my-k8s-cloud.name
}
}
Where:
Required
name(String) The name of the cloud. Changing this value will cause the cloud to be destroyed and recreated by terraform.
Optional
kubernetes_config(String, Sensitive) The kubernetes config file path for the cloud. Cloud credentials will be added to the Juju controller for you.parent_cloud_name(String) The parent cloud name in case adding k8s cluster from existed cloud. Changing this value will cause the cloud to be destroyed and recreated by terraform.parent_cloud_region(String) The parent cloud region name in case adding k8s cluster from existed cloud. Changing this value will cause the cloud to be destroyed and recreated by terraform.
Read-Only
credential(String) The name of the credential created for this cloud.
See more:
juju_kubernetes_cloud(resource)
Note that, with
python-libjuju, you can only add a cloud definition to a controller you’ve already bootstrapped with thejujuclient.
To add a cloud, you may use the Controller.add_cloud() method on a connected Controller object.
from juju.client import client as jujuclient
await my_controller.add_cloud("my-cloud",
jujuclient.Cloud(
auth_types=["userpass"],
endpoint="http://localhost:1234",
type_="kubernetes",
))
See more:
add_cloud(method),Cloud(object)
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:
juju clouds --client --all
This will return something similar to:
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
The terraform juju client does not support this. Please use the juju client.
To get all clouds known to the controller, you may use the Controller.clouds() method on a connected Controller object. It will return a list of Cloud objects.
await my_controller.clouds()
See more:
clouds(method),Cloud(object)
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.,
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
The terraform juju client does not support this. Please use the juju client.
To get more detail about a particular cloud, you may use the Controller.cloud() method on a connected Controller object. It will return a Cloud object.
await my_controller.cloud()
See more:
cloud(method),Cloud(object)
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:
juju regions aws
This should output something similar to:
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
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:
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
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:
juju default-region azure-china
See more:
juju default-region
The terraform juju client does not support this. Please use the juju client.
The python-libjuju client does not support this. Please use the juju client.
Manage cloud 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:
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
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:
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
The terraform juju client does not support this. Please use the juju client.
The python-libjuju client does not support this. Please use the juju client.
Remove a cloud
See also: Removing things reference
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:
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
The terraform juju client does not support this. Please use the juju client.
To remove a cloud definition, you may use the Controller.remove_cloud() method on a connected Controller object.
await my_controller.remove_cloud()
See more:
remove_cloud(method)
Contributors: @anthonydillon, @cderici, @danieleprocida, @hmlanigan, @nottrobin , @pedroleaoc, @pmatulis, @timclicks, @tmihoc