Add doc for share environments #193

tei-k · 2020-08-28T05:05:05Z

Description

https://scalar-labs.atlassian.net/browse/DLT-7061

Done

Added doc

scalar-boney

Thank you
I left some small comments.

scalar-boney · 2020-08-28T08:24:36Z

docs/ShareEnvironment.md

+
+## Get a public/private key-pair from the person who built the environment
+
+:memo: Also need all the tfsatte files when using `local` backend


Small spelling mistake in tfsatte.
Expected tfstate

Thanks! fixed in e6261d1.

scalar-boney · 2020-08-28T08:25:39Z

docs/ShareEnvironment.md

+  private_key_path = "./example_key"
+  ```
+
+- Update the output value `private_key_path` and `public_key_path` of tfsate


Small spelling mistake in tfsatte.
Expected tfstate

scalar-boney

LGTM!
Thank you

feeblefakie

Left some suggestions on the explanation.

I have one question.
By doing this, an engineer who deployed an environment first can still have access to the environment?
In other words, is it for sharing or delegating?

feeblefakie · 2020-08-31T00:51:53Z

docs/ShareEnvironment.md

@@ -0,0 +1,35 @@
+# How to share environment with others


Suggested change

# How to share environment with others

# How to share environments with others

feeblefakie · 2020-08-31T00:57:09Z

docs/ShareEnvironment.md

@@ -0,0 +1,35 @@
+# How to share environment with others
+
+This explanation is for multiple person operating in the same environment.


Suggested change

This explanation is for multiple person operating in the same environment.

Non-testing environments tend to be shared and operated with multiple DevOps engineers.

This document explains how to do it properly.

feeblefakie · 2020-08-31T00:59:54Z

docs/ShareEnvironment.md

+
+This explanation is for multiple person operating in the same environment.
+
+## Get a public/private key-pair from the person who built the environment


Suggested change

## Get a public/private key-pair from the person who built the environment

## Get a private key from the person who has built an environment.

Since we can just generate a corresponding public key, I deleted the statement.

feeblefakie · 2020-08-31T01:04:23Z

docs/ShareEnvironment.md

+
+## Get a public/private key-pair from the person who built the environment
+
+:memo: Also need all the tfstate files when using `local` backend


Suggested change

:memo: Also need all the tfstate files when using `local` backend

You can generate a corresponding public key with `ssh-keygen -yf ~/.ssh/privatekey.pem > publickey.pem`.

If an environment is created with `local` backend, you need all the tfstate files additionally. But, as a best practice, it's better to use cloud storage backends such as AWS S3 or Azure Blob Storage for an environment that is shared among multiple engineers.

feeblefakie · 2020-08-31T01:06:50Z

docs/ShareEnvironment.md

+
+## Update the tfstate of the network module
+
+- Fix key_path of `example.tfvars` in your local


Suggested change

- Fix key_path of `example.tfvars` in your local

Update the key paths of `tfvars` file in your local such as `example.tfvars` in the example.

feeblefakie · 2020-08-31T01:08:37Z

docs/ShareEnvironment.md

+
+## Update the tfstate of the network module
+
+- Fix key_path of `example.tfvars` in your local


Overall it's weird to talk about example because it's not the case mostly.

feeblefakie · 2020-08-31T05:26:37Z

docs/ShareEnvironment.md

+  private_key_path = "./example_key"
+  ```
+
+- Update the output value `private_key_path` and `public_key_path` of tfstate


Suggested change

- Update the output value `private_key_path` and `public_key_path` of tfstate

Then, update tfstate file as follows.

feeblefakie · 2020-08-31T05:27:44Z

docs/ShareEnvironment.md

+- Update the output value `private_key_path` and `public_key_path` of tfstate
+
+  ```
+  cd example/[aws|azure]/network


Suggested change

cd example/[aws|azure]/network

cd /path/to/network-module

feeblefakie · 2020-08-31T05:28:02Z

docs/ShareEnvironment.md

+  terraform refresh -var-file=example.tfvars
+  ```
+
+## Update the tfstate of the cassandra, scalardl and monitor modules


Suggested change

## Update the tfstate of the cassandra, scalardl and monitor modules

## Update the tfstate of the cassandra, scalardl, and monitor modules

feeblefakie · 2020-08-31T05:35:56Z

docs/ShareEnvironment.md

+
+## Update the tfstate of the cassandra, scalardl and monitor modules
+
+- Update the value `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate


Suggested change

- Update the value `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate

Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.

feeblefakie · 2020-09-01T00:54:28Z

@tei-k I've given some suggestions but are they correct?

Also, how about this?

I have one question.
By doing this, an engineer who deployed an environment first can still have access to the environment?
In other words, is it for sharing or delegating?

tei-k · 2020-09-01T01:01:17Z

By doing this, an engineer who deployed an environment first can still have access to the environment?
In other words, is it for sharing or delegating?

@feeblefakie
Because can still have access to it, so it's for sharing.

feeblefakie · 2020-09-01T11:48:03Z

docs/ShareEnvironment.md

+
+## Update the tfstate of the cassandra, scalardl, and monitor modules
+
+Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.


I'm testing with psim environment but I don't have tfstate file.
Do we need to pull ?

The tfstate file in the psim environment is on s3, so you don't need to pull it to local.

Ok, this line applies only for local backend. How about the following commands? They need to be done whether or not local?
Anyways, I think it requires some updates.

They need to be done whether or not local?

Yes, This is necessary regardless of the back-end type. (not only for local)

feeblefakie · 2020-09-02T04:37:47Z

docs/ShareEnvironment.md

+
+## Get a private key from the person who has built an environment.
+
+You can generate a corresponding public key with `ssh-keygen -yf ~/.ssh/privatekey.pem > publickey.pem`.


Suggested change

You can generate a corresponding public key with `ssh-keygen -yf ~/.ssh/privatekey.pem > publickey.pem`.

First of all, please get a private key that is used to build an environment by the person who did it.

You can generate a corresponding public key with `ssh-keygen -yf ~/.ssh/privatekey.pem > publickey.pem`.

Here we assume we have `/path/to/privatekey.pem` and `/path/to/publickey.pub`.

feeblefakie · 2020-09-02T04:38:02Z

docs/ShareEnvironment.md

+Update the key paths of `tfvars` file in your local such as `example.tfvars` in the example.
+
+```
+public_key_path = "./publickey.pem"


Suggested change

public_key_path = "./publickey.pem"

public_key_path = "/path/to/publickey.pem"

feeblefakie · 2020-09-02T04:38:12Z

docs/ShareEnvironment.md

+```
+public_key_path = "./publickey.pem"
+
+private_key_path = "./privatekey.pem"


Suggested change

private_key_path = "./privatekey.pem"

private_key_path = "/path/to/privatekey.pem"

docs/ShareEnvironment.md

feeblefakie · 2020-09-02T06:18:57Z

docs/ShareEnvironment.md

+
+## Update the tfstate of the cassandra, scalardl, and monitor modules
+
+Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.


Suggested change

Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.

Then, do the following to reflect the above changes to each module.

tei-k · 2020-09-02T07:13:55Z

@feeblefakie
Thank you for the many suggestions. fixed in c35cfd2.

docs/ShareEnvironment.md

feeblefakie

LGTM! Thanks!

feeblefakie · 2020-09-03T00:38:29Z

@ymorimo I'll merge it but please take a glance when you get a chance.

ymorimo

LGTM!

Add doc for share environments

b358367

tei-k self-assigned this Aug 28, 2020

tei-k added 2 commits August 28, 2020 14:06

Fix format

4f7594b

Fix some

fd55710

tei-k changed the title ~~[WIP] Add doc for share environments~~ Add doc for share environments Aug 28, 2020

tei-k requested review from feeblefakie, scalar-boney and ymorimo August 28, 2020 06:01

Fix update value

2fe28ae

scalar-boney reviewed Aug 28, 2020

View reviewed changes

Fix spell miss

e6261d1

scalar-boney previously approved these changes Aug 31, 2020

View reviewed changes

feeblefakie reviewed Aug 31, 2020

View reviewed changes

Fix suggestions

90e3abf

tei-k dismissed scalar-boney’s stale review via 90e3abf September 1, 2020 00:51

feeblefakie reviewed Sep 1, 2020

View reviewed changes

feeblefakie reviewed Sep 2, 2020

View reviewed changes

Fix suggestions 2

c35cfd2

Update docs/ShareEnvironment.md

df9173f

feeblefakie reviewed Sep 3, 2020

View reviewed changes

docs/ShareEnvironment.md Outdated Show resolved Hide resolved

docs/ShareEnvironment.md Outdated Show resolved Hide resolved

docs/ShareEnvironment.md Outdated Show resolved Hide resolved

docs/ShareEnvironment.md Outdated Show resolved Hide resolved

feeblefakie added 4 commits September 3, 2020 09:26

Update docs/ShareEnvironment.md

6d478d7

Update docs/ShareEnvironment.md

1c8786c

Update docs/ShareEnvironment.md

2c63ab5

Update docs/ShareEnvironment.md

02f9b2f

feeblefakie approved these changes Sep 3, 2020

View reviewed changes

feeblefakie merged commit 49f28b8 into master Sep 3, 2020

feeblefakie deleted the add-doc-for-share-environments branch September 3, 2020 00:38

ymorimo reviewed Sep 4, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add doc for share environments #193

Add doc for share environments #193

tei-k commented Aug 28, 2020 •

edited

Loading

scalar-boney left a comment •

edited

Loading

scalar-boney Aug 28, 2020

tei-k Aug 28, 2020

scalar-boney Aug 28, 2020

tei-k Aug 28, 2020

scalar-boney left a comment

feeblefakie left a comment •

edited

Loading

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie Aug 31, 2020

feeblefakie commented Sep 1, 2020

tei-k commented Sep 1, 2020

feeblefakie Sep 1, 2020

tei-k Sep 2, 2020

feeblefakie Sep 2, 2020

tei-k Sep 2, 2020

feeblefakie Sep 2, 2020

feeblefakie Sep 2, 2020

feeblefakie Sep 2, 2020

feeblefakie Sep 2, 2020

tei-k commented Sep 2, 2020

feeblefakie left a comment

feeblefakie commented Sep 3, 2020

ymorimo left a comment


		## Get a public/private key-pair from the person who built the environment

		:memo: Also need all the tfsatte files when using `local` backend

	# How to share environment with others
	# How to share environments with others

		@@ -0,0 +1,35 @@
		# How to share environment with others

		This explanation is for multiple person operating in the same environment.

	This explanation is for multiple person operating in the same environment.
	Non-testing environments tend to be shared and operated with multiple DevOps engineers.
	This document explains how to do it properly.

	## Get a public/private key-pair from the person who built the environment
	## Get a private key from the person who has built an environment.


		## Get a public/private key-pair from the person who built the environment

		:memo: Also need all the tfstate files when using `local` backend


		## Update the tfstate of the network module

		- Fix key_path of `example.tfvars` in your local

	- Fix key_path of `example.tfvars` in your local
	Update the key paths of `tfvars` file in your local such as `example.tfvars` in the example.

	- Update the output value `private_key_path` and `public_key_path` of tfstate
	Then, update tfstate file as follows.

	## Update the tfstate of the cassandra, scalardl and monitor modules
	## Update the tfstate of the cassandra, scalardl, and monitor modules


		## Update the tfstate of the cassandra, scalardl and monitor modules

		- Update the value `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate

	- Update the value `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate
	Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.


		## Get a private key from the person who has built an environment.

		You can generate a corresponding public key with `ssh-keygen -yf ~/.ssh/privatekey.pem > publickey.pem`.

	public_key_path = "./publickey.pem"
	public_key_path = "/path/to/publickey.pem"

	private_key_path = "./privatekey.pem"
	private_key_path = "/path/to/privatekey.pem"

	Update the values of `private_key_path` and `public_key_path` of `data.terraform_remote_state.network` in each tfstate and do as follows.
	Then, do the following to reflect the above changes to each module.

Add doc for share environments #193

Add doc for share environments #193

Conversation

tei-k commented Aug 28, 2020 • edited Loading

Description

Done

scalar-boney left a comment • edited Loading

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

scalar-boney left a comment

Choose a reason for hiding this comment

feeblefakie left a comment • edited Loading

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

feeblefakie commented Sep 1, 2020

tei-k commented Sep 1, 2020

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

tei-k commented Sep 2, 2020

feeblefakie left a comment

Choose a reason for hiding this comment

feeblefakie commented Sep 3, 2020

ymorimo left a comment

Choose a reason for hiding this comment

tei-k commented Aug 28, 2020 •

edited

Loading

scalar-boney left a comment •

edited

Loading

feeblefakie left a comment •

edited

Loading