Step 7 - Install CDR components

Finally, install Glasswall Halo application services. For these charts, ensure you set the image tag to the corresponding tag found in the Release Notes.

The examples below are pre-populated with the tags for v2.4.13.

7.1 - Engine

helm upgrade --install cdrplatform-engine cdrplatform-engine \
  --set image.tag=105787 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-engine \
  --set cloud_provider=aws

7.2 - Sync API

helm upgrade --install cdrplatform-sync-api cdrplatform-sync-api \
  --set image.tag=105593 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-sync-api \
  --set cloud_provider=aws

7.3 - API Access Service

The API Access service acts as a gateway service to access Glasswall Halo's Synchronous API and Policy API.

It exposes the CDR functionality via HTTP - in your environment you may require this to be done with TLS/SSL via HTTPS, if this is the case follow the instructions to install with TLS/SSL. Otherwise follow the instructions to install without.

7.3A - For deployments without TLS/SSL

helm upgrade --install cdrplatform-api-access -n cdrplatform cdrplatform-api-access \
 --set image.repository=glasswallhub.azurecr.io/cdrplatform-api-access \
 --set image.tag=105700 \
 --atomic

7.3B - To use SSL certificates on CDR API, create a private key and certificate for the domain to be used.

Create a Kubernetes secret using the key and crt files using the command below. With this command we create a secret with the name "tls-secret" from the files server.key (private key) and server.crt (certificate). The key should not be passphrase protected in this example.

kubectl create secret tls tls-secret --key server.key --cert server.crt

This secret can then be used to enable TLS on the ingress ensuring that the domain name is set on the command below:

helm upgrade --install cdrplatform-api-access -n cdrplatform cdrplatform-api-access \
 --set image.repository=glasswallhub.azurecr.io/cdrplatform-api-access \
 --set image.tag=105700 \
 --set cloud_provider=aws \
 --set ingress.tls.enabled=true \
 --set ingress.tls.domain=<domain name> \
 --set ingress.tls.secretName=tls-secret \
 --atomic

7.3C - To enable API Authentication

The Authentication in the CDR Platform API is disabled by default. If authentication needs to be enabled:

• Create secrets in AWS Secrets manager, one for the organisation ID and another for Orgnization tokens. When passing multiple tokens seperate them by comma(","), hence make sure the token itself cannot have a comma(",").
• The secrets in AWS Secrets manager should follow below naming convention
  • The secret for Organisation ID should start with 'organisation' and end with '-id' with a number in between. For example 'organisation0-id', 'organisation1-id', 'organisation2-id' etc.
  • The secret for organisation tokens should start with 'organisation' and end with '-tokens' with a number in between. For example 'organisation0-tokens', 'organisation2-tokens', 'organisation3-tokens' etc.
• Set configuration.AuthenticationScheme=Basic while deploying the helm chart. For example:

helm upgrade --install cdrplatform-api-access -n cdrplatform cdrplatform-api-access \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-api-access \
  --set image.tag=105700 \
  --set configuration.AuthenticationScheme=Basic \
  --atomic 

To enable API key based authentication in Menlo, set configuration.MenloAuthenticationScheme=ApiKey. Make sure menlo-api-key secret has been added to the Vault in Step 3.

helm upgrade --install cdrplatform-api-access  cdrplatform-api-access \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-api-access \
  --set image.tag=105700 \
  --set configuration.AuthenticationScheme=Basic \
  --set configuration.MenloAuthenticationScheme=ApiKey \
  --atomic

7.4 - MongoDB

Note: if you have previously configured and setup MongoDB within AWS and if you do not wish to manage and install MongoDB within your cluster, you can skip this step, and proceed to installing Portal Access below.

MongoDB Operator

helm install community-operator mongodb/community-operator --namespace cdrplatform \
  --set operator.version=0.9.0 \
  --set agent.version=107.0.0.8465-1 \
  --atomic

MongoDB

helm upgrade -i cdrplatform-mongodb cdrplatform-mongodb -n cdrplatform --atomic \
  --set cloud_provider=aws

After the MongoDB is deployed, get the connection string of the MongoDB and add it to the AWS Secrets manager.

• Retrieve the connection string from the Kubernetes secret:

kubectl get secret mongodb-cdrplatform-cdrp-user -o jsonpath='{.data.connectionString\.standard}' | base64 -d

• Create a new secret in the AWS Secrets Manager with the MongoDB connectrion string:

aws secretsmanager create-secret --name "mongodb-connectionstring" --secret-string "<output-from-previous-step>" --region "${region}"

7.5 - Portal

To deploy Portal service, run below commands.

7.5A - For deployments without TLS/SSL

Note that the <IP-address> mentioned in this command refers to the Load Balancer's public IP address. This can be retrieved through the "Portal & API Access" steps below.

helm upgrade --install cdrplatform-portal cdrplatform-portal \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-portal \
  --set configuration.OIDC=null \
  --set image.tag=105714 \
  --set configuration.BackendUrl=http://<IP-address> \
  --set configuration.HaloVersion=2.4.13 \
  --atomic

7.5B - For deployments with TLS/SSL

If TLS needs to be enabled, add the --set ingress.tls.enable_tls=true and --set ingress.tls.domain=<domain name> parameters - in the below example, it will use the same Kubernetes secret that was created for the API Access to retrieve the certificates.

helm upgrade --install cdrplatform-portal cdrplatform-portal \
  --set image.tag=105714 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-portal \
  --set ingress.tls.enabled=true \
  --set ingress.tls.domain=<domain name> \
  --set ingress.tls.secretName=tls-secret \
  --set configuration.BackendUrl=https://<domain name> \
  --set configuration.OIDC=null \
  --set configuration.HaloVersion=2.4.13 \
  --atomic

7.5C - To configure Clean Room to authenticate APIs

If API authentication is enabled, replace <organisation1-id> and <organisation1-tokens> with the appropriate secret names created in the AWS Secrets manager.

helm upgrade --install cdrplatform-portal cdrplatform-portal \
  --set image.tag=73257 --set image.repository=glasswallhub.azurecr.io/cdrplatform-portal \
  --set configuration.EnableAuth=true \
  --set AuthSecrets.orgKey=<organisation1-id> \
  --set AuthSecrets.orgTokenKey=<organisation1-tokens> \
  --atomic

7.6 - Policy API

The Policy API is used to manage policies for Glasswall Halo's content management flags. This is an optional service; install it if you would like to create and use custom polices.

helm upgrade --install cdrplatform-policy-api  cdrplatform-policy-api \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-policy-api \
  --set image.tag=105708 --set cloud_provider=aws \
  --atomic

The Policy API swagger page can be accessed using:

http://<ip>/swagger/index.html

7.7 - Portal Access

Portal Access acts a backend for Portal. It enables Portal to access Policy API and Sync API.

7.7A - For deployments with TLS/SSL

If TLS needs to be enabled, add the --set ingress.tls.enable_tls=true and --set ingress.tls.domain=<domain name> parameters - in the below example, it will use the same Kubernetes secret that was created for the API Access to retrieve the certificates.

helm upgrade --install cdrplatform-portal-access cdrplatform-portal-access \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-portal-access \
  --set image.tag=105746 \
  --set ingress.tls.enabled=true \
  --set ingress.tls.domain=<domain-name> \
  --set ingress.tls.secretName=tls-secret \
  --set configuration.AuthenticationScheme=None \
  --atomic

7.7B - For deployments without TLS/SSL 

helm upgrade --install cdrplatform-portal-access cdrplatform-portal-access \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-portal-access \
  --set configuration.AuthenticationScheme=None \
  --set image.tag=105746 \
  --atomic

7.8 - License Management

The License Management service is used to manage licenses in Glasswall Halo.

helm upgrade --install cdrplatform-license-management cdrplatform-license-management -n license-management \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-license-management \
  --set image.tag=105717 \
  --set cloud_provider=aws \
  --atomic

7.9 - Clean up Service

Clean up service deletes the original and rebuilt files from the persistent storage after the files are processed.

helm upgrade --install cdrplatform-cleanup cdrplatform-cleanup \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-cleanup \
  --set cloud_provider=aws \
  --set image.tag=105715 \
  --atomic

7.10 - Async API

The Asynchronous API can be deployed using the command below. A MongoDB database is a pre-requisite for  the Async API.

helm upgrade --install cdrplatform-async-api cdrplatform-async-api \
  --set image.tag=105722 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-async-api \
  --atomic

7.11 - Metrics Collation

Create collection and enable Change Streams

MongoDB (AWS Document DB) doesn't enable Change Streams for collections by default. Please refer to AWS Documentation for more details.

To enable Change Streams, run:

mongosh <mongodb-connection-string>
use cdrplatform
db.createCollection('CDRMetricsCollection')
db.adminCommand({
    modifyChangeStreams: 1,
    database: "cdrplatform",
    collection: "CDRMetricsCollection", 
    enable: true
});

The Metrics Collation service captures events from Glasswall Halo and stores them in MongoDB.

helm upgrade --install cdrplatform-metrics-collation cdrplatform-metrics-collation \
  --set image.tag=105616 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-metrics-collation \
  --set cloud_provider=aws \
  --atomic

7.12 - Metrics Projection

The Metrics Projection service is used to pull reporting data from MongoDB to display in the Portal UI.

helm upgrade --install cdrplatform-metrics-projection cdrplatform-metrics-projection \
  --set image.tag=105815 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-metrics-projection \
  --set cloud_provider=aws \
  --atomic

7.13 - Report Extractor

The Report Extractor service extracts analysis reports and publishes them for reporting.

helm upgrade --install cdrplatform-report-extractor cdrplatform-report-extractor \
  --set image.tag=105747 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-report-extractor \
  --atomic

7.14 - Tally Accumulator

The Tally accumulator service tracks and maintains a tally of usage statistics.

helm upgrade --install cdrplatform-tally-accumulator cdrplatform-tally-accumulator \
  --set image.tag=105699 \
  --set image.repository=glasswallhub.azurecr.io/cdrplatform-tally-accumulator
  --set cloud_provider=aws \
  --atomic

7.15 - Portal & API Access

Use the command below to determine the External-IP associated with your cluster: 

Note: External-IP will be the same as the Public IP address attached to the AWS load balancer.

kubectl get services --namespace cdrplatform nginx-ingress-ingress-nginx-controller --output jsonpath='{.status.loadBalancer.ingress[0].hostname}'

• You can now use the returned IP above to navigate to the Portal and API Documentation.
  • Note: use HTTPS if TLS is enabled.

Portal: http://<ip>
API Documentation: http://<ip>/swagger

Need help?

Congratulations, you have successfully deployed Glasswall Halo! We would love to get your thoughts on the setup process and how we can improve it, using the feedback option below.