Skip to content

Commit

Permalink
[create-pull-request] automated change
Browse files Browse the repository at this point in the history
  • Loading branch information
klaus993 authored Sep 26, 2024
1 parent e75d3bb commit 68c49fa
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions infra/terraform/modules/zk_stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.58.0 |
| <a name="requirement_cloudflare"></a> [cloudflare](#requirement\_cloudflare) | ~> 4.0 |
| <a name="requirement_google"></a> [google](#requirement\_google) | 5.35.0 |
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | 2.14.0 |
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | 1.14.0 |
Expand All @@ -14,7 +15,7 @@

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.58.0 |
| <a name="provider_cloudflare"></a> [cloudflare](#provider\_cloudflare) | ~> 4.0 |
| <a name="provider_google"></a> [google](#provider\_google) | 5.35.0 |
| <a name="provider_helm"></a> [helm](#provider\_helm) | 2.14.0 |
| <a name="provider_kubectl"></a> [kubectl](#provider\_kubectl) | 1.14.0 |
Expand All @@ -30,26 +31,34 @@

| Name | Type |
|------|------|
| [aws_route53_record.k8s-en01-grafana-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-en01-rpc-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-explorer-api-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-explorer-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-grafana-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-portal-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [aws_route53_record.k8s-rpc-sepolia](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/route53_record) | resource |
| [cloudflare_record.en01-grafana](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.en01-rpc](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.explorer](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.explorer-api](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.grafana](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.portal](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_record.rpc](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource |
| [cloudflare_ruleset.rpc-rate-limit](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/ruleset) | resource |
| [google_compute_global_address.en-grafana](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.explorer-api](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.explorer-app](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.external-node](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.grafana](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.peering_default_ip_range](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.portal](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_global_address.server](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_global_address) | resource |
| [google_compute_network.gke-cluster-network](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_network) | resource |
| [google_compute_network_peering_routes_config.dbs_peering_routes](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_network_peering_routes_config) | resource |
| [google_compute_subnetwork.gke-cluster-subnetwork](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/compute_subnetwork) | resource |
| [google_kms_crypto_key.k8s-secrets-encryption-key](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/kms_crypto_key) | resource |
| [google_kms_key_ring.k8s-secrets-encryption-keyring](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/kms_key_ring) | resource |
| [google_project_iam_binding.external-secrets-sa-token-creator](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/project_iam_binding) | resource |
| [google_project_iam_binding.external-secrets-secret-accessor](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/project_iam_binding) | resource |
| [google_service_networking_connection.databases](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/service_networking_connection) | resource |
| [google_sql_database_instance.general](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/sql_database_instance) | resource |
| [google_sql_database_instance.prover](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/sql_database_instance) | resource |
| [google_sql_user.general](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/sql_user) | resource |
| [google_sql_user.prover](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/sql_user) | resource |
| [google_storage_bucket.object-store-dev](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/storage_bucket) | resource |
| [google_storage_bucket.prover-object-store-dev](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/storage_bucket) | resource |
| [google_storage_bucket.prover-setup-data](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/resources/storage_bucket) | resource |
Expand All @@ -67,7 +76,7 @@
| [kubectl_manifest.cluster-secret-store-gcp](https://registry.terraform.io/providers/gavinbunney/kubectl/1.14.0/docs/resources/manifest) | resource |
| [kubectl_manifest.http01-issuer](https://registry.terraform.io/providers/gavinbunney/kubectl/1.14.0/docs/resources/manifest) | resource |
| [kubernetes_service_account.buckets-rw](https://registry.terraform.io/providers/hashicorp/kubernetes/2.31.0/docs/resources/service_account) | resource |
| [aws_route53_zone.zk-stack-lambdaclass-com](https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/data-sources/route53_zone) | data source |
| [cloudflare_zone.dns_zone](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/data-sources/zone) | data source |
| [google_client_config.default](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/data-sources/client_config) | data source |
| [google_compute_global_address.en-grafana](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/data-sources/compute_global_address) | data source |
| [google_compute_global_address.explorer-api](https://registry.terraform.io/providers/hashicorp/google/5.35.0/docs/data-sources/compute_global_address) | data source |
Expand All @@ -83,13 +92,18 @@

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_aws_dns_zone"></a> [aws\_dns\_zone](#input\_aws\_dns\_zone) | AWS Hosted Zone name to host all the DNSs, i.e.: "example.com" | `string` | n/a | yes |
| <a name="input_cloudflare_api_token"></a> [cloudflare\_api\_token](#input\_cloudflare\_api\_token) | Cloudflare API token for the zone you will use for DNS records: https://developers.cloudflare.com/fundamentals/api/get-started/create-token/ | `string` | n/a | yes |
| <a name="input_cloudflare_dns_zone"></a> [cloudflare\_dns\_zone](#input\_cloudflare\_dns\_zone) | Cloudflare DNS zone where to create DNS records. For example: `example.com` | `string` | n/a | yes |
| <a name="input_cluster_locations"></a> [cluster\_locations](#input\_cluster\_locations) | List of GCP zones (inside the region you specified) where the cluster will be | `list` | n/a | yes |
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name to give to the GKE cluster | `string` | n/a | yes |
| <a name="input_cpu_machine_type"></a> [cpu\_machine\_type](#input\_cpu\_machine\_type) | GCP machine type for the CPU nodes of the GKE cluster | `string` | `"c3-highmem-22"` | no |
| <a name="input_cpu_nodes_disk_size_gb"></a> [cpu\_nodes\_disk\_size\_gb](#input\_cpu\_nodes\_disk\_size\_gb) | Size in GiB for the CPU nodes' disks | `number` | `100` | no |
| <a name="input_cpu_nodes_locations"></a> [cpu\_nodes\_locations](#input\_cpu\_nodes\_locations) | Comma-separated zones for the CPU nodes inside the region you chose. For instance: "us-central1-a,us-central1-b" | `string` | `"us-central1-a"` | no |
| <a name="input_cpu_nodes_per_zone"></a> [cpu\_nodes\_per\_zone](#input\_cpu\_nodes\_per\_zone) | Number of CPU nodes to deploy per zone (related to cpu\_nodes\_locations) | `number` | `1` | no |
| <a name="input_db_disk_size_gb"></a> [db\_disk\_size\_gb](#input\_db\_disk\_size\_gb) | Cloud SQL General DB disk size in GiB | `string` | `"100"` | no |
| <a name="input_db_size"></a> [db\_size](#input\_db\_size) | Cloud SQL General DB size/type | `string` | `"db-custom-4-15360"` | no |
| <a name="input_en_grafana_ip_name"></a> [en\_grafana\_ip\_name](#input\_en\_grafana\_ip\_name) | Name for the GCP Global IP for the external node's grafana | `string` | `"en01-grafana-ip"` | no |
| <a name="input_encryption_key_prevent_destroy"></a> [encryption\_key\_prevent\_destroy](#input\_encryption\_key\_prevent\_destroy) | Whether to prevent destroying the GCP KMS decrpytion key for Kubernetes data | `bool` | `true` | no |
| <a name="input_explorer_api_ip_name"></a> [explorer\_api\_ip\_name](#input\_explorer\_api\_ip\_name) | Name for the GCP Global IP for the explorer api | `string` | `"explorer-api-ip"` | no |
| <a name="input_explorer_api_sepolia_dns"></a> [explorer\_api\_sepolia\_dns](#input\_explorer\_api\_sepolia\_dns) | DNS which will point to the explorer api, as a suffix to the main DNS zone. For example, "my-app" would render to `my-app.example.com` | `string` | n/a | yes |
| <a name="input_explorer_app_ip_name"></a> [explorer\_app\_ip\_name](#input\_explorer\_app\_ip\_name) | Name for the GCP Global IP for the explorer app | `string` | `"explorer-app-ip"` | no |
Expand All @@ -109,13 +123,19 @@
| <a name="input_portal_ip_name"></a> [portal\_ip\_name](#input\_portal\_ip\_name) | Name for the GCP Global IP for the portal | `string` | `"portal-ip"` | no |
| <a name="input_portal_sepolia_dns"></a> [portal\_sepolia\_dns](#input\_portal\_sepolia\_dns) | DNS which will point to the portal, as a suffix to the main DNS zone. For example, "my-app" would render to `my-app.example.com` | `string` | n/a | yes |
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | ID of the GCP Project to deploy all the infrastructure | `string` | n/a | yes |
| <a name="input_prover_db_disk_size_gb"></a> [prover\_db\_disk\_size\_gb](#input\_prover\_db\_disk\_size\_gb) | Cloud SQL Prover DB disk size in GiB | `string` | `"100"` | no |
| <a name="input_prover_db_size"></a> [prover\_db\_size](#input\_prover\_db\_size) | Cloud SQL Prover DB size/type | `string` | `"db-custom-4-15360"` | no |
| <a name="input_prover_object_store_bucket_name"></a> [prover\_object\_store\_bucket\_name](#input\_prover\_object\_store\_bucket\_name) | GCS Bucket name for the prover object store bucket | `string` | `"prover-object-store-dev"` | no |
| <a name="input_prover_setup_data_bucket_name"></a> [prover\_setup\_data\_bucket\_name](#input\_prover\_setup\_data\_bucket\_name) | GCS Bucket name for the prover setup data bucket | `string` | `"prover-setup-data"` | no |
| <a name="input_prover_sql_password"></a> [prover\_sql\_password](#input\_prover\_sql\_password) | Cloud SQL Prover DB password | `string` | n/a | yes |
| <a name="input_prover_sql_user"></a> [prover\_sql\_user](#input\_prover\_sql\_user) | Cloud SQL Prover DB username | `string` | n/a | yes |
| <a name="input_public_object_store_bucket_name"></a> [public\_object\_store\_bucket\_name](#input\_public\_object\_store\_bucket\_name) | GCS Bucket name for the public object store bucket | `string` | `"public-object-store-dev"` | no |
| <a name="input_region"></a> [region](#input\_region) | GCP region in which to deploy the cluster. Note: it needs to have GPU availability (G2 instances). More info: https://cloud.google.com/compute/docs/regions-zones#available | `string` | n/a | yes |
| <a name="input_rpc_sepolia_dns"></a> [rpc\_sepolia\_dns](#input\_rpc\_sepolia\_dns) | DNS which will point to the rpc (server), as a suffix to the main DNS zone. For example, "my-app" would render to `my-app.example.com` | `string` | n/a | yes |
| <a name="input_server_ip_name"></a> [server\_ip\_name](#input\_server\_ip\_name) | Name for the GCP Global IP for the server | `string` | `"server-ip"` | no |
| <a name="input_snapshots_object_store_bucket_name"></a> [snapshots\_object\_store\_bucket\_name](#input\_snapshots\_object\_store\_bucket\_name) | GCS Bucket name for the snapshots object store bucket | `string` | `"snapshots-object-store-dev"` | no |
| <a name="input_sql_password"></a> [sql\_password](#input\_sql\_password) | Cloud SQL General DB password | `string` | n/a | yes |
| <a name="input_sql_user"></a> [sql\_user](#input\_sql\_user) | Cloud SQL General DB username | `string` | n/a | yes |

## Outputs

Expand Down

0 comments on commit 68c49fa

Please sign in to comment.