Skip to content

Update readme files #399

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.

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

Merged

Conversation

daniel-cit
Copy link
Contributor

Update/Fix issue in README files:

  • Markdown lint fixes
  • Added missing links to inner READMEs that have the variables explanation
  • Fixed typos
  • Alternative instructions to obtain the service perimeter names in 4-projects.

@daniel-cit daniel-cit requested a review from a team as a code owner March 30, 2021 04:45
Copy link
Member

@bharathkkb bharathkkb left a comment

Choose a reason for hiding this comment

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

LGTM
/cc @rjerrems for another pair of eyes

1-org/README.md Outdated
1. Check if your organization already has a Access Context Manager Policy `gcloud access-context-manager policies list --organization YOUR-ORGANIZATION_ID --format="value(name)"`.
1. Rename `./envs/shared/terraform.example.tfvars` to `./envs/shared/terraform.tfvars` and update the file with values from your environment and bootstrap (you can re-run `terraform output` in the 0-bootstrap directory to find these values). Make sure that `default_region` is set to a valid [BigQuery dataset region](https://cloud.google.com/bigquery/docs/locations). Also if the previous step showed a numeric value, make sure to un-comment the variable `create_access_context_manager_access_policy = false`.
1. Check if your organization already has a Access Context Manager Policy `gcloud access-context-manager policies list --organization YOUR_ORGANIZATION_ID --format="value(name)"`.
1. Rename `./envs/shared/terraform.example.tfvars` to `./envs/shared/terraform.tfvars` and update the file with values from your environment and bootstrap step (you can re-run `terraform output` in the 0-bootstrap directory to find these values, the `terraform_service_account` variable is the bootstrap `terraform_sa_email` output). Make sure that `default_region` is set to a valid [BigQuery dataset region](https://cloud.google.com/bigquery/docs/locations). Also if the previous step showed a numeric value, make sure to un-comment the variable `create_access_context_manager_access_policy = false`. See the shared folder [README.md](./envs/shared/README.md) for additional information on the values in the `terraform.tfvars` file.
Copy link
Member

Choose a reason for hiding this comment

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

the terraform_service_account variable is the bootstrap terraform_sa_email output

Can we standardize this to one, maybe terraform_service_account throughout

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @bharathkkb this change would be to replace terraform_sa_email with terraform_service_account in all the code?

This change would touch these files:

  • terraform-example-foundation/0-bootstrap/outputs.tf
  • terraform-example-foundation/0-bootstrap/README.md
  • terraform-example-foundation/0-bootstrap/modules/jenkins-agent/README.md
  • terraform-example-foundation/0-bootstrap/modules/jenkins-agent/variables.tf
  • terraform-example-foundation/1-org/README.md
  • terraform-example-foundation/test/network_test_prepare.sh
  • terraform-example-foundation/test/fixtures/bootstrap/outputs.tf
  • terraform-example-foundation/test/fixtures/envs/main.tf
  • terraform-example-foundation/test/fixtures/envs/variables.tf
  • terraform-example-foundation/test/fixtures/networks/main.tf
  • terraform-example-foundation/test/fixtures/networks/variables.tf
  • terraform-example-foundation/test/fixtures/org/main.tf
  • terraform-example-foundation/test/fixtures/org/variables.tf
  • terraform-example-foundation/test/fixtures/projects/main.tf
  • terraform-example-foundation/test/fixtures/projects/variables.tf
  • terraform-example-foundation/test/fixtures/shared/main.tf
  • terraform-example-foundation/test/fixtures/shared/variables.tf
  • terraform-example-foundation/test/integration/bootstrap/inspec.yml
  • terraform-example-foundation/test/integration/bootstrap/controls/gcp_bootstrap.rb
  • terraform-example-foundation/test/setup/outputs.tf

OR

Would it be to duplicate the terraform output in the 0-bootstrap step like it was done in the test setup outputs.tf file

output "terraform_sa_email" {

output "terraform_sa_email" {
  value = google_service_account.int_test.email
}

output "terraform_service_account" {
  value = google_service_account.int_test.email
}

Copy link
Member

Choose a reason for hiding this comment

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

@daniel-cit so anything in test/* is not user facing and we can change. Then the only user facing change is in the output in 0-bootstrap and aligning it with the rest of the inputs makes sense. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

SG

@daniel-cit daniel-cit force-pushed the update-readme-files branch from 763949a to abc54b1 Compare April 1, 2021 02:31
@daniel-cit daniel-cit changed the base branch from develop to master April 1, 2021 02:32
@daniel-cit
Copy link
Contributor Author

@bharathkkb I switched base to main branch and rebased the code

@daniel-cit daniel-cit requested a review from bharathkkb April 1, 2021 02:34
@bharathkkb bharathkkb merged commit d1f29c3 into terraform-google-modules:master Apr 1, 2021
@daniel-cit daniel-cit deleted the update-readme-files branch May 20, 2022 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants