Creating a tenant and a target destination

Creating a tenant and target through the UI

When the IBM Cloud Logs Routing console is first displayed, any existing target information is displayed.

If no target is configured for a region, the region displays the Set target option. When the target is set for the first time, an IBM Cloud Logs Routing tenant is created (onboarded) and the target configured.

To create a tenant and a target for a region, complete the following steps:

1. Log in to your IBM Cloud account.

2. Click the Menu icon > Observability.

3. Click Logging > Routing.

4. Click Set target.

5. Select an IBM Cloud Logs instance or an IBM Log Analysis instance. This is the instance where you want to receive logs that are routed by IBM Cloud Logs Routing.

   You can select an IBM Log Analysis instance by selecting an instance from the list and an ingestion key. Only IBM Log Analysis instances in your account can be selected by name and ingestion key. If you want to route to an IBM Log Analysis instance in another account, you must select the target by CRN (Cloud Resource Name) and ingestion key. The CRN of an IBM Log Analysis instance can be found by the account administrator of the IBM Log Analysis instance by clicking > Resource list and clicking the IBM Log Analysis instance. The CRN can be copied from the Details section.

   You can select a IBM Cloud Logs instance from the list. Before you do, check that you have a service to service authorization defined between the IBM Cloud Logs Routing service and the IBM Cloud Logs instance. For more information, see Creating a S2S authorization to grant access to send logs to IBM Cloud Logs.

6. Click Save.

When you set a target in the UI, you create a tenant in that region. The name of the tenant is set as region-ID where region is set to the region where you are located when you create the target.

Creating a tenant and target by using the API

Run the following command to create a tenant for the IBM Cloud Logs Routing service by using the private endpoint:

curl -X POST  https://management.private.${REGION}.logs-router.cloud.ibm.com/v1/tenants \
-H "Content-Type: application/json" \
-H "Authorization: ${IAM_TOKEN}" \
-H "IBM-API-Version: API_VERSION_DATE" \
--data '{TARGET_DATA}'

Run the following command to create a tenant for the IBM Cloud Logs Routing service by using the public endpoint:

curl -X POST  https://management.${REGION}.logs-router.cloud.ibm.com/v1/tenants \
--H "Content-Type: application/json" \
-H "Authorization: ${IAM_TOKEN}" \
-H "IBM-API-Version: API_VERSION_DATE" \
--data '{TARGET_DATA}'

Where

• REGION defines the location where the tenant is configured.
• IAM_TOKEN defines the credentials that you use to authenticate your requests.
• API_VERSION_DATE defines the date of the API version that you want to use to query your tenant definition. The format must be as follows: YYYY-MM-DD
• TARGET_DATA defines the information about the target destination.

{
    "name": "TENANT_NAME",
    "targets": [
        {
            "log_sink_crn": "CLOUD_LOGS_INSTANCE_CRN",
            "name": "TARGET_NAME",
            "parameters": {
                "host": "CLOUD_LOGS_INSTANCE_INGRESS_ENDPOINT",
                "port": CLOUD_LOGS_INSTANCE_TARGET_PORT
            }
        }
    ]
}

{
    "name": "tenant",
    "targets": [
        {
            "log_sink_crn": "LOG_ANALYSIS_INSTANCE_CRN",
            "name": "TARGET_NAME",
            "parameters": {
                "host": "LOG_ANALYSIS_INGESTION_ENDPOINT",
                "port": `LOG_ANALYSIS_INSTANCE_TARGET_PORT`,
                "access_credential": "INGESTION_KEY_TO SEND_DATA_TO_INSTANCE"
            }
        }
    ]
}

Creating a tenant and target by using Terraform

provider "ibm" {
  ibmcloud_api_key = "IBMCLOUD_API_KEY"
  region = "some-region"
}

resource "ibm_logs_router_tenant" "logs_router_tenant_instance_1" {
	name = "TENANT_NAME"
  region = "TENANT_REGION"
	targets {
	  log_sink_crn = "CLOUD_LOGS_INSTANCE_CRN"
	  name = "TARGET_NAME"
	  parameters {
		host = "CLOUD_LOGS_INSTANCE_INGRESS_ENDPOINT"
		port = CLOUD_LOGS_INSTANCE_TARGET_PORT
	  }
	}
  }

provider "ibm" {
  ibmcloud_api_key = "IBMCLOUD_API_KEY"
  region = "some-region"
}

resource "ibm_logs_router_tenant" "logs_router_tenant_instance_1" {
	name = "TENANT_NAME"
  region = "TENANT_REGION"
	targets {
	  log_sink_crn = "LOG_ANALYSIS_INSTANCE_CRN"
	  name = "TARGET_NAME"
	  parameters {
		host: "LOG_ANALYSIS_INGESTION_ENDPOINT",
    port: "LOG_ANALYSIS_INSTANCE_TARGET_PORT",
    access_credential: "INGESTION_KEY_TO SEND_DATA_TO_INSTANCE"
	  }
	}
  }