In this lab, we will deploy the Open Service Broker for Azure and the Kubernetes Service Catalog to automate the delivery of CosmosDB and configuration of our application.
Note: the Kubernetes version of your cluster should be > 1.9.0, otherwise you will get an error while trying to install OSBA.
- Ensure Helm 2.7+ is Installed and Working
- In prior labs, we used helm to install charts. Check to see if it is working and the version is 2.7 or above.
odl_user@Azure:~$ helm version
Client: &version.Version{SemVer:"v2.11.0", GitCommit:"9ad53aac42165a5fadc6c87be0dea6b115f93090", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.11.0", GitCommit:"9ad53aac42165a5fadc6c87be0dea6b115f93090", GitTreeState:"clean"}
- If a newer version of Helm is required, click here for instructions on installing and updating Helm.
- Install Service Catalog on AKS
helm repo add svc-cat https://svc-catalog-charts.storage.googleapis.com
helm install svc-cat/catalog --name catalog --namespace catalog --set controllerManager.healthcheck.enabled=false
- Gather Config Details
- Gather the following Subscription and Service Principal details. If you are using the Workshop Classroom experience, these values will be on the Launch Lab screen and you should have also received an e-mail copy. Otherwise, you could for example run this command
az ad sp create-for-rbac
.
# set the below to values for your sub
export AZURE_SUBSCRIPTION_ID=
export AZURE_TENANT_ID=
export AZURE_CLIENT_ID=
export AZURE_CLIENT_SECRET=
- Deploy the Service Broker Chart
- Now that all the pre-requisites have been setup and the configuration details gathered. We are now ready to install OSBA via the Helm Chart.
helm repo add azure https://kubernetescharts.blob.core.windows.net/azure
helm install azure/open-service-broker-azure --name osba --namespace osba \
--set azure.subscriptionId=$AZURE_SUBSCRIPTION_ID \
--set azure.tenantId=$AZURE_TENANT_ID \
--set azure.clientId=$AZURE_CLIENT_ID \
--set azure.clientSecret=$AZURE_CLIENT_SECRET \
--set modules.minStability=EXPERIMENTAL \
--version 0.11.0
This may take a few minutes to start running. We must wait for redis to start. Go get some coffee.
- Check Components
In this step we will check to see that the Service Catalog and OSBA components are up and running.
odl_user@Azure:~$ kubectl get pod -n catalog
NAME READY STATUS RESTARTS AGE
catalog-catalog-apiserver-1988923711-qg940 2/2 Running 0 1h
catalog-catalog-controller-manager-1758219338-hgw48 1/1 Running 0 1h
odl_user@Azure:~$ kubectl get pod -n osba
NAME READY STATUS RESTARTS AGE
osba-open-service-broker-azure-1684006674-kflp2 1/1 Running 4 5m
osba-redis-3506537388-f6k17 1/1 Running 0 5m
- Clear Existing App Out of Cluster
- Remove the previous application out of your cluster by deleting your deployments to ensure the OSBA version is the only one and there are no conflicts.
- Review the
heroes-cosmosdb.yaml
file in thehelper-files
directory
- Along with the web and api configs, you will see a
ServiceInstance
object and aServiceBinding
object. - You will also see a secret defined in the API deployment that sets the Mongo DB environment variables for connecting to the Cosmos DB Mongo DB API.
- Deploy the Application using OSBA
- This step will provision the entire application with the Cosmos Mongo DB back-end done via OSBA.
cd ~/blackbelt-aks-hackfest/labs/helper-files
kubectl apply -f heroes-cosmosdb.yaml
- Review the Resulting Objects
- By looking at the following Kubernetes resources you will see all the different resources that make up the OSBA deployment.
kubectl get pod,secret,serviceinstance,servicebinding
Before proceeding to the next step ensure all of the resources are created and up and running.
- Enable Aggregation Pipelines in Cosmos DB
- A preview feature of Cosmos DB is being leveraged so it needs to be enabled. In the future this will be able to be done via OSBA.
- The first step is to log into the az cli via the Cloud Shell and using your Azure Service Principal.
- Check to see that az cli version is 2.0.27 or greater.
az --version
- If the az cli is < 2.0.27 then update the cli.
# Do this in Cloud Shell and ensure az --version is 2.0.27 or greater
az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET --tenant $AZURE_TENANT_ID
- You are now logged in as the Service Principal, enable the Preview Feature
# Grab the name of the Cosmos DB Account.
az cosmosdb list -o table
COSMOS_DB_ACCOUNT_NAME=$(az cosmosdb list -o table --query '[].{name:name,resourceGroup:resourceGroup}' | grep "heroes" | awk '{print $1}')
# Use the name value from above and substitute into {COSMOS_DB_ACCOUNT_NAME}.
# The Resource Group name comes from the K8S manifest file under ServiceInstance.
az cosmosdb update -n $COSMOS_DB_ACCOUNT_NAME -g heroes-cosmosdb --capabilities EnableAggregationPipeline
- Validate the App Works
- Just like in the previous labs, find the web Kubernetes svc and use that Public IP address to hit the website in your browser.
kubectl get svc