Skip to content

docs: fix the usage of logs agent module #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2025
Merged

docs: fix the usage of logs agent module #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cbc798
docs: fid the usage of logs agent module
ocofaigh May 15, 2025
ba3bacb
Update README.md
ocofaigh May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Terraform IBM Logs agent module

[![Graduated (Supported)](https://img.shields.io/badge/Status-Graduated%20(Supported)-brightgreen)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
Expand Down Expand Up @@ -31,17 +30,15 @@ This module deploys the following logs agent to an IBM Cloud Red Hat OpenShift C
# ############################################################################

data "ibm_container_cluster_config" "cluster_config" {
# update this value with the Id of the cluster where the agent will be provisioned
cluster_name_id = "cluster_id"
cluster_name_id = "xxxxxxxxx" # replace with cluster ID or name
}

# ############################################################################
# Config providers
# ############################################################################

provider "ibm" {
# update this value with your IBM Cloud API key value
ibmcloud_api_key = "api key value" # pragma: allowlist secret
ibmcloud_api_key = "xxxxxxxxxxxx" # pragma: allowlist secret
}

provider "helm" {
Expand All @@ -50,22 +47,32 @@ provider "helm" {
token = data.ibm_container_cluster_config.cluster_config.token
cluster_ca_certificate = data.ibm_container_cluster_config.cluster_config.ca_certificate
}
# IBM Cloud credentials are required to authenticate to the helm repo
registry {
url = "oci://icr.io/ibm/observe/logs-agent-helm"
username = "iamapikey"
password = "xxxxxxxxxxxx" # pragma: allowlist secret
}
}

provider "kubernetes" {
host = data.ibm_container_cluster_config.cluster_config.host
token = data.ibm_container_cluster_config.cluster_config.token
cluster_ca_certificate = data.ibm_container_cluster_config.cluster_config.ca_certificate
}

# ############################################################################
# Install Logs Agent
# ############################################################################

module "logs_agent_module" {
source = "terraform-ibm-modules/logs-agent/ibm"
# update this with your cluster id where the agent will be installed
cluster_id = "cluster id"
# update this with the Id of your IBM Cloud resource group
cluster_resource_group_id = "resource group id"
# Logs Agent variables
logs_agent_trusted_profile_id = "XXXXXXXX"
cloud_logs_ingress_endpoint = "<cloud-logs-instance-guid>.ingress.us-south.logs.cloud.ibm.com"
cloud_logs_ingress_port = 443
source = "terraform-ibm-modules/logs-agent/ibm"
version = "X.Y.Z" # replace with actual version of module to consume
cluster_id = "xxxxxxx" # replace with ID of the cluster
cluster_resource_group_id = "xxxxxxx" # replace with ID of the cluster resource group
logs_agent_trusted_profile_id = "XXXXXXXX" # replace with ID of the trusted profile to use for authentication
cloud_logs_ingress_endpoint = "<cloud-logs-instance-guid>.ingress.us-south.logs.cloud.ibm.com"
cloud_logs_ingress_port = 443
}
```

Expand Down