Skip to main content
Version: 2.10.0

Prerequisites

Before you begin the process of deploying Glasswall's Halo Platform, check that you have the following tools and resources installed and setup.

Required Tools​

  • Helm > 3.8 (to enable full support for OCI repositories)
  • Kubectl
  • Gooogle Cloud SDK/CLI
  • Install Google Auth Plugin

    • Windows OS:

      • Map .bashrc for the Google Cloud SDK with:
          export PATH="/usr/lib/google-cloud-sdk/bin:$PATH"

    • MAC OS:

      • Map .zprofile for the Google Cloud SDK with:
          export PATH=$PATH:/Users/<user-name>/google-cloud-sdk/bin

Note: Troublshooting methods can be found on the Google Kubernetes Engine Docs site

Required Google Resources​

1. GKE Instance​

  • Recommended total of at least 8 vCPU and 32 GB RAM.
  • Minimum node size is 4 vCPU and 16 GB RAM.
  • For production workloads a minimum of 2 nodes is recommended.
  • In the steps below, the GKE cluster is referred to as: gkename
  • Reccommended GKE Cluster Release Channel and version: Stable Release Channel v1.27.13-gke.1070002
  • Enable the Filestore CSI driver Cluster Feature on your GKE Cluster. - Allows cluster storage to utilze the GKE Filestore CSI driver

Note: Glasswall's Halo platform does not support ARM64 node VMs.

For guidance on creating an GKE cluster please refer to:

2. Enable API Services​

Required Google Cloud APIs that are required (enabled) for setting up and managing a GKE cluster

  • Google Kubernetes Engine API
  • Compute Engine API
  • Cloud Resource Manager API
  • IAM Service Account Credentials API
  • Cloud DNS API
  • Cloud Storage API
  • Cloud Filestore API
  • Identity and Access Management (IAM) API
  • Secret Manager API
  • Service Networking API

3. Cloud Storage Bucket​

  • A Cloud Storage Bucket can be created within the GCP Console
  • A cloud storage bucket is used to store reports for each file processed by the platform. The SKU of the storage account does not impact performance, but we recommend at least GRS configuration.
  • An additional storage bucket is used as Google File Share backing the cluster's Persistent Volume. This is added to the GKE cluster's GCP Project automatically during the deployment.
  • In the steps below, the cloud storage bucket that collects the Halo reports is referred to as: saname

4. MongoDB Database​

  • MongoDB is used to store the Halo Platform content management policies, tally accumulator data, and data for asynchronous file processing and metrics.
  • MonogoDB is deployed directly inside of your cluster. Deployable using the MongoDB Helm Charts, as seen in Step 8.*

Note: The steps below assume each resource is in the same GCP Project referred to as: project_id

5. Access to Glasswall Artifact Registry​

  • You are provided with a Token & Token ID to access Glasswall's Artifact Registry.
  • This allows you to directly pull container images and Helm charts from your GCP Project.
  • In the steps below, the Token and Token ID will be referred to as: token and token_ID.

Assigning Variables​

Variables assigned before you begin​

The variables mentioned in prerequisites above can be assigned before you can begin the Halo Platform installation. You'll need to replace "..." with your own values.

  • Google GCP Project ID: project_ID="..."
  • Google Kubernetes Cluster name: GKEname="..."
  • Google Cloud Storage Bucket name: saname="..."
  • Google Container Registry Token ID: token_ID="..."
  • Google Container Registry Token: token="..."