Skip to content

Commit e670a28

Browse files
authored
docs: Update docs prior to v1 release (#182)
1 parent 936a488 commit e670a28

File tree

2 files changed

+57
-21
lines changed

2 files changed

+57
-21
lines changed

tests/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Amazon EKS Blueprints Addons
2+
3+
- [Complete](https://github.com/aws-ia/terraform-aws-eks-blueprints-teams/tree/main/tests/complete)

tests/complete/README.md

Lines changed: 54 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,68 @@
1-
# Complete Example
1+
# Amazon EKS Blueprints Addons - Complete
22

3-
TODO
3+
Configuration in this directory creates:
44

5-
Ensure that you have the following tools installed locally:
5+
- An EKS cluster (required to support module/tests)
6+
- A number of addons (see code for full list) deployed via Terraform
67

7-
1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
8-
2. [kubectl](https://Kubernetes.io/docs/tasks/tools/)
9-
3. [terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli)
8+
## Usage
109

11-
## Deploy
12-
13-
To provision this example:
10+
To run this example you need to execute:
1411

1512
```bash
16-
terraform init
17-
terraform apply
13+
$ terraform init
14+
$ terraform plan
15+
$ terraform apply
1816
```
1917

20-
## Validate
18+
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
2119

22-
TODO
20+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
21+
## Requirements
2322

24-
Enter `yes` at command prompt to apply
23+
| Name | Version |
24+
|------|---------|
25+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
26+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.47 |
27+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.8 |
28+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.20 |
2529

26-
## Destroy
30+
## Providers
2731

28-
To teardown and remove the resources created in this example:
32+
| Name | Version |
33+
|------|---------|
34+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.47 |
35+
| <a name="provider_aws.virginia"></a> [aws.virginia](#provider\_aws.virginia) | >= 4.47 |
2936

30-
```bash
31-
terraform destroy -target module.eks_blueprints_kubernetes_addons
32-
terraform destroy
33-
```
37+
## Modules
38+
39+
| Name | Source | Version |
40+
|------|--------|---------|
41+
| <a name="module_adot_irsa"></a> [adot\_irsa](#module\_adot\_irsa) | terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks | ~> 5.14 |
42+
| <a name="module_ebs_csi_driver_irsa"></a> [ebs\_csi\_driver\_irsa](#module\_ebs\_csi\_driver\_irsa) | terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks | ~> 5.14 |
43+
| <a name="module_eks"></a> [eks](#module\_eks) | terraform-aws-modules/eks/aws | ~> 19.13 |
44+
| <a name="module_eks_blueprints_addons"></a> [eks\_blueprints\_addons](#module\_eks\_blueprints\_addons) | ../../ | n/a |
45+
| <a name="module_velero_backup_s3_bucket"></a> [velero\_backup\_s3\_bucket](#module\_velero\_backup\_s3\_bucket) | terraform-aws-modules/s3-bucket/aws | ~> 3.0 |
46+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.0 |
47+
48+
## Resources
49+
50+
| Name | Type |
51+
|------|------|
52+
| [aws_security_group.guardduty](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
53+
| [aws_vpc_endpoint.guardduty](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
54+
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
55+
| [aws_ecrpublic_authorization_token.token](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ecrpublic_authorization_token) | data source |
56+
57+
## Inputs
58+
59+
No inputs.
60+
61+
## Outputs
62+
63+
| Name | Description |
64+
|------|-------------|
65+
| <a name="output_configure_kubectl"></a> [configure\_kubectl](#output\_configure\_kubectl) | Configure kubectl: make sure you're logged in with the correct AWS profile and run the following command to update your kubeconfig |
66+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
3467

35-
Enter `yes` at each command prompt to destroy
68+
Apache-2.0 Licensed. See [LICENSE](https://github.com/aws-ia/terraform-aws-eks-blueprints-addons/blob/main/LICENSE)

0 commit comments

Comments
 (0)