From 05a0cc0bb1929d89fd07e0d66729365dc954ab5d Mon Sep 17 00:00:00 2001 From: Wilson de Carvalho <796900+wcmjunior@users.noreply.github.com> Date: Mon, 25 Nov 2024 11:27:19 -0800 Subject: [PATCH] Fix docs templates --- docs/guides/mongodb_cluster_okta_idp.md | 4 --- docs/guides/setup_cp_and_deploy_sidecar.md | 5 ---- docs/guides/smart_ports.md | 10 ------- examples/guides/iam_auth_rds_pg.tf | 8 ++--- .../mongodb_cluster/okta_idp_sidecar.tf | 27 ++--------------- examples/guides/s3_browser_and_aws_cli.tf | 9 +++--- .../guides/setup_cp_and_deploy_sidecar.tf | 29 ++----------------- examples/guides/smart_ports_1.tf | 27 ++--------------- examples/guides/smart_ports_2.tf | 27 ++--------------- .../cyral_integration_logging/cloudwatch.tf | 2 +- templates/index.md.tmpl | 2 +- 11 files changed, 20 insertions(+), 130 deletions(-) diff --git a/docs/guides/mongodb_cluster_okta_idp.md b/docs/guides/mongodb_cluster_okta_idp.md index aa7e4d07..ffd75b26 100644 --- a/docs/guides/mongodb_cluster_okta_idp.md +++ b/docs/guides/mongodb_cluster_okta_idp.md @@ -77,8 +77,6 @@ locals { # Set to true if you want a sidecar deployed with an # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" # Set the AWS region that the sidecar will be deployed to region = "" @@ -245,8 +243,6 @@ module "cyral_sidecar" { # Use the module version that is compatible with your sidecar. version = "~> 5.0" - sidecar_version = local.sidecar.sidecar_version - sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host diff --git a/docs/guides/setup_cp_and_deploy_sidecar.md b/docs/guides/setup_cp_and_deploy_sidecar.md index 22979867..76acecaa 100644 --- a/docs/guides/setup_cp_and_deploy_sidecar.md +++ b/docs/guides/setup_cp_and_deploy_sidecar.md @@ -50,9 +50,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -150,8 +147,6 @@ module "cyral_sidecar" { # Use the module version that is compatible with your sidecar. version = "~> 5.0" - sidecar_version = local.sidecar.sidecar_version - sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host diff --git a/docs/guides/smart_ports.md b/docs/guides/smart_ports.md index 213995ac..80d66b4f 100644 --- a/docs/guides/smart_ports.md +++ b/docs/guides/smart_ports.md @@ -73,9 +73,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -307,8 +304,6 @@ module "cyral_sidecar" { # Use the module version that is compatible with your sidecar. version = "~> 5.0" - sidecar_version = local.sidecar.sidecar_version - sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host @@ -391,9 +386,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -561,8 +553,6 @@ module "cyral_sidecar" { # Use the module version that is compatible with your sidecar. version = "~> 5.0" - sidecar_version = local.sidecar.sidecar_version - sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host diff --git a/examples/guides/iam_auth_rds_pg.tf b/examples/guides/iam_auth_rds_pg.tf index 624f9fba..7383ab39 100644 --- a/examples/guides/iam_auth_rds_pg.tf +++ b/examples/guides/iam_auth_rds_pg.tf @@ -217,7 +217,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.3" + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host @@ -236,10 +236,10 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - sidecar_dns_hosted_zone_id = local.sidecar.dns_hosted_zone_id - sidecar_dns_name = local.sidecar.dns_name + dns_hosted_zone_id = local.sidecar.dns_hosted_zone_id + dns_name = local.sidecar.dns_name } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/guides/mongodb_cluster/okta_idp_sidecar.tf b/examples/guides/mongodb_cluster/okta_idp_sidecar.tf index 2ab7a78c..8a6dd514 100644 --- a/examples/guides/mongodb_cluster/okta_idp_sidecar.tf +++ b/examples/guides/mongodb_cluster/okta_idp_sidecar.tf @@ -3,8 +3,6 @@ locals { # Set to true if you want a sidecar deployed with an # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" # Set the AWS region that the sidecar will be deployed to region = "" @@ -24,17 +22,6 @@ locals { # Name of the CloudWatch log group used to push logs cloudwatch_log_group_name = "cyral-example-loggroup" - # Set the parameters to access the private Cyral container - # registry. These parameters can be found in the sidecar - # Terraform template downloaded from the UI. Use the - # commented values to locate the variables and copy the - # values from the downloaded template. - container_registry = { - name = "" # container_registry - username = "" # container_registry_username - registry_key = "" # container_registry_key - } - # Specify the maximum number of nodes you expect this cluster to # have, taking into consideration future growth. This number must be # at least equal to the number of nodes currently in your @@ -180,9 +167,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.0" - - sidecar_version = local.sidecar.sidecar_version + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id @@ -206,20 +191,14 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - deploy_secrets = true - secrets_location = "/cyral/sidecars/${cyral_sidecar.sidecar.id}/secrets" - - container_registry = local.sidecar.container_registry.name - container_registry_username = local.sidecar.container_registry.username - container_registry_key = local.sidecar.container_registry.registry_key client_id = cyral_sidecar_credentials.sidecar_credentials.client_id client_secret = cyral_sidecar_credentials.sidecar_credentials.client_secret } output "sidecar_dns" { - value = module.cyral_sidecar.sidecar_dns + value = module.cyral_sidecar.dns } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/guides/s3_browser_and_aws_cli.tf b/examples/guides/s3_browser_and_aws_cli.tf index 1691e23d..93006879 100644 --- a/examples/guides/s3_browser_and_aws_cli.tf +++ b/examples/guides/s3_browser_and_aws_cli.tf @@ -232,7 +232,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.3" + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id control_plane = local.control_plane_host @@ -251,16 +251,15 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - load_balancer_certificate_arn = local.sidecar.load_balancer_certificate_arn load_balancer_tls_ports = [ local.repos.s3.browser_port ] - sidecar_dns_hosted_zone_id = local.sidecar.dns_hosted_zone_id - sidecar_dns_name = local.sidecar.dns_name + dns_hosted_zone_id = local.sidecar.dns_hosted_zone_id + dns_name = local.sidecar.dns_name } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/guides/setup_cp_and_deploy_sidecar.tf b/examples/guides/setup_cp_and_deploy_sidecar.tf index e26eeb6e..4657abe1 100644 --- a/examples/guides/setup_cp_and_deploy_sidecar.tf +++ b/examples/guides/setup_cp_and_deploy_sidecar.tf @@ -35,9 +35,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -55,17 +52,6 @@ locals { # Set the allowed CIDR block for monitoring requests to the # sidecar monitoring_inbound_cidr = ["0.0.0.0/0"] - - # Set the parameters to access the private Cyral container - # registry. These parameters can be found in the sidecar - # Terraform template downloaded from the UI. Use the - # commented values to locate the variables and copy the - # values from the downloaded template. - container_registry = { - name = "" # container_registry - username = "" # container_registry_username - registry_key = "" # container_registry_key - } } } @@ -144,9 +130,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.0" - - sidecar_version = local.sidecar.sidecar_version + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id @@ -166,21 +150,14 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - deploy_secrets = true - secrets_location = "/cyral/sidecars/${cyral_sidecar.sidecar.id}/secrets" - - container_registry = local.sidecar.container_registry.name - container_registry_username = local.sidecar.container_registry.username - container_registry_key = local.sidecar.container_registry.registry_key - client_id = cyral_sidecar_credentials.sidecar_credentials.client_id client_secret = cyral_sidecar_credentials.sidecar_credentials.client_secret } output "sidecar_dns" { - value = module.cyral_sidecar.sidecar_dns + value = module.cyral_sidecar.dns } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/guides/smart_ports_1.tf b/examples/guides/smart_ports_1.tf index 60682750..e8275fa5 100644 --- a/examples/guides/smart_ports_1.tf +++ b/examples/guides/smart_ports_1.tf @@ -46,9 +46,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -66,17 +63,6 @@ locals { # Set the allowed CIDR block for monitoring requests to the # sidecar monitoring_inbound_cidr = ["0.0.0.0/0"] - - # Set the parameters to access the private Cyral container - # registry. These parameters can be found in the sidecar - # Terraform template downloaded from the UI. Use the - # commented values to locate the variables and copy the - # values from the downloaded template. - container_registry = { - name = "" # container_registry - username = "" # container_registry_username - registry_key = "" # container_registry_key - } } } @@ -289,9 +275,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.0" - - sidecar_version = local.sidecar.sidecar_version + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id @@ -309,17 +293,10 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - deploy_secrets = true - secrets_location = "/cyral/sidecars/${cyral_sidecar.sidecar.id}/secrets" - - container_registry = local.sidecar.container_registry.name - container_registry_username = local.sidecar.container_registry.username - container_registry_key = local.sidecar.container_registry.registry_key - client_id = cyral_sidecar_credentials.sidecar_credentials.client_id client_secret = cyral_sidecar_credentials.sidecar_credentials.client_secret } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/guides/smart_ports_2.tf b/examples/guides/smart_ports_2.tf index d41cd4bb..8ae5922f 100644 --- a/examples/guides/smart_ports_2.tf +++ b/examples/guides/smart_ports_2.tf @@ -52,9 +52,6 @@ locals { # internet-facing load balancer (requires a public subnet). public_sidecar = false - # Set the desired sidecar version. - sidecar_version = "v4.7.0" - # Set the AWS region that the sidecar will be deployed to region = "" # Set the ID of VPC that the sidecar will be deployed to @@ -72,17 +69,6 @@ locals { # Set the allowed CIDR block for monitoring requests to the # sidecar monitoring_inbound_cidr = ["0.0.0.0/0"] - - # Set the parameters to access the private Cyral container - # registry. These parameters can be found in the sidecar - # Terraform template downloaded from the UI. Use the - # commented values to locate the variables and copy the - # values from the downloaded template. - container_registry = { - name = "" # container_registry - username = "" # container_registry_username - registry_key = "" # container_registry_key - } } } @@ -231,9 +217,7 @@ module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" # Use the module version that is compatible with your sidecar. - version = "~> 4.0" - - sidecar_version = local.sidecar.sidecar_version + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id @@ -251,17 +235,10 @@ module "cyral_sidecar" { load_balancer_scheme = local.sidecar.public_sidecar ? "internet-facing" : "internal" associate_public_ip_address = local.sidecar.public_sidecar - deploy_secrets = true - secrets_location = "/cyral/sidecars/${cyral_sidecar.sidecar.id}/secrets" - - container_registry = local.sidecar.container_registry.name - container_registry_username = local.sidecar.container_registry.username - container_registry_key = local.sidecar.container_registry.registry_key - client_id = cyral_sidecar_credentials.sidecar_credentials.client_id client_secret = cyral_sidecar_credentials.sidecar_credentials.client_secret } output "sidecar_load_balancer_dns" { - value = module.cyral_sidecar.sidecar_load_balancer_dns + value = module.cyral_sidecar.load_balancer_dns } diff --git a/examples/resources/cyral_integration_logging/cloudwatch.tf b/examples/resources/cyral_integration_logging/cloudwatch.tf index 127279ac..babd980b 100644 --- a/examples/resources/cyral_integration_logging/cloudwatch.tf +++ b/examples/resources/cyral_integration_logging/cloudwatch.tf @@ -25,7 +25,7 @@ resource "cyral_sidecar_credentials" "creds" { module "cyral_sidecar" { source = "cyralinc/sidecar-ec2/aws" - version = "~> 4.0" + version = "~> 5.0" sidecar_id = cyral_sidecar.sidecar.id diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index dba83be0..55a84775 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -37,7 +37,7 @@ terraform { required_providers { cyral = { source = "cyralinc/cyral" - version = "~> 4.1" + version = "~> 4.0" } } }