Skip to main content

Overview

This guide covers deploying SGP in an AWS account. SGP AWS infrastructure is defined by terraform modules managed by Scale.
SGP is deployed jointly with Scale engineering. Scale provides everything under “The following from Scale” in Prerequisites and stays involved for upgrades and ongoing operation. Contact your Scale team before you start.

Prerequisites

  • Access to an AWS account with sufficient permissions to create resources
  • The following tools installed:
  • The following from Scale:
    • The SGP AWS Infrastructure Terraform modules
    • A workspace_id and registration_token unique to your deployment
    • The bootstrap-helm folder: install.sh and the system-manager-dependencies chart it installs
    • The consolidated version of SGP to install
  • A new application configured in your identity provider to authenticate to the SGP platform (SAML or OIDC) (optional)
  • A custom domain for your deployment (optional)

Installation

Step 1: Prepare Terraform Root Module

In a new directory, create a .tf file to invoke the SGP AWS infrastructure Terraform modules. Reference the egp-hybrid-cloud-customer-deployment module as the entrypoint for the SGP infrastructure.

Step 2: Provision Infrastructure via Terraform

Run the following commands in the same directory as the previous step’s .tf file.
This step may take significant time due to resource creation dependencies
If a pre-created certificate and domain entry are not provided, you will likely encounter the following error:
Resolve this by properly configuring DNS and TLS for your domain before re-running terraform apply.

Step 3: Bootstrap the Cluster

Export the values install.sh and sgpctl need. Run these in the same directory as the Step 1 .tf file, so terraform output reads its state:

Configure EKS access

Configure access for yourself to the provisioned EKS cluster:
  1. Navigate to “Elastic Kubernetes Service” on the AWS console
  2. Go to the required cluster
  3. Go to Access
  4. Under IAM access entries click Create Access Entry
  5. Select your current AWS IAM role from the dropdown, leave the Type as Standard
  6. Add the AmazonEKSAdminPolicy and AmazonEKSClusterAdminPolicy to the Cluster scope
  7. Click create

Allowlist your IP (if needed)

  1. Navigate to “Elastic Kubernetes Service” on the AWS console
  2. Go to the required cluster
  3. Go to Networking
  4. On the right, click Manage and click Endpoint Access
  5. Under Advanced settings add your IP address

Install the prerequisites with install.sh

Run the install.sh script to install what System Manager needs in the cluster:
  • The Secrets Store CSI driver and its AWS provider
  • The sgp-system-manager and spicedb namespaces
  • The spicedb-config secret, holding the connection string you exported and the preshared key from the SpiceDB secret Terraform created in AWS Secrets Manager
install.sh reads that secret with your AWS credentials. It does not install System Manager. Run it from the bootstrap-helm folder, because it installs the system-manager-dependencies chart from there.
If install.sh fails, fix the cause and run it again: the exports are still set. To run it again after it has succeeded, or from a new shell, first repeat the exports above from the Step 1 directory.

Install System Manager with sgpctl

Install SGP System Manager with sgpctl, using the consolidated version from Scale. sgpctl installs the chart from the scale-egp-charts Helm repository, so add it first. It also fetches a license key and registry credentials from Scale’s control plane, so the machine running it needs HTTPS access to https://control.egp.scale.com. <aws_account_id> is the AWS account Terraform deployed into.
System Manager is the deployment orchestrator for the SGP platform. It will automatically begin deploying the other services required for the SGP platform within the cluster.

Step 4: Verify the Deployment

Wait for all services to be ready:

Step 5: Configure Identity Provider

SAML Configuration

In your Identity Provider, configure a new SAML application with the following settings:
  • Service Entity ID: https://auth.<domain>
  • Redirect URI: https://auth.<domain>/dashboard/org/saml/callback
Modify the configuration scale-egp-<workspace_id>/identity-service-saml-secrets (either via System Manager or directly in AWS Secrets Manager):

OIDC Configuration

In your Identity Provider, configure a new OIDC application with the following settings:
  • Redirect URI: https://auth.<domain>/dashboard/org/oidc/callback
Modify the configuration scale-egp-<workspace_id>/identity-service-oidc-secrets (either via System Manager or directly in AWS Secrets Manager) with the following JSON:
After modifying the secret, restart the sgp-system-manager deployment to apply the changes.

Accessing the Platform

If all goes smoothly, you should be able to navigate to the SGP platform at https://<workspace_id>.workspace.egp.scale.com (or your custom domain) and authenticate via the configured identity provider.