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_idandregistration_tokenunique to your deployment - The
bootstrap-helmfolder:install.shand thesystem-manager-dependencieschart 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.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 valuesinstall.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:- Navigate to “Elastic Kubernetes Service” on the AWS console
- Go to the required cluster
- Go to Access
- Under IAM access entries click Create Access Entry
- Select your current AWS IAM role from the dropdown, leave the Type as Standard
- Add the
AmazonEKSAdminPolicyandAmazonEKSClusterAdminPolicyto the Cluster scope - Click create
Allowlist your IP (if needed)
- Navigate to “Elastic Kubernetes Service” on the AWS console
- Go to the required cluster
- Go to Networking
- On the right, click Manage and click Endpoint Access
- Under Advanced settings add your IP address
Install the prerequisites with install.sh
Run theinstall.sh script to install what System Manager needs in the cluster:
- The Secrets Store CSI driver and its AWS provider
- The
sgp-system-managerandspicedbnamespaces - The
spicedb-configsecret, 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.
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 withsgpctl, 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.
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
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
scale-egp-<workspace_id>/identity-service-oidc-secrets (either via System Manager or directly in AWS Secrets Manager) with the following JSON:
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 athttps://<workspace_id>.workspace.egp.scale.com (or your custom domain) and authenticate via the configured identity provider.