Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds documentation for the IAM module #48

Merged
merged 1 commit into from
Mar 6, 2020
+26 −0
Merged

Adds documentation for the IAM module #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions modules/iam/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# IAM module

This module configures the IAM roles needed to run an EKS cluster.

# Features

* Configures a service role to be assumed by an EKS cluster.
* Configures a role and instance profile for use by EC2 worker nodes.


This module outputs a config object that may be used to configure the cluster module's `iam_config` variable.

# Usage

```hcl
module "iam" {
source = "cookpad/eks/aws//modules/iam"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the meaning of the double slash in this context ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just how you reference submodules that are hosted on Terraform Registry ...

See https://registry.terraform.io/modules/errm/test/aws/0.0.3/submodules/cheese as an example!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.terraform.io/docs/modules/sources.html#modules-in-package-sub-directories

}

module "cluster" {
source = "cookpad/eks/aws//modules/cluster"
name = "sal-9000"
iam_config = module.iam.config
...
}
```