observability-lab

🚨 Important: In case you are following the workshop, don't check out the main branch of this repos or follow the README. Instead go to the first section of the workshop and follow the workshop instruction on there 01-provision-infrastructure/

Quick setup

The Makefile automates infrastructure creation and applications deployment within a couple of commands. To use it create a .env in the root of the project and add the following content to it.

ENV_RESOURCE_GROUP_NAME=       # name of the resource group that will be created in your Azure subscription
ENV_LOCATION="westeurope"      # Azure region to use for the created infrastructure
ENV_PROJECT_NAME=              # project name that will be used for all created resources; should contain only lowercase letters or numbers

To provision infrastructure, deploy applications and the Open Telemetry Collector to the cluster, run the following commands:

az login --tenant <tenant ID>   // when prompted, select the desired Azure subscription
make

Connect to the Devices API (URL is specified in the output of the previous command, though it takes a couple of minutes until the API is fully operational), and create a couple of devices using the POST method.

Once devices are created, you can start the Devices Data Simulator, which will simulate generation of the temperature for each device. To deploy it, execute:

make deploy-devices-data-simulator

Then, call the Devices API using GET /devices method, and you should see your devices with IN_USE status, and a response similar to this:

[
  {
    "id":"cc831450-4ec9-45ec-a72a-ce4f96e2d477",
    "name":"device-1",
    "value":25.14771,
    "status":"IN_USE"
  },
  {
    "id":"1a569548-11e8-4245-bde8-e3774ff1aa42",
    "name":"device-2",
    "value":26.55738,
    "status":"IN_USE"
  }
]

Step-by-step setup

• Create infrastructure and connect to the AKS cluster.

• Build and push devices-api image. Note: specify your project name (the same as for the infrastructure creation) with all lowercase letters.

  cd sample-application/devices-api
  docker build -t acr<project-name>.azurecr.io/devices-api:latest .
  az acr login --name acr<project-name>
  docker push acr<project-name>.azurecr.io/devices-api:latest

• Modify secret-store.yml file replacing:

  • ${project-name} with your project name
  • ${clusterKeyVaultSecretProviderClientId} with a value the cluster client id that can be retrieved with az deployment group show -g "$ENV_RESOURCE_GROUP_NAME" -n k8s_deployment --query properties.outputs.clusterKeyVaultSecretProviderClientId.value -o tsv
  • ${keyVaultTenantId} with key vault tenant id that can be retrieved with az deployment group show -g "$ENV_RESOURCE_GROUP_NAME" -n key_vault_deployment --query properties.outputs.kvTenantId.value -o tsv

• Deploy secret-store

  kubectl apply -f k8s-files/secret-store.yaml

• Modify deployment file and specify your project name in the image.

• Deploy devices-api

  kubectl apply -f k8s-files/devices-api-deployment.yaml

• Build and push devices-state-manager image.

  cd sample-application/devices-state-manager/DevicesStateManager
  docker build -t acr<project-name>.azurecr.io/devices-state-manager:latest .
  docker push acr<project-name>.azurecr.io/devices-state-manager:latest

• Modify the deployment file and specify your project name in the image.

• Deploy devices-state-manager

  From the root folder, run:

  kubectl apply -f k8s-files/devices-state-manager-deployment.yaml

• Modify the Azure Monitor instrumentation key (INSTRUMENTATION_KEY_PLACEHOLDER) in the collector-config.yaml file.

• Deploy the OpenTelemetry collector

  kubectl apply -f k8s-files/collector-config.yaml
  kubectl apply -f k8s-files/otel-collector-deployment.yaml

• To test the Devices API:

  • find the name of the pod:

    kubectl get pods -l app=devices-api

  • use it in the following command

    kubectl port-forward <pod-name> 8080:8080

  • Open your browser or use curl http://localhost:8080/devices. You should receive [].

  • Navigate to http://localhost:8080/ and create a couple of devices using the Devices API POST method.

• To simulate the temperature data for each of the created device, deploy the Devices Data Simulator

  • Replace DEVICE_NAMES_PLACEHOLDER with comma separated device names, that you previously created.

  • Deploy the simulator

    kubectl apply -f k8s-files/devices-data-simulator-deployment.yaml