Docs v4 README updates (#82)

slalom · Mar 24, 2020 · f63b3e8 · f63b3e8
1 parent 1d9ad88
commit f63b3e8
Show file tree

Hide file tree

Showing 19 changed files with 195 additions and 195 deletions.
diff --git a/catalog/aws/airflow/README.md b/catalog/aws/airflow/README.md
@@ -12,25 +12,25 @@ Airflow is an open source platform to programmatically author, schedule and moni
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| container\_command | n/a | `string` | n/a | yes |
+| container\_command | The command to run on the Airflow container. | `string` | n/a | yes |
 | environment | Standard `environment` module input. | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
 | github\_repo\_ref | The git repo reference to clone onto the airflow server | `string` | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
-| container\_image | n/a | `string` | `"airflow"` | no |
-| container\_num\_cores | n/a | `number` | `2` | no |
-| container\_ram\_gb | n/a | `number` | `4` | no |
-| environment\_secrets | n/a | `map(string)` | `{}` | no |
-| environment\_vars | n/a | `map(string)` | `{}` | no |
+| container\_image | Optional. Overrides the docker image used for Airflow execution. | `string` | `"airflow"` | no |
+| container\_num\_cores | Optional. The number of CPU cores. | `number` | `2` | no |
+| container\_ram\_gb | Optional. The amount of RAM to use, in GB. | `number` | `4` | no |
+| environment\_secrets | A map of environment variable secrets to pass to the airflow image. Each secret value should be either a<br>Secrets Manager URI or a local JSON or YAML file reference in the form `/path/to/file.yml:name_of_secret`. | `map(string)` | `{}` | no |
+| environment\_vars | A map of environment variables to pass to the Airflow image. | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| airflow\_url | n/a |
-| logging\_url | n/a |
-| server\_launch\_cli | n/a |
-| summary | n/a |
+| airflow\_url | Link to the airflow web UI. |
+| logging\_url | Link to Airflow logs in Cloudwatch. |
+| server\_launch\_cli | Command to launch the Airflow web server via ECS. |
+| summary | Summary of resources created by this module. |
 
 ---------------------
 

diff --git a/catalog/aws/data-lake/README.md b/catalog/aws/data-lake/README.md
@@ -24,10 +24,10 @@ trigger automatically when new content is added.
 
 | Name | Description |
 |------|-------------|
-| s3\_data\_bucket | n/a |
-| s3\_logging\_bucket | n/a |
-| s3\_metadata\_bucket | n/a |
-| summary | n/a |
+| s3\_data\_bucket | The S3 bucket used for data storage. |
+| s3\_logging\_bucket | The S3 bucket used for log file storage. |
+| s3\_metadata\_bucket | The S3 bucket used for metadata file storage. |
+| summary | Summary of resources created by this module. |
 
 ---------------------
 

diff --git a/catalog/aws/dbt/README.md b/catalog/aws/dbt/README.md
@@ -12,27 +12,27 @@ DBT (Data Built Tool) is a CI/CD and DevOps-friendly platform for automating dat
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| container\_entrypoint | n/a | `any` | n/a | yes |
-| dbt\_run\_command | n/a | `string` | n/a | yes |
+| container\_entrypoint | Optional. Overrides the docker image entrypoint. | `any` | n/a | yes |
+| dbt\_run\_command | Optional. The default command to run when executing DBT. | `string` | n/a | yes |
 | environment | Standard `environment` module input. | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
 | scheduled\_refresh\_interval | A rate string, e.g. '5 minutes'. This is in addition to any other scheduled executions. | `string` | n/a | yes |
-| admin\_cidr | n/a | `list` | `[]` | no |
-| container\_image | n/a | `string` | `"slalomggp/dataops"` | no |
-| container\_num\_cores | n/a | `number` | `4` | no |
-| container\_ram\_gb | n/a | `number` | `16` | no |
-| dbt\_project\_git\_repo | n/a | `string` | `"git+https://github.com/slalom-ggp/dataops-project-template.git"` | no |
+| admin\_cidr | Optional. The range of IP addresses which should be able to access the DBT instance. Defaults to the local user's current IP. | `list` | `[]` | no |
+| container\_image | Optional. A docker image to override the default image. | `string` | `"slalomggp/dataops"` | no |
+| container\_num\_cores | Optional. Overrides the number of CPU cores used. | `number` | `4` | no |
+| container\_ram\_gb | Optional. Overrides the RAM used (in GB). | `number` | `16` | no |
+| dbt\_project\_git\_repo | Optional. A git repo to download to the local image which contains DBT transforms information. | `string` | `"git+https://github.com/slalom-ggp/dataops-project-template.git"` | no |
 | environment\_secrets | Mapping of environment variable names to secret manager ARNs.<br>e.g. arn:aws:secretsmanager:[aws\_region]:[aws\_account]:secret:prod/ECSRunner/AWS\_SECRET\_ACCESS\_KEY | `map(string)` | `{}` | no |
 | environment\_vars | Mapping of environment variable names to their values. | `map(string)` | `{}` | no |
 | scheduled\_refresh\_times | A list of schedule strings in 6-part cron notation. For help creating cron schedule codes: https://crontab.guru | `list(string)` | `[]` | no |
-| scheduled\_timezone | n/a | `string` | `"PT"` | no |
+| scheduled\_timezone | The timezone code with which to evaluate execution schedule(s). | `string` | `"PT"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| summary | n/a |
+| summary | Summary of resources created by this module. |
 
 ---------------------
 

diff --git a/catalog/aws/environment/README.md b/catalog/aws/environment/README.md
@@ -13,25 +13,25 @@ from this module is designed to be passed easily to downstream modules, streamli
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| aws\_profile | Optional, unless set at the main AWS provider level in which case it is required. | `string` | n/a | yes |
-| aws\_region | n/a | `any` | n/a | yes |
+| aws\_profile | The name of the AWS profile to use. Optional unless set at the main AWS provider level, in which case it is required. | `string` | n/a | yes |
+| aws\_region | Optional, used for multi-region deployments. Overrides the contextual AWS region with the region code provided. | `any` | n/a | yes |
 | environment | Standard `environment` module input. (Ignored for the `environment` module.) | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
-| secrets\_folder | n/a | `string` | n/a | yes |
+| secrets\_folder | Path to the secrets folder (used when initializing the AWS provider.) | `string` | n/a | yes |
 | disabled | As a workaround for unsupported 'count' feature in terraform modules, this switch can be used to disable the module entirely. | `bool` | `false` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| aws\_credentials\_file | n/a |
-| environment | n/a |
-| is\_windows\_host | n/a |
-| ssh\_private\_key\_filename | n/a |
-| ssh\_public\_key\_filename | n/a |
-| summary | n/a |
-| user\_home | n/a |
+| aws\_credentials\_file | Path to AWS credentials file for the project. |
+| environment | The `environment` object to be passed as a standard input to other Infrastructure Catalog modules. |
+| is\_windows\_host | True if running on a Windows machine, otherwise False. |
+| ssh\_private\_key\_filename | Path to private key for SSH connections. |
+| ssh\_public\_key\_filename | Path to public key for SSH connections. |
+| summary | Summary of resources created by this module. |
+| user\_home | Path to the admin user's home directory. |
 
 ---------------------
 

diff --git a/catalog/aws/mysql/README.md b/catalog/aws/mysql/README.md
@@ -14,25 +14,25 @@ Deploys a MySQL server running on RDS.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| admin\_password | Must be 8 characters long. | `string` | n/a | yes |
-| admin\_username | n/a | `string` | n/a | yes |
+| admin\_password | The initial admin password. Must be 8 characters long. | `string` | n/a | yes |
+| admin\_username | The initial admin username. | `string` | n/a | yes |
 | environment | Standard `environment` module input. | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
-| kms\_key\_id | n/a | `string` | n/a | yes |
+| kms\_key\_id | Optional. The ARN for the KMS encryption key used in cluster encryption. | `string` | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
-| identifier | n/a | `string` | `"rds-db"` | no |
-| instance\_class | Enter the desired node type. The default and cheapest option is 'db.t2.micro' @ ~$0.017/hr. Alternatively, the cost/month @ ~$12.25/mo.   (https://aws.amazon.com/rds/mysql/pricing/ ) | `string` | `"db.t2.micro"` | no |
-| jdbc\_port | n/a | `number` | `3306` | no |
-| mysql\_version | n/a | `string` | `"5.7.26"` | no |
-| skip\_final\_snapshot | n/a | `bool` | `false` | no |
-| storage\_size\_in\_gb | The allocated storage value is denoted in GB | `string` | `"20"` | no |
+| identifier | The database name which will be used within connection strings and URLs. | `string` | `"rds-db"` | no |
+| instance\_class | Enter the desired node type. The default and cheapest option is 'db.t2.micro' @ ~$0.017/hr, or ~$120/mo (https://aws.amazon.com/rds/mysql/pricing/ ) | `string` | `"db.t2.micro"` | no |
+| jdbc\_port | Optional. Overrides the default JDBC port for incoming SQL connections. | `number` | `3306` | no |
+| mysql\_version | Optional. The specific MySQL version to use. | `string` | `"5.7.26"` | no |
+| skip\_final\_snapshot | If true, will allow terraform to destroy the RDS cluster without performing a final backup. | `bool` | `false` | no |
+| storage\_size\_in\_gb | The allocated storage value is denoted in GB. | `string` | `"20"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| endpoint | n/a |
-| summary | n/a |
+| endpoint | The MySQL connection endpoint for the new server. |
+| summary | Summary of resources created by this module. |
 
 ---------------------
 

diff --git a/catalog/aws/postgres/README.md b/catalog/aws/postgres/README.md
@@ -14,28 +14,28 @@ Deploys a Postgres server running on RDS.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| admin\_password | Must be 8 characters long. | `string` | n/a | yes |
-| admin\_username | n/a | `string` | n/a | yes |
-| elastic\_ip | n/a | `string` | n/a | yes |
+| admin\_password | The initial admin password. Must be 8 characters long. | `string` | n/a | yes |
+| admin\_username | The initial admin username. | `string` | n/a | yes |
+| elastic\_ip | Optional. An Elastic IP endpoint which will be used to for routing incoming traffic. | `string` | n/a | yes |
 | environment | Standard `environment` module input. | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
-| kms\_key\_id | n/a | `string` | n/a | yes |
+| kms\_key\_id | Optional. The ARN for the KMS encryption key used in cluster encryption. | `string` | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
-| s3\_logging\_bucket | n/a | `string` | n/a | yes |
-| s3\_logging\_path | n/a | `string` | n/a | yes |
-| identifier | n/a | `string` | `"rds-postgres-db"` | no |
-| instance\_class | Enter the desired node type. The default and cheapest option is 'db.t2.micro' @ ~$0.017/hr  (https://aws.amazon.com/rds/mysql/pricing/ ) | `string` | `"db.t2.micro"` | no |
-| jdbc\_port | n/a | `number` | `5432` | no |
-| postgres\_version | n/a | `string` | `"11.5"` | no |
-| skip\_final\_snapshot | n/a | `bool` | `false` | no |
+| s3\_logging\_bucket | Optional. An S3 bucket to use for log collection. | `string` | n/a | yes |
+| s3\_logging\_path | Required if `s3_logging_bucket` is set. The path within the S3 bucket to use for log storage. | `string` | n/a | yes |
+| identifier | The database name which will be used within connection strings and URLs. | `string` | `"rds-postgres-db"` | no |
+| instance\_class | Enter the desired node type. The default and cheapest option is 'db.t2.micro' @ ~$0.017/hr, or ~$120/mo (https://aws.amazon.com/rds/mysql/pricing/ ) | `string` | `"db.t2.micro"` | no |
+| jdbc\_port | Optional. Overrides the default JDBC port for incoming SQL connections. | `number` | `5432` | no |
+| postgres\_version | Optional. Overrides the version of the Postres database engine. | `string` | `"11.5"` | no |
+| skip\_final\_snapshot | If true, will allow terraform to destroy the RDS cluster without performing a final backup. | `bool` | `false` | no |
 | storage\_size\_in\_gb | The allocated storage value is denoted in GB | `string` | `"10"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| endpoint | n/a |
-| summary | n/a |
+| endpoint | The Postgres connection endpoint for the new server. |
+| summary | Summary of resources created by this module. |
 
 ---------------------
 

diff --git a/catalog/aws/redshift/README.md b/catalog/aws/redshift/README.md
@@ -12,25 +12,25 @@ Redshift is an AWS database platform which applies MPP (Massively-Parallel-Proce
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:-----:|
-| admin\_password | Must be 8 characters long. | `string` | n/a | yes |
-| elastic\_ip | n/a | `string` | n/a | yes |
+| admin\_password | The initial admin password. Must be 8 characters long. | `string` | n/a | yes |
+| elastic\_ip | Optional. An Elastic IP endpoint which will be used to for routing incoming traffic. | `string` | n/a | yes |
 | environment | Standard `environment` module input. | <pre>object({<br>    vpc_id          = string<br>    aws_region      = string<br>    public_subnets  = list(string)<br>    private_subnets = list(string)<br>  })</pre> | n/a | yes |
-| kms\_key\_id | n/a | `string` | n/a | yes |
+| kms\_key\_id | Optional. The ARN for the KMS encryption key used in cluster encryption. | `string` | n/a | yes |
 | name\_prefix | Standard `name_prefix` module input. | `string` | n/a | yes |
 | resource\_tags | Standard `resource_tags` module input. | `map(string)` | n/a | yes |
-| s3\_logging\_bucket | n/a | `string` | n/a | yes |
-| s3\_logging\_path | n/a | `string` | n/a | yes |
-| jdbc\_port | n/a | `number` | `5439` | no |
-| node\_type | Enter the desired node type. The default and cheapest option is 'dc2.large' @ ~$0.25/hr  (https://aws.amazon.com/redshift/pricing/) | `string` | `"dc2.large"` | no |
-| num\_nodes | n/a | `number` | `1` | no |
-| skip\_final\_snapshot | n/a | `bool` | `false` | no |
+| s3\_logging\_bucket | Optional. An S3 bucket to use for log collection. | `string` | n/a | yes |
+| s3\_logging\_path | Required if `s3_logging_bucket` is set. The path within the S3 bucket to use for log storage. | `string` | n/a | yes |
+| jdbc\_port | Optional. Overrides the default JDBC port for incoming SQL connections. | `number` | `5439` | no |
+| node\_type | Enter the desired node type. The default and cheapest option is 'dc2.large' @ ~$0.25/hr, ~$180/mo (https://aws.amazon.com/redshift/pricing/) | `string` | `"dc2.large"` | no |
+| num\_nodes | Optional (default=1). The number of Redshift nodes to use. | `number` | `1` | no |
+| skip\_final\_snapshot | If true, will allow terraform to destroy the RDS cluster without performing a final backup. | `bool` | `false` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| endpoint | n/a |
-| summary | n/a |
+| endpoint | The Redshift connection endpoint for the new server. |
+| summary | Summary of resources created by this module. |
 
 ---------------------