Skip to content

Commit

Permalink
updated docs in need of review (#6059)
Browse files Browse the repository at this point in the history
* updated docs in need of review

* Update creating-accounts-for-end-users.html.md.erb

fix typo

---------

Co-authored-by: Aaron Robinson <41325732+ASTRobinson@users.noreply.github.com>
  • Loading branch information
dms1981 and ASTRobinson authored Jan 25, 2024
1 parent a32f7e7 commit c7e3c60
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 34 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
owner_slack: "#modernisation-platform"
title: Creating AWS Accounts for Teams
last_reviewed_on: 2023-07-12
last_reviewed_on: 2024-01-25
review_in: 6 months
---

Expand Down
59 changes: 30 additions & 29 deletions source/runbooks/creating-vpcs.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
owner_slack: "#modernisation-platform"
title: Creating VPCs in AWS
last_reviewed_on: 2023-07-03
last_reviewed_on: 2024-01-25
review_in: 6 months
---

Expand All @@ -17,47 +17,48 @@ Example PR for this work [here](https://github.com/ministryofjustice/modernisati

The only information that is required is the name of the business unit. From there we can create a VPC relating to the current environment, e.g. **hq-test.**

Other information to build **extended DNS zones** and **NACLS** as well as any **additional endpoints** can be *useful*, but are not required at this stage. These things can be added after creation easily.
Other information to build **extended DNS zones** and **NACLS** as well as any **additional endpoints** or **additional CIDR ranges** can be *useful*, but are not required at this stage. These things can be added after creation easily.

## Files to Change.

Firstly, a cidr range needs to be reserved. The cidr-allocation.md file contains the ranges that can be reserved, depending on your environment, pick the correct table and put the business unit next to your range.
Firstly, a cidr range needs to be reserved. The `cidr-allocation.md` file contains the ranges that can be reserved, depending on your environment, pick the correct table and put the business unit next to your range.

Secondly, the expected.rego file needs to be edited under environments/networks. In here, we add the accounts that will go in this VPC, or leave it empty if you are building the vpc ahead of account creation.
Secondly, the `expected.rego` file needs to be edited under `policies/networking`. In here, we add the accounts that will go in this VPC, or leave it empty if you are building the vpc ahead of account creation.

Here's an example of what to add.

"opg-production": {
"general": {
"cidr": "10.27.48.0/21",
"accounts": [
]
}
},

```
"opg-production": {
"general": {
"cidr": "10.27.48.0/21",
"accounts": []
}
},
```
## Files to Add

Aside from the two files that need to be edited, a new file will be need to be added. This is done in the same pull request, and you will need a separate file for each VPC. For example if you are creating a development, test, preproduction and production VPC for OPG, you will need four separate files.
Aside from the two files that need to be edited, a new file will be need to be added. This is done in the same pull request, and you will need a separate file for each VPC.
For example if you are creating a development, test, preproduction and production VPC for OPG, you will need four separate files.

Here’s an example of what one looks like

{
"cidr": {
"subnet_sets": {
"general": {
"cidr": "10.27.72.0/21",
"accounts": []
}
}
},
"options": {
"bastion_linux": false,
"additional_endpoints": [],
"dns_zone_extend": []
},
"nacl": []
```
{
"cidr": {
"subnet_sets": {
"general": {
"cidr": "10.27.72.0/21",
"accounts": []
}
}

},
"options": {
"bastion_linux": false,
"additional_endpoints": [],
"dns_zone_extend": []
},
}
```
The file name is the business unit - environment. For example **laa-test.json**.

## Subnet sets
Expand Down
2 changes: 1 addition & 1 deletion source/runbooks/deleting-an-environment.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
owner_slack: "#modernisation-platform"
title: Deleting an environment (AWS account)
last_reviewed_on: 2023-07-12
last_reviewed_on: 2024-01-25
review_in: 6 month
---

Expand Down
4 changes: 2 additions & 2 deletions source/team/vision.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
owner_slack: "#modernisation-platform"
title: Our vision
last_reviewed_on: 2023-10-02
last_reviewed_on: 2024-01-25
review_in: 3 months
---

# <%= current_page.data.title %>

To provide a modern, robust and secure platform to support more complex applications.

We aim to provide Ministry of Justice application teams with self service modules enabling them to build consistent environments with limited infrastructure knowledge.
We provide Ministry of Justice application teams with self-service modules enabling them to build consistent environments with limited infrastructure knowledge.
2 changes: 1 addition & 1 deletion source/user-guide/security-testing-and-ithc.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
owner_slack: "#modernisation-platform"
title: Security Testing and ITHC
last_reviewed_on: 2023-07-19
last_reviewed_on: 2024-01-25
review_in: 6 months
---
# <%= current_page.data.title %>
Expand Down

0 comments on commit c7e3c60

Please sign in to comment.