Exploring an updated Terraform template to handle the addition of Activity Tracker and Log Analysis.
Earlier this year, the IBM Cloud Observability team announced IAM-based access controls for IBM Cloud Activity Tracker and IBM Cloud Log Analysis in the “Increased IAM Control of Log Analysis and Activity Tracker Services in IBM Cloud” post. It follows a similar capability in IBM Cloud Monitoring for which I wrote an Infrastructure-as-Code Terraform template discussed in the “Terraform Template for Monitoring with Sysdig Teams” post.
That post explored the scenario in which two separate development teams shared the same Monitoring instance and the same IBM Cloud Kubernetes Service and demonstrated how a team can automate the process of deploying and configuring such an environment.
I recently updated the Terraform template to handle the addition of Activity Tracker and Log Analysis, as depicted below:
As a reminder for this scenario, two development teams are working on a complex application that will eventually be deployed on the same Kubernetes cluster. To provide a more elaborate example, let's assume that each team has selected their preferred programming language — in this case, Go and Node.js. Once their applications are ready — or as they go through various iterations of it — they create a container image and publish it to a private container registry in the IBM Cloud.
An infrastructure team is responsible for deploying the environment (i.e., Kubernetes cluster), monitoring, log analysis, activity tracking and configuring the access levels to these services and associated dashboards. They choose to use Terraform, an Infrastructure-as-Code tool used on previous projects. We create all resources and applications in an IBM Cloud region. We use Identity and Access Management to assign access to the Activity Tracker, Log Analysis, and Monitoring instances.
Deploying and configuring the components
This repository contains all the infrastructure configuration instructions to create and configure the resources as depicted above. Here is a high-level overview of the code repository structure:
- The main.tf contains the instructions for setting up the Terraform provisions used for this template.
- The instance_config.tf contains the instructions for creating and configuring the Log Analysis and Monitoring instances. It will also create the teams and assign the filtering to limit access to metrics, logs and activities based on the container tags. This file also contains the instructions to configure the logging and monitoring agents on the Kubernetes cluster leveraging a new resource in the IBM provider for Terraform ibm_ob_logging and ibm_ob_monitoring.
- The app_install.tf contains the instructions to deploy the applications from the container registry to the Kubernetes cluster.
- The variables.tf contain all of the input required by the Terraform template. Don't modify this file, as the number of values that you need to modify is more limited. Use the config.tfvars to supply your values as described in the repository.
- The scripts folder contains the various shell scripts that are invoked during the run of the Terraform template. As of this writing, the LogDNA provider for Terraform does not provide resources to create teams in Log Analysis or Activity Tracker, therefore the scripts are used to create the team leveraging the LogDNA REST APIs. A change is coming soon to add support for this capability in the provider and will be reflected in the repository once it becomes available.
After deploying the environment in the Activity Tracker, Monitoring and Log Analysis instances, the Infrastructure Engineer has a complete view of all metrics from the Kubernetes cluster.
To get started, try our sample code on GitHub. Instructions are provided in the README.md to create and use this template. Start by identifying an existing Kubernetes cluster to use or create a new one via the IBM Cloud UI or CLI and then apply the template to create the services and the IAM policies. We also cover how to clean up resources when you no longer need them.
Questions and feedback
The GitHub repository for this scenario has an Issues tab where you can comment on the content and code. If you have suggestions or issues, please submit your feedback.