[Tutorial] 2.6.2 - Example Adding a K8S Cloud and Model


I want to give an example breakdown of what it actually took to get a k8s model added.

  1. Deploy CDK + AWS Integrator

Deploy CDK, trusting and relating the aws-integrator. The resultant juju environment should resemble:

Model                   Controller     Cloud/Region   Version  SLA          Timestamp
k8s-jenkins-testing-00  aws-us-west-2  aws/us-west-2  2.6.2    unsupported  00:03:52Z

App                Version   Status  Scale  Charm              Store       Rev  OS      Notes
aws-integrator     1.16.148  active      1  aws-integrator     jujucharms    9  ubuntu  
easyrsa            3.0.1     active      1  easyrsa            jujucharms  235  ubuntu  
etcd               3.2.10    active      1  etcd               jujucharms  414  ubuntu  
flannel            0.10.0    active      2  flannel            jujucharms  403  ubuntu  
kubernetes-master  1.14.1    active      1  kubernetes-master  jujucharms  651  ubuntu  exposed
kubernetes-worker  1.14.1    active      1  kubernetes-worker  jujucharms  518  ubuntu  exposed

Unit                  Workload  Agent  Machine  Public address  Ports           Message
aws-integrator/0*     active    idle   2                  ready
easyrsa/0*            active    idle   0/lxd/0                   Certificate Authority connected.
etcd/0*               active    idle   0   2379/tcp        Healthy with 1 known peer
kubernetes-master/0*  active    idle   0   6443/tcp        Kubernetes master running.
  flannel/1           active    idle                     Flannel subnet
kubernetes-worker/0*  active    idle   1    80/tcp,443/tcp  Kubernetes worker running.
  flannel/0*          active    idle                      Flannel subnet

Machine  State    DNS             Inst id              Series  AZ          Message
0        started   i-0a001a28ab902edbc  bionic  us-west-2a  running
0/lxd/0  started   juju-fee20a-0-lxd-0  bionic  us-west-2a  Container started
1        started    i-00b30638165b366b2  bionic  us-west-2a  running
2        started  i-0dd296592dfe14cb9  bionic  us-west-2b  running
  1. SCP the kubeconfig, export, add-cloud
    Following the deployment of our kubernetes cluster we scp the kubeconfig to local, export KUBECONFIG env var, and add a juju model (juju prevented us from doing this and landed a well phrased error).
$ juju scp kubernetes-master/0:config ~/.kube/
$ export KUBECONFIG=~/.kube/config
$ juju add-k8s bdx-k8s-cloud 

ERROR 	Juju needs to query the k8s cluster to ensure that the recommended
	storage defaults are available and to detect the cluster's cloud/region.
	This was not possible in this case so run add-k8s again, using
	--storage=<name> to specify the storage class to use and
	--region=<cloudType>/<region> to specify the cloud/region.

This led us to manually provision a storage class and provide the cloud/region and storage when running the add-k8s command.

Here are a few different storage classes that we use in AWS.

EBS StorageClass
$ kubectl create -f - <<EOY
apiVersion: storage.k8s.io/v1
kind: StorageClass
  name: ebs-1
provisioner: kubernetes.io/aws-ebs
  type: gp2
Local StorageClass
kubectl create -f - <<EOY
apiVersion: storage.k8s.io/v1
kind: StorageClass
  name: local-1
provisioner: kubernetes.io/no-provisioner
volumeBindingMode: WaitForFirstConsumer

With either of the above storage classes created we were able to successfully add a k8s cloud by specifying the StorageClass name when adding the cloud. For example, using ebs-1 from above:

juju add-k8s bdx-k8s-cloud --storage=ebs-1 --region aws/us-west-2

k8s substrate "aws/us-west-2" added as cloud "bdx-k8s-cloud" with storage provisioned
by the existing "ebs-1" storage class
operator storage provisioned by the workload storage class.
  1. Add K8S Model
    Finally add the model.
juju add-model bdx-k8s-model bdx-k8s-cloud
Added 'bdx-k8s-model' model on bdx-k8s-cloud with credential 'admin' for user 'bdx'

This is how I was able to get a k8s model up using 2.6.2. I haven’t yet come across any documentation that details the portion of creating a storage class using kubectl in the workflow of creating a model. Just thought I would document my experience.


Thanks @jamesbeedy. The storage class issue was something that tripped me up also.

I’ve tried to make things explicit in this tutorial. Haven’t received any comments on it yet, but hopefully the instructions are clear.


If you had specified --region aws/us-west-2 in your original command then the EBS storage class would have been used straight away. See tutorial Installing Kubernetes with CDK and using auto-configured storage.