Skip to content

Commit

Permalink
HPCC-30295 Code review 1
Browse files Browse the repository at this point in the history
- Adds agent configmap header comment
- Fixes datacollection streams v2 value
- Removes disableJoins from V2 values
- Adds directory content description to README
- Fixes minor format issues in README

Signed-off-by: Rodrigo Pastrana <[email protected]>
  • Loading branch information
rpastrana committed Oct 2, 2023
1 parent 2664af5 commit ccec89e
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
14 changes: 12 additions & 2 deletions helm/examples/azure/log-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Depending on your Azure subscription structure, it might be necessary to request

The Registered Application must provide a 'client secret' which is used to gain access to the Log Analytics API.

#### b - Provide AAD registered application inforation and target ALA Workspace
#### b - Provide AAD registered application information and target ALA Workspace
HPCC logAccess requires access to the AAD Tenant ID, client ID, and secret which are provided by the registered app from section '2.a' above. The target workspace ID is also required, and can be retrieved after the step in section '1.b' is successfully completed. Those four values must be provided via a secure secret object.

The secret is expected to be in the 'esp' category, and be named 'azure-logaccess'.
Expand All @@ -72,9 +72,19 @@ Example manual secret creation command (assuming ./secrets-templates contains a
```

#### c - Configure HPCC logAccess
The target HPCC deployment should be directed to use the above Azure Log Analytics workspace, and the newly created secret by providing appropriate logAccess values (such as ./loganalytics-hpcc-logaccess.yaml or ./loganalytics-hpcc-logaccessV2.yaml if targeting Azure Log Analytics ContainerLogV2 (recommended)).
The target HPCC deployment should be directed to use the above Azure Log Analytics workspace, and the newly created secret by providing appropriate logAccess values (such as ./loganalytics-hpcc-logaccess.yaml or ./loganalytics-hpcc-logaccessV2.yaml if targeting Azure Log Analytics ContainerLogV2 - recommended ).

Example use:
```console
helm install myhpcc hpcc/hpcc -f HPCC-Platform/helm/examples/azure/log-analytics/loganalytics-hpcc-logaccessV2.yaml
```
## Directory Contents

- 'create-azure-logaccess-secret.sh' - Script for creating 'azure-logaccess' secret needed for accessing logs stored in Azure Log Analytics
- 'secrets-templates' - Contains placeholders for information required to create 'azure-logaccess' secret via 'create-azure-logaccess-secret.sh' script
- 'enable-loganalytics.sh' - Script for enabling Azure LogAnalytics upon a given AKS cluster
- 'env-loganalytics' - Environment information required to enable ALA upon target AKS cluster.
- 'dataCollectionSettings.json' - Provided to enable ContainerLogV2 schema on target AKS cluster
- 'container-azm-ms-agentconfig.yaml' - Defines ConfigMap used to configure ALA log collection. Provided to re-direct ALA log collection to ContainerLogV2 schema.
- 'loganalytics-hpcc-logaccess.yaml' - Used to configure ALA -> HPCC LogAccess. Provides mapping between ALA log tables to HPCC's known log categories
- 'loganalytics-hpcc-logaccessV2.yaml' - Used to configure ALA -> HPCC LogAccess. Provides mapping between ALA ContainerLogV2 log table to HPCC's known log categories
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Azure Log Analytics collects stdout, stderr, and environmental variables from container
# workloads deployed to managed Kubernetes clusters from the containerized agent.
# Users can customize agent data collection settings by creating a custom Kubernetes ConfigMap
# This ConfiMap can be used to enable/disable log collection, exclude namespaces, and enable/disable
# It is included here specifically to enable Azure Log Analytics ContainerLogV2 schema
# See this document for details:
# https://learn.microsoft.com/en-us/azure/azure-monitor/containers/container-insights-agent-config#configure-and-deploy-configmaps

kind: ConfigMap
apiVersion: v1
data:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"namespaceFilteringMode": "Include",
"namespaces": ["kube-system"],
"enableContainerLogV2": true,
"streams": ["Microsoft-Perf", "Microsoft-ContainerLogV1"]
"streams": ["Microsoft-Perf", "Microsoft-ContainerLogV2"]
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ global:
keyColumn: "ContainerName"
columnMode: "DEFAULT"
columnType: "string"
disableJoins: true
- type: "audience"
searchColumn: "hpcc_log_audience"
enumValues:
Expand Down

0 comments on commit ccec89e

Please sign in to comment.