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.

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

Document AWS Setup #3641

Merged
merged 4 commits into from
Sep 30, 2023
Merged

Document AWS Setup #3641

merged 4 commits into from
Sep 30, 2023

Conversation

BacLuc
Copy link
Contributor

@BacLuc BacLuc commented Jul 31, 2023

For PR #3640, here is the documentation of the setup (Bucket, Users, Policies, Access Keys).

I chose Pulumi over AWS CDK and TerraForm because it supports typescript which is similar to the js we know (unlike TerraForm which uses a go like syntax) and typescript is first class citizen (unlike AWS CDK) and it supports multiple cloud providers (unlike AWS CDK).

The question here is:

  1. Do we want to document the setup in code?
  2. Do we want to document it in this repo?

docker compose run --rm aws-setup pulumi login s3://ecampcore-pulumi/
docker compose run --rm aws-setup pulumi new aws-typescript --force

Issue: ecamp#3478
@BacLuc
Copy link
Contributor Author

BacLuc commented Sep 12, 2023

Moved everything under a new docs folder.
The 2 services for pulumi and aws-cli are now in a separate docker-compose

@BacLuc BacLuc requested a review from usu September 12, 2023 15:24
Copy link
Member

@carlobeltrame carlobeltrame left a comment

Choose a reason for hiding this comment

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

Normally, I would prefer such documentation in the wiki, where the rest of our documentation lives. Since you have so much code here, I see how it is easier to keep it in the repo. However, I'd prefer not to introduce a docs folder in the repository, because this will lead to confusion about where to put documentation in the future. I'd rather have another top-level directory aws-setup or something similar, or in a completely separate repository as you also proposed.

@BacLuc
Copy link
Contributor Author

BacLuc commented Sep 30, 2023

@carlobeltrame and @usu decided: we move it in .ops

Copy link
Member

@carlobeltrame carlobeltrame left a comment

Choose a reason for hiding this comment

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

As discussed with @BacLuc and @usu, please move this from docs/aws-setup to .ops/aws-setup, and possibly move observability to .ops/observability as well (or we can do that in a separate PR, whatever you prefer). Let's avoid a top-level docs directory for now.

We want to keep documentation in the wiki.
A docs folder would attract users to put documentation there.
Now we have a .ops folder (with a . to indicate that it is less important),
where we can put operations related code.

Issue: ecamp#3478
@BacLuc BacLuc added this pull request to the merge queue Sep 30, 2023
Merged via the queue into ecamp:devel with commit a7b78e9 Sep 30, 2023
24 of 28 checks passed
@BacLuc BacLuc deleted the aws-document-setup branch December 23, 2023 19:13
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.

None yet

3 participants