Prerequisites for AWS deployments

Before you deploy NBS 7, confirm that your Amazon Web Services (AWS) environment meets the requirements in each of the following areas.

Start with the cloud-agnostic Prerequisites for NBS 7 deployment, then complete the AWS-specific requirements on this page.

On this page

  1. AWS environment requirements
  2. Hardware requirements
  3. Software requirements
  4. Management machine setup
  5. Network and database access requirements
  6. Security requirements
  7. Next steps

AWS environment requirements

Your AWS environment must meet the following requirements:

  • An existing AWS account with an instance of NBS 6 listed on the Supported NBS versions page and related third-party products
  • A configured DNS routing infrastructure
  • Permissions to create security groups and AWS IAM roles
  • Access to NBS 6 databases hosted on a SQL Server instance. Two common hosting options with AWS include Amazon RDS and self-managed Amazon EC2. See AWS services reference for details.
  • Access to an Amazon S3 bucket to store Terraform state

Hardware requirements

Higher-volume STLTs

These specifications are suggested for jurisdictions with more than 10 million person records. The following table lists the recommended hardware for higher-volume deployments.

Type Resource Size
Container runtime environment Amazon EKS 4 Nodes - Linux (4 cores/32 GB RAM, 100GB block storage) m5.large
Relational Database SQL Server 2017+ Standard or Enterprise (hosted on Amazon RDS or a self-managed Amazon EC2 instance)  
Persistent Store Amazon EFS 1 TB

Lower-volume STLTs

These specifications are suggested for jurisdictions with fewer than 10 million person records. The following table lists the recommended hardware for lower-volume deployments.

Type Resource Size
Container runtime environment Amazon EKS 4 Nodes - Linux (4 cores/32 GB RAM, 100GB block storage) m5.large
Relational Database SQL Server 2017+ Standard or Enterprise (hosted on Amazon RDS or a self-managed Amazon EC2 instance)  
Persistent Store Amazon EFS 500 GB

Software requirements

The following table lists the software versions required for NBS 7 deployments on AWS. Versions marked as deployed by default are provisioned automatically during the deployment process.

Software Version Comments
Kubernetes 1.25+ Deployed as Amazon EKS by default
Cert Manager 1.13 Deployed in Kubernetes
Elasticsearch 9.x Deployed by default in Kubernetes
Apache NiFi 1.19 Deployed in Kubernetes
Traefik 3.x Deployed in Kubernetes as ingress controller
Prometheus 2.44 Deployed as Amazon Managed Service for Prometheus (AMP) by default
Grafana 12.x Deployed as Amazon Managed Grafana (AMG) by default
Fluent Bit 1.9.x Deployed in Kubernetes. Log storage can be configured.
NBS Classic 6.0.18.1 or higher Reuse current NBS instance
SQL Server 2017+ Reuse current NBS instance
Kafka 2.8.1 Deployed as Amazon MSK
Keycloak 22.0.5+ Deployed in Kubernetes

Management machine setup

To configure, deploy, and maintain NBS 7, you need a local or cloud-hosted workstation such as AWS CloudShell with the following tools installed:

Network and database access requirements

NBS 7 infrastructure and microservices are deployed into a new Amazon VPC, provisioned using the Terraform scripts in Provision the AWS cloud environment.

Confirm that network access is available from NBS 7 components to classic NBS 6 components, including the database server. Use a private route for this network access rather than a publicly accessible connection.

The team member who creates this infrastructure should have operational knowledge of Terraform.

Security requirements

Encryption management

AWS storage services including Amazon EBS, Amazon EFS, and Amazon RDS use AWS Key Management Service (AWS KMS) for encryption.

End-user authentication

NBS 7 integrates with standards-based SSO systems and is designed to work with your existing Identity Provider (IdP), such as Okta. Because NBS 7 requires a working NBS 6 instance, an authentication mechanism is assumed to be in place. No additional authentication configuration is needed before deployment.

Next steps

After you satisfy the prerequisites on this page, complete the following steps in order:

  1. Confirm that you have completed both the AWS-specific requirements from this page and the cloud-agnostic Prerequisites
  2. Continue with Provision the AWS cloud environment