docs: add environment storage into v1.26.0 blog post by Lou1415926 · Pull Request #4511 · aws/copilot-cli

Lou1415926 · 2023-02-16T21:14:50Z

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.

huanjani · 2023-02-16T21:18:37Z


 ## `storage init` for environment addons

+Previously, `copilot storage init` only supports storage addon that is attached to your workload: 


Suggested change

Previously, `copilot storage init` only supports storage addon that is attached to your workload:

Previously, `copilot storage init` only supported storage addons attached to workloads:

Also, can we take out the newline to match the "Now" section?

The newline isn't rendered as a new line! It takes two consecutive newline to render a real new line.

github-actions · 2023-02-16T21:24:04Z

🍕 Here are the new binary sizes!

Name	New size (kiB)	size (kiB)	Delta (%)
macOS (amd)	48984	48440	🥺 +1.12
macOS (arm)	49644	49108	🥺 +1.09
linux (amd)	43092	42608	🥺 +1.14
linux (arm)	42436	41924	🥺 +1.22
windows (amd)	39812	39368	🥺 +1.13

codecov-commenter · 2023-02-16T21:28:17Z

Codecov Report

Merging #4511 (cb4ade8) into mainline (c1187e7) will decrease coverage by 0.01%.
The diff coverage is 50.00%.

@@             Coverage Diff              @@
##           mainline    #4511      +/-   ##
============================================
- Coverage     69.94%   69.93%   -0.01%     
============================================
  Files           266      266              
  Lines         38334    38338       +4     
  Branches        268      268              
============================================
- Hits          26813    26812       -1     
- Misses        10225    10230       +5     
  Partials       1296     1296

Impacted Files	Coverage Δ
internal/pkg/cli/storage_init.go	`68.15% <50.00%> (-0.19%)`	⬇️
...ternal/pkg/deploy/cloudformation/cloudformation.go	`72.77% <0.00%> (-0.53%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

iamhopaul123 · 2023-02-16T23:28:36Z

+when you run `copilot svc delete`.
+
+Now, you have the option to create environment-level storage addons: the storage is deployed when you run `copilot env deploy`,
+and isn't deleted until you delete the whole environment by running `copilot env delete`.


Suggested change

and isn't deleted until you delete the whole environment by running `copilot env delete`.

and won't be deleted until you delete the environment by running `copilot env delete`.

removed the "whole". I kept "isn't" though since it was suggested by #4511 (comment) and looks cleaner

iamhopaul123 · 2023-02-16T23:31:58Z

+Now, you have the option to create environment-level storage addons: the storage is deployed when you run `copilot env deploy`,
+and isn't deleted until you delete the whole environment by running `copilot env delete`.
+
+Similar to the workload-level storage, the environment-level storage is, under the hood, just another [environment addon](../docs/developing/addons/environment.en.md)!


Maybe consider removing it as we use "addons" everywhere?

Boss not sure I follow! Do you mean moving the link to other places or completely removing the link from the blog? It it's the latter, I'm not sure because I feel like a link to env addons would be helpful 🤔

Yeah I think we can keep the link like "Now, you have the option to create environment-level storage addons: the storage..."

I do feel like keeping the link in this place flows better 🤔 🤔 😓

"Now, you have the option to create environment-level storage addons: the storage..."

People would be disrupted to click into another link in the middle of a sentence.

Whereas

Similar to the workload storage, the environment storage is, under the hood, just another environment addon!

People will know to investigate what "environment addons" is after having a general/vague understanding of what "environment storage" is compared to "workload storage"

iamhopaul123 · 2023-02-16T23:36:06Z

+Similar to the workload-level storage, the environment-level storage is, under the hood, just another [environment addon](../docs/developing/addons/environment.en.md)!
+
+### Best Practice By Default
+Following the best practice in the microservice world, Copilot encourages you to set up storages that are each accessible


Would be great to give a link for "best practice in the microservice world" 🤔

### [Database-Per-Service](https://docs.aws.amazon.com/prescriptive-guidance/latest/modernization-data-persistence/database-per-service.html) By Default In the microservice world, it is generally recommended to set up data storages that are each private to a microservices, instead of monolith storages that are shared by multiple services. This pattern preserves the core characteristics of microservices - loose coupling. Copilot encourages you to follow this database-per-service pattern. By default, a storage resource that Copilot generates is assumed to be accessed by one service or job. !!!note "" However, each product has its own unique situation. If you do need your data storage to be shared by multiple service, you can modify the CloudFormation template that Copilot generates for you to achieve your goal.

Changed it to ⬆️. I realized that saying it as "the" best practice may sound arrogant 😓 . Plus there might be legit situation where people do need to share the database.

iamhopaul123 · 2023-02-16T23:37:26Z

+that your storage is designed to be accessed by one of your services or jobs, even when it is meant to live and die
+with the environment. 


Suggested change

that your storage is designed to be accessed by one of your services or jobs, even when it is meant to live and die

with the environment.

that your storage is designed to be accessed by one of your services or jobs, even when it shares the same lifecycle with the environment.

I removed the whole clause about "even when it shares the same lifecycle with the environment.". Figured it might help nothing but adding confusion

iamhopaul123 · 2023-02-16T23:39:18Z

+
+After you've answered all the prompts or skipped them by flags, Copilot will generate the CloudFormation template that defines the DynamoDB storage
+under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here, one that grants "api" service 
+access to the "movies" storage. The access policy is created as a workload-level addon that lives and dies with your service.


Suggested change

access to the "movies" storage. The access policy is created as a workload-level addon that lives and dies with your service.

access to the "movies" storage. The access policy is created as a workload-level addon.

Changed it to "The access policy is created as a workload addon, meaning that it is deployed and
deleted at the same time as the "api" service."

huanjani · 2023-02-17T22:00:22Z

+--name "movies" \
+--lifecycle "environment"
+```
+


Love the prompts and flags explanation/demo!

huanjani · 2023-02-17T22:01:59Z

+```
+
+After you've answered all the prompts or skipped them by flags, Copilot will generate the CloudFormation template that defines the DynamoDB storage
+under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here, one that grants "api" service 


Suggested change

under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here, one that grants "api" service

under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here is one that grants "api" service

Also, do we refer to Copilot as "it" elsewhere? 🤔

This is the only place in this section where we do this. Hopefully from the sentence that precedes, it's clear that "it" means Copilot 🤔 ?

Or what do you think of

After you've answered all the prompts or skipped them by flags, Copilot will generate two CloudFormation template. One that defines the DynamoDB storage under your "copilot/environments" directory, the other that grants "api" service access to the "movies" storage. The access policy is created as a workload addon, meaning that it is deployed and deleted at the same time as the "api" service.

Co-authored-by: Janice Huang <60631893+huanjani@users.noreply.github.com>

…15926/copilot-cli into blog/post/v1.26.0/env/storage/init

efekarakus

Awesome!

Lou1415926 added 2 commits February 16, 2023 15:13

storage prompt

aaa6be3

blog post;

4106d85

Lou1415926 requested a review from a team as a code owner February 16, 2023 21:14

Lou1415926 requested review from KollaAdithya and removed request for a team February 16, 2023 21:14

do not use tab;

23e612d

Lou1415926 added the WIP Pull requests that are being modified now. label Feb 16, 2023

huanjani reviewed Feb 16, 2023

View reviewed changes

Lou1415926 added 2 commits February 16, 2023 16:55

include flags and other updates

69ca61c

addr fb: batch

d335396

iamhopaul123 reviewed Feb 16, 2023

View reviewed changes

Lou1415926 removed the WIP Pull requests that are being modified now. label Feb 17, 2023

Lou1415926 added 5 commits February 17, 2023 10:32

addr fb: remove "whole"

57cf003

remove clause about lifecycle

6641a6a

elaborate access policy as a swkld addon

4f4752f

remove wordings like env/wkld-level storage

75f5270

reword best practice

1619d0f

huanjani reviewed Feb 17, 2023

View reviewed changes

Lou1415926 and others added 4 commits February 17, 2023 16:27

fix a bunch of indentation;

42a9416

Apply suggestions from code review

64bdc3b

Co-authored-by: Janice Huang <60631893+huanjani@users.noreply.github.com>

addr fb: code quote

a5cd60b

Merge branch 'blog/post/v1.26.0/env/storage/init' of github.com:Lou14…

7ce8e43

…15926/copilot-cli into blog/post/v1.26.0/env/storage/init

efekarakus approved these changes Feb 20, 2023

View reviewed changes

iamhopaul123 approved these changes Feb 20, 2023

View reviewed changes

Merge branch 'mainline' into blog/post/v1.26.0/env/storage/init

cb4ade8

mergify Bot merged commit 3c212fb into aws:mainline Feb 20, 2023


		## `storage init` for environment addons

		Previously, `copilot storage init` only supports storage addon that is attached to your workload:

	and isn't deleted until you delete the whole environment by running `copilot env delete`.
	and won't be deleted until you delete the environment by running `copilot env delete`.

		that your storage is designed to be accessed by one of your services or jobs, even when it is meant to live and die
		with the environment.

	access to the "movies" storage. The access policy is created as a workload-level addon that lives and dies with your service.
	access to the "movies" storage. The access policy is created as a workload-level addon.

	under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here, one that grants "api" service
	under your "copilot/environments" directory. In addition, it will generate the necessary access policy; here is one that grants "api" service

Conversation

Lou1415926 commented Feb 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lou1415926 Feb 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efekarakus left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Feb 16, 2023 •

edited

Loading

codecov-commenter commented Feb 16, 2023 •

edited

Loading

Lou1415926 Feb 17, 2023 •

edited

Loading