You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -22,6 +21,8 @@ As a new member on the HfLA devops-security team, fill in the following fields a
22
21
23
22
-[ ] Before starting to work on the below instructions, make sure to join the #ops Slack Channel. And are a member of `devops-security` repository.
24
23
-[ ] Self-assign this issue (gear in right side panel).
24
+
-[ ] Select a role label (gear in label section on the right). They begin with "role:". This should be what you want to do in the DevOps CoP
25
+
-[ ] Change the issue status to 'in progress' (right side panel).
25
26
-[ ] Add this issue to the Project Board CoP: DevOps: Project Board - under the Projects section (gear in right side panel).
26
27
-[ ] Attend weekly team meeting, Wednesdays 6-8pm PST.
27
28
-[ ] Note: There are no meetings on the 1st Wednesday of every month.
@@ -41,7 +42,7 @@ As a new member on the HfLA devops-security team, fill in the following fields a
41
42
-[ ] Install Terraform locally by following the instructions of the installation guide mentioned in [Installing Terraform](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#installing-terraform)
42
43
-[ ] Install Terraform Docs locally by following the instructions of the installation guide mentioned in [Installing Terraform docs](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#installing-terraform-docs)
43
44
-[ ] Complete the instructions in [Clone the repository](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#clone-the-repository)
44
-
-[ ] Submit a [new request](https://github.com/hackforla/devops-security/issues/new?assignees=&labels=enhancement&projects=&template=request-aws-iam-resources.yml) to create new AWS user account and then self-assign this issue.
45
+
-[ ] Submit a [new request](https://github.com/hackforla/devops-security/issues/new?assignees=&projects=&template=request-aws-iam-resources.yml) to create new AWS user account and then self-assign this issue.
45
46
-[ ] Create a new branch from main by executing the command
46
47
47
48
```bash
@@ -53,14 +54,14 @@ As a new member on the HfLA devops-security team, fill in the following fields a
53
54
```bash
54
55
# Replace USERNAME with your GitHub handle
55
56
module "iam_user_USERNAME" {
56
-
source = "./modules/aws-users"
57
+
source = "./modules/aws-users"
57
58
58
-
user_name = "USERNAME"# Replace with GitHub handle
59
-
user_tags = {
60
-
"Project" = "devops-security"
61
-
"Access Level" = "1"
62
-
}
63
-
user_groups = ["read-only-group"]
59
+
user_name = "USERNAME"# Replace with GitHub handle
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+31-41Lines changed: 31 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,18 @@ Below are guidelines for contributing to the devops-security repository hosted o
8
8
**The team recommends using [VS Code](https://code.visualstudio.com/download) as the preferred text editor for working on code, but feel free to utilize a text editor of your preference.**
9
9
10
10
**If you have any additional questions about your contribution process, please feel free to reach out to the team in the [#ops](https://hackforla.slack.com/archives/CV7QGL66B) Slack channel.**
11
-
<br><br>
12
-
13
-
## **Table of Contents**
14
-
-[**How to Contribute to DevOps**](#how-to-contribute-to-devops)
15
-
-[**Table of Contents**](#table-of-contents)
16
-
-[**Setting up the local development environment**](#setting-up-the-local-development-environment)
17
-
-[**Creating a personal AWS account**](#creating-a-personal-aws-account)
18
-
-[**Login as root user & setup MFA**](#login-as-root-user-&-setup-mfa)
19
-
-[**Setting up IAM and AWS CLI**](#setting-up-iam-and-aws-cli)
20
-
-[**Create an IAM User**](#create-an-iam-user)
21
-
-[**Create an IAM Group**](#create-an-iam-group)
22
-
-[**Attach IAM user to IAM group**](#attach-iam-user-to-iam-group)
23
-
-[**Attach `AdministratorAccess` policy to IAM group**](#attach-administratoraccess-policy-to-iam-group)
24
-
-[**Generating Access Keys for AWS CLI**](#generating-access-keys-for-aws-cli)
-[**Clone (Create) a copy on your computer**](#clone-create-a-copy-on-your-computer)
29
-
-[**Create a new branch where you will work on your issue**](#create-a-new-branch-where-you-will-work-on-your-issue)
30
-
-[**Creating Local tfvars file**](#creating-local-tfvars-file)
31
-
-[**Terraform Setup and Execution Instructions**](#terraform-setup-and-execution-instructions)
32
-
-[**Submitting changes via git and opening a PR**](#submitting-changes-via-git-and-opening-a-pr)
11
+
12
+
### Overview
13
+
14
+
-[Setting up the local development environment](#setting-up-the-local-development-environment)
15
+
- AWS identity and access management
16
+
- AWS CLI
17
+
- Terraform
18
+
-[Submitting changes via git and opening a PR](#submitting-changes-via-git-and-opening-a-pr)
19
+
20
+
### Table of Contents
21
+
22
+
A generated table of contents is available on GitHub by [opening the outline icon](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#headings) at the top of the markdown preview window.
33
23
34
24
## **Setting up the local development environment**
35
25
The below instructions will walk you through setting up your own AWS account for local development and testing before pushing changes that will effect our infrastructure.
@@ -44,7 +34,7 @@ If you've already completed these steps or you aren't making Terraform changes,
44
34
- Agree to the AWS Customer Agreement and Service Terms, complete the registration by clicking `"Create Account and Continue"`, verify your phone number via text or call, confirm your email address following the instructions in the confirmation email, and finally sign in to access your new AWS account using your email and password.
45
35
- Follow this [video guide](https://youtu.be/CjKhQoYeR4Q?si=78GhlDLV5zZu8qwh) for deeper explanations.
46
36
47
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
37
+
<sub>[Back to Top](#)</sub>
48
38
***
49
39
50
40
### **Login as root user & setup MFA**
@@ -57,7 +47,7 @@ If you've already completed these steps or you aren't making Terraform changes,
57
47
58
48
**Note:** Select the `us-west-2` region. It's not required for managing IAM resources, as they are global. However, it's advisable since our other resources are in the same region.
59
49
60
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
50
+
<sub>[Back to Top](#)</sub>
61
51
***
62
52
63
53
## **Setting up IAM and AWS CLI**
@@ -86,7 +76,7 @@ If you've already completed these steps or you aren't making Terraform changes,
86
76
```
87
77
**Note:** Password length must be 20 characters
88
78
89
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
79
+
<sub>[Back to Top](#)</sub>
90
80
***
91
81
-### **Create an IAM Group**
92
82
@@ -95,7 +85,7 @@ If you've already completed these steps or you aren't making Terraform changes,
95
85
```bash
96
86
aws iam create-group --group-name AdminGroup
97
87
```
98
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
88
+
<sub>[Back to Top](#)</sub>
99
89
***
100
90
-### **Attach IAM user to IAM group**
101
91
@@ -109,7 +99,7 @@ If you've already completed these steps or you aren't making Terraform changes,
109
99
```bash
110
100
aws iam add-user-to-group --group-name AdminGroup --user-name octocat
111
101
```
112
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
102
+
<sub>[Back to Top](#)</sub>
113
103
***
114
104
-### **Attach `AdministratorAccess` policy to IAM group**
115
105
@@ -118,7 +108,7 @@ If you've already completed these steps or you aren't making Terraform changes,
118
108
```bash
119
109
aws iam attach-group-policy --policy-arn arn:aws:iam::aws:policy/AdministratorAccess --group-name AdminGroup
120
110
```
121
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
111
+
<sub>[Back to Top](#)</sub>
122
112
***
123
113
- Log in as the newly created user instead of continuing to log in as the root user.
124
114
-### **Generating Access Keys for AWS CLI**
@@ -133,13 +123,13 @@ If you've already completed these steps or you aren't making Terraform changes,
133
123
```bash
134
124
nano access_key.json
135
125
```
136
-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
126
+
<sub>[Back to Top](#)</sub>
137
127
***
138
128
The below steps must be completed in order to authenticate to AWS locally via the command line interface (CLI):
0 commit comments