Skip to content

Commit

Permalink
GitHub Actions: Docs: Automated update of README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 30, 2023
1 parent 9616cb0 commit 47e0317
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,30 @@ module "datagrok_core" {
| [aws_ecr_repository_policy.ecr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_repository_policy) | resource |
| [aws_ecs_service.datagrok](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
| [aws_ecs_service.grok_connect](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
| [aws_ecs_service.grok_spawner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
| [aws_ecs_service.smtp](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
| [aws_ecs_task_definition.datagrok](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
| [aws_ecs_task_definition.grok_connect](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
| [aws_ecs_task_definition.grok_spawner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
| [aws_ecs_task_definition.grok_spawner_kaniko](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
| [aws_ecs_task_definition.smtp](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
| [aws_iam_instance_profile.ec2_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
| [aws_iam_policy.docker_hub](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.ec2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.ecr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.exec](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.grok_spawner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.grok_spawner_ecr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.grok_spawner_exec](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.grok_spawner_kaniko](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.grok_spawner_kaniko_ecr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.s3_backup](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_policy.task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
| [aws_iam_role.ec2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.exec](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.grok_spawner_exec](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.grok_spawner_kaniko_task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.grok_spawner_task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.s3_backup_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role_policy_attachment.backup_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
Expand All @@ -102,6 +115,7 @@ module "datagrok_core" {
| [aws_route53_query_log.external](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_query_log) | resource |
| [aws_route53_record.external](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_route53_record.grok_connect](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_route53_record.grok_spawner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_route53_record.internal](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_route53_zone.external](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_zone) | resource |
| [aws_route53_zone.internal](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_zone) | resource |
Expand All @@ -110,11 +124,14 @@ module "datagrok_core" {
| [aws_service_discovery_private_dns_namespace.datagrok](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_private_dns_namespace) | resource |
| [aws_service_discovery_service.datagrok](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
| [aws_service_discovery_service.grok_connect](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
| [aws_service_discovery_service.grok_spawner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
| [aws_service_discovery_service.smtp](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/service_discovery_service) | resource |
| [aws_sns_topic_subscription.email](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
| [null_resource.ecr_push](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [random_password.admin_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
| [random_password.db_datagrok_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
| [random_string.lb_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
| [aws_ami.aws_optimized_ecs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
Expand All @@ -123,6 +140,7 @@ module "datagrok_core" {
| [aws_iam_policy_document.vpc_endpoint_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
| [aws_route53_zone.external](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |
| [aws_route53_zone.internal](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |

## Inputs

Expand All @@ -142,7 +160,7 @@ module "datagrok_core" {
| <a name="input_custom_kms_key"></a> [custom\_kms\_key](#input\_custom\_kms\_key) | Specifies whether a custom KMS key should be used to encrypt instead of the default. We recommend to set it to true for production stand. | `bool` | `false` | no |
| <a name="input_data_subnet_ids"></a> [data\_subnet\_ids](#input\_data\_subnet\_ids) | The IDs of data subnets to place resources. Required if 'vpc\_id' is specified. | `list(string)` | `[]` | no |
| <a name="input_database_subnet_group"></a> [database\_subnet\_group](#input\_database\_subnet\_group) | The ID of database subnet group to place datagrok DB. Required if 'vpc\_id' is specified. | `string` | `null` | no |
| <a name="input_datagrok_container_cpu"></a> [datagrok\_container\_cpu](#input\_datagrok\_container\_cpu) | The number of cpu units the Amazon ECS container agent reserves for the Datagrok container. | `number` | `512` | no |
| <a name="input_datagrok_container_cpu"></a> [datagrok\_container\_cpu](#input\_datagrok\_container\_cpu) | The number of cpu units the Amazon ECS container agent reserves for the Datagrok container. | `number` | `1024` | no |
| <a name="input_datagrok_container_memory_reservation"></a> [datagrok\_container\_memory\_reservation](#input\_datagrok\_container\_memory\_reservation) | The soft limit (in MiB) of memory to reserve for the Datagrok container. | `number` | `1024` | no |
| <a name="input_datagrok_cpu"></a> [datagrok\_cpu](#input\_datagrok\_cpu) | Number of cpu units used by the Datagrok FARGATE task. The hard limit of CPU units to present for the task. | `number` | `2048` | no |
| <a name="input_datagrok_memory"></a> [datagrok\_memory](#input\_datagrok\_memory) | Amount (in MiB) of memory used by the Datagrok FARGATE task. The hard limit of memory (in MiB) to present to the task. | `number` | `4096` | no |
Expand All @@ -152,6 +170,8 @@ module "datagrok_core" {
| <a name="input_docker_datagrok_tag"></a> [docker\_datagrok\_tag](#input\_docker\_datagrok\_tag) | Tag from Docker Registry for Datagrok Docker Image | `string` | `"latest"` | no |
| <a name="input_docker_grok_connect_image"></a> [docker\_grok\_connect\_image](#input\_docker\_grok\_connect\_image) | Grok Connect Docker Image registry location. By default the official image from Docker Hub will be used. | `string` | `"docker.io/datagrok/grok_connect"` | no |
| <a name="input_docker_grok_connect_tag"></a> [docker\_grok\_connect\_tag](#input\_docker\_grok\_connect\_tag) | Tag from Docker Registry for Datagrok Grok Connect Image | `string` | `"latest"` | no |
| <a name="input_docker_grok_spawner_image"></a> [docker\_grok\_spawner\_image](#input\_docker\_grok\_spawner\_image) | Grok Spawner Docker Image registry location. By default the official image from Docker Hub will be used. | `string` | `"docker.io/datagrok/grok_spawner"` | no |
| <a name="input_docker_grok_spawner_tag"></a> [docker\_grok\_spawner\_tag](#input\_docker\_grok\_spawner\_tag) | Tag from Docker Registry for Datagrok Grok Spawner Image | `string` | `"latest"` | no |
| <a name="input_docker_hub_credentials"></a> [docker\_hub\_credentials](#input\_docker\_hub\_credentials) | Docker Hub credentials to download images.<br>`create_secret` - Specifies if new secret with Docker Hub credentials will be created.<br>`user` - Docker Hub User to access Docker Hub and download datagrok images. Can be ommited if `secret_arn` is specified<br>`password` - Docker Hub Token to access Docker Hub and download datagrok images. Can be ommited if `secret_arn` is specified<br>`secret_arn` - The ARN of AWS Secret which contains Docker Hub Token to access Docker Hub and download datagrok images. If not specified the secret will be created using `user` and `password` variables<br>Either user(`user`) - password(`password`) pair or AWS Secret ARN (`secret_arn`) should be specified. | <pre>object({<br> create_secret = bool<br> password = optional(string)<br> user = optional(string)<br> secret_arn = optional(string)<br> })</pre> | `null` | no |
| <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | This is the name of domain for datagrok endpoint. It is used for the external hosted zone in Route53. and to create ACM certificates. | `string` | `""` | no |
| <a name="input_ec2_detailed_monitoring_enabled"></a> [ec2\_detailed\_monitoring\_enabled](#input\_ec2\_detailed\_monitoring\_enabled) | Specifies whether Monitoring Insights for EC2 instance are enabled. We recommend to set it to true for production stand. | `bool` | `true` | no |
Expand All @@ -173,6 +193,11 @@ module "datagrok_core" {
| <a name="input_grok_connect_container_memory_reservation"></a> [grok\_connect\_container\_memory\_reservation](#input\_grok\_connect\_container\_memory\_reservation) | The soft limit (in MiB) of memory to reserve for the Grok Connect container. | `number` | `512` | no |
| <a name="input_grok_connect_cpu"></a> [grok\_connect\_cpu](#input\_grok\_connect\_cpu) | Number of cpu units used by the Grok Connect FARGATE task. The hard limit of CPU units to present for the task. | `number` | `1024` | no |
| <a name="input_grok_connect_memory"></a> [grok\_connect\_memory](#input\_grok\_connect\_memory) | Amount (in MiB) of memory used by the Grok Connect FARGATE task. The hard limit of memory (in MiB) to present to the task. | `number` | `4096` | no |
| <a name="input_grok_spawner_container_cpu"></a> [grok\_spawner\_container\_cpu](#input\_grok\_spawner\_container\_cpu) | The number of cpu units the Amazon ECS container agent reserves for the Grok Spawner container. | `number` | `256` | no |
| <a name="input_grok_spawner_container_memory_reservation"></a> [grok\_spawner\_container\_memory\_reservation](#input\_grok\_spawner\_container\_memory\_reservation) | The soft limit (in MiB) of memory to reserve for the Grok Spawner container. | `number` | `256` | no |
| <a name="input_grok_spawner_cpu"></a> [grok\_spawner\_cpu](#input\_grok\_spawner\_cpu) | Number of cpu units used by the Grok Spawner FARGATE task. The hard limit of CPU units to present for the task. | `number` | `256` | no |
| <a name="input_grok_spawner_docker_build_enabled"></a> [grok\_spawner\_docker\_build\_enabled](#input\_grok\_spawner\_docker\_build\_enabled) | Specifies whether ECR policy to create repositories should be enabled for Grok Spawner to store debug images | `bool` | `true` | no |
| <a name="input_grok_spawner_memory"></a> [grok\_spawner\_memory](#input\_grok\_spawner\_memory) | Amount (in MiB) of memory used by the Grok Spawner FARGATE task. The hard limit of memory (in MiB) to present to the task. | `number` | `512` | no |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | EC2 instance type. The default value is the minimum recommended type. | `string` | `"t3.medium"` | no |
| <a name="input_key_pair_name"></a> [key\_pair\_name](#input\_key\_pair\_name) | Existing SSH Key Pair name for access to EC2 instance. If not set public\_key is required. | `string` | `null` | no |
| <a name="input_kms_admins"></a> [kms\_admins](#input\_kms\_admins) | https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#key-policy-default-allow-administrators | `list(string)` | `null` | no |
Expand Down Expand Up @@ -207,6 +232,11 @@ module "datagrok_core" {
| <a name="input_s3_policy_principal"></a> [s3\_policy\_principal](#input\_s3\_policy\_principal) | List of principal ARNs which will have access to S3 bucket. By default it is limited to the root ARN. | `list(string)` | `[]` | no |
| <a name="input_service_discovery_namespace"></a> [service\_discovery\_namespace](#input\_service\_discovery\_namespace) | Service discovery namespace for FARGATE tasks. Set 'create' to 'true' to create new one. Or set 'create' to 'false' and 'id' to AWS Service Discovery Namespace ID to use the existing one. | <pre>object({<br> create = bool<br> id = optional(string)<br> })</pre> | <pre>{<br> "create": true<br>}</pre> | no |
| <a name="input_set_admin_password"></a> [set\_admin\_password](#input\_set\_admin\_password) | Specifies whether Datagrok Admin user password should be set to custom value. We recommend to set it to true for production stand. | `bool` | `false` | no |
| <a name="input_smtp_relay_host"></a> [smtp\_relay\_host](#input\_smtp\_relay\_host) | SMTP relay host to send emails for datagrok | `string` | `null` | no |
| <a name="input_smtp_relay_password"></a> [smtp\_relay\_password](#input\_smtp\_relay\_password) | SMTP relay password to send emails for datagrok | `string` | `null` | no |
| <a name="input_smtp_relay_port"></a> [smtp\_relay\_port](#input\_smtp\_relay\_port) | SMTP relay port to send emails for datagrok | `string` | `null` | no |
| <a name="input_smtp_relay_username"></a> [smtp\_relay\_username](#input\_smtp\_relay\_username) | SMTP relay username to send emails for datagrok | `string` | `null` | no |
| <a name="input_smtp_server"></a> [smtp\_server](#input\_smtp\_server) | Specifies whether to create SMTP server | `bool` | `false` | no |
| <a name="input_sns_topic_name"></a> [sns\_topic\_name](#input\_sns\_topic\_name) | The name of Datagrok SNS topic. If it is not specified, the name along with the environment will be used. | `string` | `null` | no |
| <a name="input_subject_alternative_names"></a> [subject\_alternative\_names](#input\_subject\_alternative\_names) | List for alternative names for ACM certificate | `list(string)` | `[]` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Key-value map of resource tags. | `map(string)` | `{}` | no |
Expand Down

0 comments on commit 47e0317

Please sign in to comment.