---
title: Charmhub | Deploy Apache Kafka Connect - K8s using Charmhub - The Open Operator
Collection
description: Deploy the latest version of Apache Kafka Connect - K8s as a Kubernetes
Operator on any cloud.
url: https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks
---
# Apache Kafka Connect - K8s
[Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")
* [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")
Platform:
4/stable 18
```
juju deploy kafka-connect-k8s --channel 4/stable
```
[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)
---
#### Relevant links
* [Homepage](https://github.com/canonical/kafka-connect-k8s-operator)
---
#### Contacts
##### Maintainers
+ [Canonical Data Platform](mailto:data-platform@lists.launchpad.net)
* [Submit a bug](https://github.com/canonical/kafka-connect-k8s-operator/issues)
---
Share your thoughts on this charm with the community on discourse.
[Join the discussion](https://discourse.charmhub.io/)
# How to deploy on AKS
[Azure Kubernetes Service](https://learn.microsoft.com/en-us/azure/aks/) (AKS) allows you to quickly deploy a production ready Kubernetes cluster in Azure. To access the AKS Web interface, go to .
## [Summary](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-summary)
* [Install Azure and Juju tooling](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#install-client-environment)
* [Create AKS Cluster](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#create-aks-cluster)
* [Bootstrap Juju controller on AKS](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#bootstrap-juju-controller-on-aks)
* [Deploy charms](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#deploy-charms)
* [Display deployment information](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#display-deployment-information)
* [Clean up](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#clean-up)
---
## [Install Client Environment](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-install-client-environment)
Client environment includes:
* Juju
* Azure CLI
### [Juju](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-juju)
Install Juju via snap:
```
sudo snap install juju --channel 3.5/stable
```
Check that the Juju version is correctly installed:
```
juju version
```
Sample output:
```
3.5.2-genericlinux-amd64
```
### [Azure CLI](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-azure-cli)
Follow the [user guide](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt) for installing the Azure CLI on Linux distributions.
Verify that it is correctly installed running the command below:
```
az --version
```
Sample output:
```
azure-cli 2.65.0
core 2.65.0
telemetry 1.1.0
Dependencies:
msal 1.31.0
azure-mgmt-resource 23.1.1
Python location '/opt/az/bin/python3'
Extensions directory '/home/deusebio/.azure/cliextensions'
Python (Linux) 3.11.8 (main, Sep 25 2024, 11:33:44) [GCC 11.4.0]
Legal docs and information: aka.ms/AzureCliLegal
Your CLI is up-to-date.
```
## [Create AKS cluster](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-create-aks-cluster)
Login to your Azure account:
```
az login
```
Create a new [Azure Resource Group](https://learn.microsoft.com/en-us/cli/azure/manage-azure-groups-azure-cli):
```
az group create --name --location
```
The placeholder `` can be a label of your choice, and it will be used to tag
the resources created on Azure. Also the following guide will use the single server AKS,
using `LOCATION=eastus` - but feel free to change this for your own deployment.
Bootstrap AKS with the following command (increase nodes count/size if necessary):
```
az aks create -g -n $ --enable-managed-identity --node-count 1 --node-vm-size= --generate-ssh-keys
```
We recommend selecting an instance type that provides at the very least `16` GB of RAM and `4` cores, e.g. `Standard_A4_v4`.
You can find more information about the available instance types in the [Azure documentation](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview).
Sample output:
```
{
"aadProfile": null,
"addonProfiles": null,
"agentPoolProfiles": [
{
"availabilityZones": null,
"capacityReservationGroupId": null,
"count": 1,
"creationData": null,
"currentOrchestratorVersion": "1.28.9",
"enableAutoScaling": false,
"enableEncryptionAtHost": false,
"enableFips": false,
"enableNodePublicIp": false,
...
```
Dump newly bootstrapped AKS credentials:
```
az aks get-credentials --resource-group --name --context aks
```
Sample output:
```
...
Merged "aks" as current context in ~/.kube/config
```
You can verify that the cluster and your client `kubectl` CLI is correctly configured by running a simple command, such as:
```
kubectl get pod -A
```
which should provide the list of the pod services running.
## [Bootstrap Juju controller on AKS](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-bootstrap-juju-controller-on-aks)
Bootstrap Juju controller:
```
juju bootstrap aks
```
Sample output:
```
Creating Juju controller "aks" on aks/eastus
Bootstrap to Kubernetes cluster identified as azure/eastus
Creating k8s resources for controller "controller-aks"
Downloading images
Starting controller pod
Bootstrap agent now started
Contacting Juju controller at 20.231.233.33 to verify accessibility...
Bootstrap complete, controller "aks" is now available in namespace "controller-aks"
Now you can run
juju add-model
to create a new model to deploy k8s workloads.
```
## [Deploy Charms](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-deploy-charms)
Create a new Juju model, if needed:
```
juju add-model
```
(Optional) Increase the debug level if you are troubleshooting charms:
```
juju model-config logging-config='=INFO;unit=DEBUG'
```
Then, Charmed Apache Kafka can be deployed as usual:
```
juju deploy zookeeper-k8s -n3 --channel 3/stable --trust
juju deploy kafka-k8s -n3 --channel 3/stable --trust
juju integrate kafka-k8s zookeeper-k8s
```
We also recommend to deploy a [Data Integrator](https://charmhub.io/data-integrator) for creating an admin user to manage the content of the Kafka cluster:
```
juju deploy data-integrator admin --channel edge \
--config extra-user-roles=admin \
--config topic-name=admin-topic
```
And integrate it with the Kafka application:
```
juju integrate kafka-k8s admin
```
For more information on Data Integrator and how to use it, please refer to the [how-to manage applications](https://discourse.charmhub.io/t/charmed-kafka-how-to-manage-app/10285) user guide.
## [Display deployment information](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-display-deployment-information)
Display information about the current deployments with the following commands:
```
kubectl cluster-info
```
Sample output:
```
Kubernetes control plane is running at https://aks-user-aks-aaaaa-bbbbb.hcp.eastus.azmk8s.io:443
CoreDNS is running at https://aks-user-aks-aaaaa-bbbbb.hcp.eastus.azmk8s.io:443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
Metrics-server is running at https://aks-user-aks-aaaaa-bbbbb.hcp.eastus.azmk8s.io:443/api/v1/namespaces/kube-system/services/https:metrics-server:/proxy
```
```
az aks list
```
Sample output:
```
...
"count": 1,
"currentOrchestratorVersion": "1.28.9",
"enableAutoScaling": false,
...
```
```
kubectl get node
```
Sample output:
```
NAME STATUS ROLES AGE VERSION
aks-nodepool1-31246187-vmss000000 Ready agent 11m v1.28.9
```
## [Clean up](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-aks#p-34317-clean-up)
Always clean AKS resources that are no longer necessary - they could be costly!
To clean the AKS cluster, resources and juju cloud, run the following commands:
```
juju destroy-controller --destroy-all-models --destroy-storage --force
```
List all services and then delete those that have an associated EXTERNAL-IP value (load balancers, …):
```
kubectl get svc --all-namespaces
kubectl delete svc
```
Next, delete the AKS resources (source: Deleting an all Azure VMs)
```
az aks delete -g -n
```
Finally, logout from AKS to clean the local credentials (to avoid forgetting and getting exposed to a risk of leaking credentials):
```
az logout
```
---