Update documentation #5

drama17 · 2017-08-24T11:44:25Z

What

Update README.md

Why

Changes requested in https://app.asana.com/0/386406220258003/413152127654288

const-bon · 2017-08-24T12:12:08Z

README.md

@@ -24,19 +24,30 @@ module "admin_tier" {
  stage                       = "${var.stage}"
  subnets                     = ["${var.subnets}"]
  zone_id                     = "${module.tf_domain.zone_id}"
+  security_groups             = ["${var.security_groups}"]
+  associate_public_ip_address = "${var.associate_public_ip_address}"
 }

 ```

 This will create a `id`, `fqdn`, `security_group_id`, `role` and `public_ip`.


id, fqdn, security_group_id, role and public_ip are outputs, but not created resources.
Delete it, as we have tf_admin purpose description at the top and outputs description at the bottom.

const-bon · 2017-08-24T12:13:56Z

README.md

+
+`tf_admin` uses `tf_hostname` to create a DNS record for created host. `tf_hostname` module needs `zone_id` parameter as an input, and this parameter actually is an output from `tf_domain`
+
+That is why `tf_domain` should be implemented in `root` module when we need `tf_admin`


That is why tf_domain should be implemented in root TF manifest when we need tf_admin

Not agree, need to discuss

What are you against of?

const-bon · 2017-08-24T12:18:27Z

README.md

@@ -67,17 +78,18 @@ resource "aws_ami_from_instance" "example" {
 | `security_groups`            | []             | List of Security Group IDs allowed to connect to creating instance        | Yes |
 | `subnets`                    | []             | List of VPC Subnet IDs creating instance launched in                      | Yes |
 | `zone_id`                    | ``             | ID of the domain zone to use - is a result of tf_domain output            | Yes |
+| `associate_public_ip_address`| `true`         | Define if the `public_ip` will be created for the instance                | No  |


Get description of associate_public_ip_address in tf_instance.

@comeanother please add more details what do you need me to change here

Navigate to tf_instance

Copy description of associate_public_ip_address in tf_instance

Paste it into tf_admin associate_public_ip_address description.

const-bon · 2017-08-24T12:18:46Z

README.md

+| Name                | Decription                                                        |
+|:-------------------:|:-----------------------------------------------------------------:|
+| `id`                | Disambiguated ID                                                  |
+| `fqdn`              | Normalized name                                                   |


fqdn is not only Normalized name

@comeanother So you mean I need to decrypt fqdn as 'Fully Qualified Domain Name'?

Let's say DNS name (Fully Qualified Domain Name) of creating instance

const-bon · 2017-08-24T12:18:59Z

README.md

+|:-------------------:|:-----------------------------------------------------------------:|
+| `id`                | Disambiguated ID                                                  |
+| `fqdn`              | Normalized name                                                   |
+| `public_ip`         | Normalized namespace                                              |


public_ip is not a Normalized namespace

Of course not. Fixed

osterman · 2017-08-24T17:32:47Z

README.md

+
+`tf_admin` uses `tf_hostname` to create a DNS record for created host. `tf_hostname` module needs `zone_id` parameter as an input, and this parameter actually is an output from `tf_domain`
+
+That is why `tf_domain` should be implemented in `root` TF manifest when we need `tf_admin`


Missing ending .

osterman · 2017-08-24T17:32:57Z

README.md


-This module depends on these modules:
+Module `tf_admin` requires another module to be used additionally - `tf_domain`


Missing ending .

osterman · 2017-08-24T17:33:15Z

README.md

-This module depends on these modules:
+Module `tf_admin` requires another module to be used additionally - `tf_domain`
+
+`tf_admin` uses `tf_hostname` to create a DNS record for created host. `tf_hostname` module needs `zone_id` parameter as an input, and this parameter actually is an output from `tf_domain`


missing ending .

osterman · 2017-08-24T17:34:06Z

README.md

-| `public_ip`         | Normalized namespace    |
-| `ssh_key_pair`      | Name of used AWS SSH key|
+| Name                | Decription                                                        |
+|:-------------------:|:-----------------------------------------------------------------:|


I prefer :---- to :----:. Use :---: for default values and required. Use :---- for everything else.

This row is still wrong.

Edited README.md

14efc65

drama17 self-assigned this Aug 24, 2017

drama17 requested a review from const-bon August 24, 2017 11:44

const-bon suggested changes Aug 24, 2017

View reviewed changes

Add more edits

f82d0f1

osterman reviewed Aug 24, 2017

View reviewed changes

SweetOps added 3 commits September 1, 2017 14:54

added missed dots

a9d2f10

reworked table in README

e4b397a

reworked table for outputs

d664399

osterman approved these changes Sep 5, 2017

View reviewed changes

const-bon mentioned this pull request Sep 6, 2017

Use Markdown in README #8

Closed

const-bon approved these changes Sep 6, 2017

View reviewed changes

const-bon merged commit 94cc1d1 into master Sep 6, 2017

const-bon deleted the readme_v2 branch September 6, 2017 17:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation #5

Update documentation #5

drama17 commented Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

const-bon Aug 24, 2017

drama17 Aug 24, 2017

osterman Aug 24, 2017

osterman Aug 24, 2017

osterman Aug 24, 2017

osterman Aug 24, 2017 •

edited

Loading

osterman Aug 24, 2017

osterman Sep 1, 2017


		`tf_admin` uses `tf_hostname` to create a DNS record for created host. `tf_hostname` module needs `zone_id` parameter as an input, and this parameter actually is an output from `tf_domain`

		That is why `tf_domain` should be implemented in `root` module when we need `tf_admin`


		This module depends on these modules:
		Module `tf_admin` requires another module to be used additionally - `tf_domain`

Update documentation #5

Update documentation #5

Conversation

drama17 commented Aug 24, 2017

What

Why

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

osterman Aug 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

osterman Aug 24, 2017 •

edited

Loading