From db240f52a5e383317af3ee128f7af6752f9fb5b2 Mon Sep 17 00:00:00 2001 From: clouddrove-ci Date: Mon, 23 Aug 2021 13:51:22 +0000 Subject: [PATCH] update README.md --- README.md | 187 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 143 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 3ac32a6..c634e99 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,163 @@ -## Requirements + -| Name | Version | -|------|---------| -| terraform | >= 0.13.0 | -| aws | >= 3.1.15 | +

-## Providers -| Name | Version | -|------|---------| -| aws | >= 3.1.15 | +

+ Terraform AWS ECR +

+ +

+ Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration. +

+ +

+ + + Terraform + + + Licence + + + +

+

+ + + + + + + + + + + +

+
+ + +We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure. + +This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself. + +We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress. + + + + +## Prerequisites + +This module has a few dependencies: + +- [Terraform 0.15](https://learn.hashicorp.com/terraform/getting-started/install.html) +- [Go](https://golang.org/doc/install) +- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify) +- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest) + + + + + + + +## Examples + + +**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-active-directory/releases). + + +### Simple Example +Here is an example of how you can use this module in your inventory structure: +```hcl + module "ad" { + source = "clouddrove/active-directory/aws" + name = "adclouddrove" + subnet_ids = module.subnets.public_subnet_id + vpc_id = module.vpc.vpc_id + ad_name = "clouddrovepoc.example.com" + ad_password = "xyz123@abc" + ip_whitelist = ["51.79.69.69/32"] + } + +``` + -## Modules -| Name | Source | Version | -|------|--------|---------| -| labels | git::https://github.com/clouddrove/terraform-labels.git?ref=tags/0.14.0 | | -## Resources -| Name | -|------| -| [aws_directory_service_directory](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/resources/directory_service_directory) | -| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/data-sources/iam_policy_document) | -| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/resources/iam_role_policy_attachment) | -| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/resources/iam_role) | -| [aws_workspaces_directory](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/resources/workspaces_directory) | -| [aws_workspaces_ip_group](https://registry.terraform.io/providers/hashicorp/aws/3.1.15/docs/resources/workspaces_ip_group) | ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| ad\_name | AD name | `any` | `null` | no | -| ad\_password | AD password | `any` | `null` | no | -| ad\_service\_id | AD service ID | `string` | `""` | no | -| ad\_size | Size of the AD | `string` | `"Small"` | no | -| change\_compute\_type | Enable change compute type | `bool` | `true` | no | +| ad\_name | The fully qualified name for the directory, such as corp.example.com | `string` | `"corp.example.com"` | no | +| ad\_password | The password for the directory administrator or connector user. | `string` | `"xyzsf58f5fqar"` | no | +| ad\_size | The size of the directory (Small or Large are accepted values). | `string` | `"Small"` | no | +| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no | +| change\_compute\_type | Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. | `bool` | `true` | no | | custom\_policy | Custom policy ARN | `string` | `""` | no | -| device\_type\_android | Allow device type android | `string` | `"ALLOW"` | no | -| device\_type\_chromeos | Allow device type chromeos | `string` | `"ALLOW"` | no | -| device\_type\_ios | Allow device type ios | `string` | `"ALLOW"` | no | -| device\_type\_osx | Allow device type osx | `string` | `"ALLOW"` | no | -| device\_type\_web | Allow device type web | `string` | `"ALLOW"` | no | -| device\_type\_windows | Allow device type windows | `string` | `"ALLOW"` | no | -| device\_type\_zeroclient | Allow device type zeroclient | `string` | `"ALLOW"` | no | -| enable\_internet\_access | Enable internet access | `bool` | `false` | no | -| enable\_maintenance\_mode | Enable maintenance mode | `bool` | `false` | no | -| increase\_volume\_size | Enable increase volume size | `bool` | `true` | no | -| ip\_whitelist | List of IP's to for whitelist | `list(string)` | `null` | no | -| name | Name of the component | `any` | `null` | no | -| rebuild\_workspace | Enable rebuild workspace | `bool` | `true` | no | -| restart\_workspace | Enable restart workspace | `bool` | `true` | no | +| device\_type\_android | Indicates whether users can use Android devices to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| device\_type\_chromeos | Indicates whether users can use Chromebooks to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| device\_type\_ios | Indicates whether users can use iOS devices to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| device\_type\_osx | Indicates whether users can use macOS clients to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| device\_type\_web | Indicates whether users can access their WorkSpaces through a web browser. | `string` | `"ALLOW"` | no | +| device\_type\_windows | Indicates whether users can use Windows clients to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| device\_type\_zeroclient | Indicates whether users can use zero client devices to access their WorkSpaces. | `string` | `"ALLOW"` | no | +| enable\_internet\_access | Indicates whether internet access is enabled for your WorkSpaces. | `bool` | `false` | no | +| enable\_maintenance\_mode | Indicates whether maintenance mode is enabled for your WorkSpaces. | `bool` | `false` | no | +| enabled | Flag to control the module creation. | `bool` | `true` | no | +| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no | +| increase\_volume\_size | Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. | `bool` | `true` | no | +| ip\_whitelist | List of IP's to for whitelist | `list(string)` | 
[
  "51.79.69.69/32"
]
| no | +| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no | +| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no | +| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no | +| rebuild\_workspace | Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. | `bool` | `true` | no | +| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-active-directory"` | no | +| restart\_workspace | Whether WorkSpaces directory users can restart their workspace. | `bool` | `true` | no | | subnet\_ids | List of subnets in VPC | `list(string)` | `null` | no | -| switch\_running\_mode | Enable switch running mode | `bool` | `true` | no | -| user\_enabled\_as\_local\_administrator | User enabled as local administrator | `bool` | `false` | no | +| switch\_running\_mode | Whether WorkSpaces directory users can switch the running mode of their workspace. | `bool` | `true` | no | +| user\_enabled\_as\_local\_administrator | Indicates whether users are local administrators of their WorkSpaces. | `bool` | `false` | no | | vpc\_id | VPC ID | `any` | `null` | no | ## Outputs | Name | Description | |------|-------------| -| directory\_id | n/a | \ No newline at end of file +| directory\_id | outputs of workspaces directory | +| directory\_name | directory name. | + + + + +## Testing +In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. + +You need to run the following command in the testing folder: +```hcl + go test -run Test +``` + + + +## Feedback +If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-active-directory/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com). + +If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-active-directory)! + +## About us + +At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering. + +

We are The Cloud Experts!

+
+

We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.

+ + [website]: https://clouddrove.com + [github]: https://github.com/clouddrove + [linkedin]: https://cpco.io/linkedin + [twitter]: https://twitter.com/clouddrove/ + [email]: https://clouddrove.com/contact-us.html + [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=