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

Update Wiki to provide instructions to find AWS resources used in Incubator #39

Open
4 tasks done
JasonEb opened this issue Sep 22, 2022 · 9 comments
Open
4 tasks done
Labels
feature: wiki good first issue Good for newcomers role: Dev Ops Engineer Engineer who maintains and deploys software size: 2pt Can be done in 7-12 hours

Comments

@JasonEb
Copy link
Contributor

JasonEb commented Sep 22, 2022

Overview

image

As a Dev Ops member, I would like to have a glossary or list of all active AWS resources used by Incubator to deploy its apps. These resources can be identified within the Incubator's code in the repo.

CONFIRMATION
As a github user, when I click on Incubator's wiki page, I should see an article AWS Resources

Inside should be a document of a list of aws resources (Route 53, Amazon ECR, etc.) with links or references to their AWS glossary.

Let's also consider linking to the Incubator's terraform service code as well.

Action Items

Resources/Instructions

@JasonEb JasonEb added size: 1pt Can be done in 4-6 hours good first issue Good for newcomers labels Sep 22, 2022
@justinPemberton justinPemberton pinned this issue Sep 22, 2022
@JasonEb JasonEb added size: 2pt Can be done in 7-12 hours and removed size: 1pt Can be done in 4-6 hours labels Oct 2, 2022
@ExperimentsInHonesty
Copy link
Member

@justinPemberton Please provide update

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."
  • remember to add links to the top of the issue if they are going to be needed again.

@JasonEb
Copy link
Contributor Author

JasonEb commented Oct 18, 2022

Currently, that looks well. Now that we collected these calls, I'd like to continue refining https://github.com/hackforla/incubator/wiki/AWS-Resources by organizing the information and the presentation.

Can we sort these resources by aws services? For example, I consolidated ECS and IAM related resources as much as possible.

Afterwords, I'd like each resource to link back to AWS's documentation. So for example, the ECS portion will link against https://docs.aws.amazon.com/AmazonECS/latest/userguide/getting-started.html

@justinPemberton
Copy link
Member

@ExperimentsInHonesty
I have completed the original task now I'm working to make my work more human-readable

@JasonEb
Copy link
Contributor Author

JasonEb commented Oct 26, 2022

Whenever best, please provide an update and let us know if there's anything we can help you with:

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."
  • remember to add links to the top of the issue if they are going to be needed again.

@justinPemberton
Copy link
Member

  1. progress: done
  2. finding the right documentation & resources
  3. Not a lot of time .college applications are due November 1st and midterms are now as well
  4. now

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 14, 2022

@justinPemberton I love what you have done so far.

Jason and I dug into it today and after figuring out what the links went to, we would like to expand the scope of it a bit, so that it's easier for new people (new to GitHub or DevOps) to follow.

We also discovered that you could link directly to the line number. The URLs I put in the last column of the table below demonstrate that. Those URLS are built using the formula in the spreadsheet =CONCATENATE(File URL,"#L",Line Number)

Please

  1. I've mocked up and added the ECS section information to a spreadsheet: AWS Resources. Please organize the information in any way that makes sense (I just guessed at the Column headings).
  2. Copy your content from the wiki page https://github.com/hackforla/incubator/wiki/AWS-Resources and put it into this spreadsheet.
  3. Once you populate it with information for each section, you can copy it back to the wiki using this Markdown converter
  4. Then it will look something like this
Service Name Instance Name Descriptive Name Type File Name File URL Line Number Line URL
ECS ecs ecs task definition & task task task_definition.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/service/task_definition.tf 58 https://github.com/hackforla/incubator/blob/main/terraform-modules/service/task_definition.tf#L58
ECS fargate ecs service & fargate service fargate.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/service/fargate.tf 1 https://github.com/hackforla/incubator/blob/main/terraform-modules/service/fargate.tf#L1
ECS ec2 ecs service & ec2 service ecs_ec2.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/service/ecs_ec2.tf 2 https://github.com/hackforla/incubator/blob/main/terraform-modules/service/ecs_ec2.tf#L2
ECS ec2 ecs service & ec2 service ecs_ec2.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/service/ecs_ec2.tf 2 https://github.com/hackforla/incubator/blob/main/terraform-modules/service/ecs_ec2.tf#L2
ECS ecs ecs task definition & task task main.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/redis/main.tf 10 https://github.com/hackforla/incubator/blob/main/terraform-modules/redis/main.tf#L10
ECS ecs ecs service & svc service main.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/redis/main.tf 21 https://github.com/hackforla/incubator/blob/main/terraform-modules/redis/main.tf#L21
ECS ecs ecs cluster & cluster cluster main.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/ecs/main.tf 2 https://github.com/hackforla/incubator/blob/main/terraform-modules/ecs/main.tf#L2
ECS ecs ecs capacity provider & this repository main.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/ecs/main.tf 15 https://github.com/hackforla/incubator/blob/main/terraform-modules/ecs/main.tf#L15
ECS ecr ecr repository & this repository main.tf https://github.com/hackforla/incubator/blob/main/terraform-modules/ecr/main.tf 20 https://github.com/hackforla/incubator/blob/main/terraform-modules/ecr/main.tf#L20

@JasonEb
Copy link
Contributor Author

JasonEb commented Jan 29, 2023

@justinPemberton whenever good, let's revisit this issue and see if we should break the next steps into a ticket and conclude this one.

@robinglov
Copy link
Member

This issue has been superceded by #59 , which will document. However, will still need a Wiki article to explain once Terraform docs has given us the module outputs.

@github-project-automation github-project-automation bot moved this to New Issue Review in CoP: DevOps: Project Board Jun 27, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Review to Ice Box in CoP: DevOps: Project Board Jun 27, 2024
@sudhara sudhara changed the title Create Glossary of AWS resources used in Incubator Create a list of AWS resources used in Incubator Aug 22, 2024
@sudhara
Copy link
Member

sudhara commented Aug 22, 2024

This is self-documented in Terraform but we will update the wiki instructions to how to find it.

@chelseybeck chelseybeck changed the title Create a list of AWS resources used in Incubator Update Wiki to provide instructions to find AWS resources used in Incubator Sep 19, 2024
@sudhara sudhara removed the dependency label Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature: wiki good first issue Good for newcomers role: Dev Ops Engineer Engineer who maintains and deploys software size: 2pt Can be done in 7-12 hours
Projects
Status: Prioritized Backlog
Development

No branches or pull requests

5 participants