Skip to content

docs(mpc-party): readme updates #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 2, 2025
Merged

docs(mpc-party): readme updates #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9951a7
docs: update mpc-party readme
deasydoesit Oct 1, 2025
e27a536
docs: pre-pr review
deasydoesit Oct 1, 2025
2e77b4e
docs: pre-pr review
deasydoesit Oct 1, 2025
6af4ea0
docs: address ci errors
deasydoesit Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions examples/mpc-party/terraform.tfvars.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Network Environment Configuration
network_environment = "testnet"
network_environment = "testnet" # or mainnet

# AWS Configuration
aws_region = "eu-west-1"

# MPC Party Configuration
party_id = 1
party_id = 1
party_name = "mpc-party-2"
environment = "dev"

Expand All @@ -27,7 +27,7 @@ kubeconfig_path = "~/.kube/config"
kubeconfig_context = "tailscale-operator-zws-dev.diplodocus-boa.ts.net"

# Tagging
owner = "mpc-team"
owner = "mpc-team"
additional_tags = {
"Project" = "mpc-infrastructure"
"Team" = "security"
Expand Down Expand Up @@ -58,8 +58,9 @@ nodegroup_labels = {
nodegroup_additional_security_group_ids = ["sg-04e41735e6bdc6007"]
nodegroup_enable_nitro_enclaves = true
nodegroup_enable_ssm_managed_instance = true

# Nitro Enclaves Configuration for MPC Party
kms_enabled_nitro_enclaves = true
kms_enabled_nitro_enclaves = true
# This image attestation SHA must be updated for each KMS enclave release image.
kms_image_attestation_sha = "5292569b5945693afcde78e5a0045f4bf8c0a594d174baf1e6bccdf0e6338ebe46e89207054e0c48d0ec6deef80284ac"
kms_deletion_window_in_days = 7
88 changes: 48 additions & 40 deletions modules/mpc-party/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,25 @@ graph TB

## Usage

> **ℹ️ Info**
>
> The `Complete` and `Database-Only` examples provided below are to simply show the full set of variables that can be configured for the `mpc-party` module.
>
> The examples are **not intended for usage as-is** in a deployment context for Zama testnet or mainnet!
>
> Please refer to the [terraform.tfvars.example](../../examples/mpc-party/terraform.tfvars.example) file in `examples/mpc-party` for a closer repesentation of configuration usable in deployment contexts. But as always, ensure conformance with broader infrastructre base layer before deploying.

### Complete Example with All Options

```terraform
module "mpc_party" {
source = "./modules/mpc-party"

# Core Configuration
party_name = "mpc-party-production"
party_name = "mpc-party-production"
vault_private_bucket_name = "prod-mpc-private-${random_id.suffix.hex}"
vault_public_bucket_name = "prod-mpc-public-${random_id.suffix.hex}"
cluster_name = "production-eks-cluster"
cluster_name = "production-eks-cluster"

# Network Environment & Region Validation
network_environment = "mainnet" # or "testnet"
Expand All @@ -88,7 +96,7 @@ module "mpc_party" {
k8s_service_account_name = "mpc-party-sa"
create_namespace = true
create_service_account = true
create_irsa = true
create_irsa = true

# Namespace Customization
namespace_labels = {
Expand All @@ -101,27 +109,27 @@ module "mpc_party" {
}

# ConfigMap Configuration
create_config_map = true
config_map_name = "mpc-party-config"
create_config_map = true
config_map_name = "mpc-party-config"
additional_config_data = {
"LOG_LEVEL" = "info"
"ENVIRONMENT" = "production"
}

# RDS Database Configuration
enable_rds = true
rds_prefix = "zama"
rds_db_name = "mpc_production"
rds_username = "mpc_user"
rds_engine = "postgres"
rds_engine_version = "17.2"
rds_instance_class = "db.t4g.large"
rds_allocated_storage = 100
rds_max_allocated_storage = 500
rds_multi_az = true
rds_backup_retention_period = 14
rds_deletion_protection = false
rds_storage_encrypted = true
enable_rds = true
rds_prefix = "zama"
rds_db_name = "mpc_production"
rds_username = "mpc_user"
rds_engine = "postgres"
rds_engine_version = "17.2"
rds_instance_class = "db.t4g.large"
rds_allocated_storage = 100
rds_max_allocated_storage = 500
rds_multi_az = true
rds_backup_retention_period = 14
rds_deletion_protection = false
rds_storage_encrypted = true
rds_manage_master_user_password = true

# RDS Network Configuration
Expand All @@ -141,23 +149,23 @@ module "mpc_party" {
]

# RDS Kubernetes Integration
rds_create_externalname_service = true
rds_externalname_service_name = "mpc-db-external"
rds_create_externalname_service = true
rds_externalname_service_name = "mpc-db-external"
rds_externalname_service_namespace = "mpc-production"

# Node Group Configuration
create_nodegroup = true
nodegroup_name = "mpc-production-ng"
nodegroup_instance_types = ["m5.4xlarge"]
nodegroup_min_size = 1
nodegroup_max_size = 3
nodegroup_desired_size = 2
nodegroup_disk_size = 100
nodegroup_capacity_type = "ON_DEMAND"
nodegroup_ami_type = "AL2023_x86_64_STANDARD"
create_nodegroup = true
nodegroup_name = "mpc-production-ng"
nodegroup_instance_types = ["m5.4xlarge"]
nodegroup_min_size = 1
nodegroup_max_size = 3
nodegroup_desired_size = 2
nodegroup_disk_size = 100
nodegroup_capacity_type = "ON_DEMAND"
nodegroup_ami_type = "AL2023_x86_64_STANDARD"

# Node Group Security
nodegroup_enable_remote_access = false
nodegroup_enable_remote_access = false
nodegroup_additional_security_group_ids = ["sg-12345678"]

# Node Group Labels and Taints
Expand All @@ -173,8 +181,8 @@ module "mpc_party" {
kms_deletion_window_in_days = 30

# Resource Overrides for Nitro Enclaves
nitro_enclaves_override_cpu_count = 6
nitro_enclaves_override_memory_mib = 12288
nitro_enclaves_override_cpu_count = 6
nitro_enclaves_override_memory_mib = 12288

# Tagging
common_tags = {
Expand All @@ -200,24 +208,24 @@ module "mpc_party" {
source = "./modules/mpc-party"

# Core Configuration
party_name = "mpc-party-db"
party_name = "mpc-party-db"
vault_private_bucket_name = "mpc-private-${random_id.suffix.hex}"
vault_public_bucket_name = "mpc-public-${random_id.suffix.hex}"
cluster_name = "existing-eks-cluster"
cluster_name = "existing-eks-cluster"

# Kubernetes Configuration
k8s_namespace = "mpc-db"
k8s_service_account_name = "mpc-db-sa"
create_namespace = true
create_service_account = true
create_irsa = true
create_irsa = true

# RDS Configuration
enable_rds = true
rds_db_name = "mpc_database"
rds_username = "mpc_admin"
rds_instance_class = "db.t4g.medium"
rds_allocated_storage = 50
enable_rds = true
rds_db_name = "mpc_database"
rds_username = "mpc_admin"
rds_instance_class = "db.t4g.medium"
rds_allocated_storage = 50
rds_manage_master_user_password = true
rds_create_externalname_service = true

Expand Down