Skip to content

Commit

Permalink
Fix more links
Browse files Browse the repository at this point in the history
  • Loading branch information
poornima-krishnasamy committed Jan 12, 2024
1 parent 9167d66 commit 9341e0f
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Date: 01/06/2019

**June 2020 Update** The CP team is now in the habit of spinning up a [test cluster](https://github.com/ministryofjustice/cloud-platform-infrastructure/pull/742) to develop and test each change to the platform, before it is deployed to the main cluster (live). So although the main cluster still has dev/staging namespaces for service teams, this work is confined to their namespaces, and there's little concern that they would disrupt other namespaces. These user dev/staging namespaces could simply be seen as benefiting from the high service level offered for the cluster, due to it hosting the production namespaces.

**May 2021 Update** We're looking to move on from this ADR decision, and have different clusters for non-prod namespaces - see [021-Multi-cluster](021-Multi-cluster.html)
**May 2021 Update** We're looking to move on from this ADR decision, and have different clusters for non-prod namespaces - see [021-Multi-cluster](https://github.com/ministryofjustice/cloud-platform/blob/main/architecture-decision-record/021-Multi-cluster.md)

## Context

Expand Down
2 changes: 1 addition & 1 deletion architecture-decision-record/021-Multi-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We host user apps across *more than one* Kubernetes cluster. Apps could be moved

## Context

Service teams' apps currently run on [one Kubernetes cluster](012-One-cluster-for-dev-staging-prod.html). That includes their dev/staging/prod environments - they are not split off. The key reasoning was:
Service teams' apps currently run on [one Kubernetes cluster](https://github.com/ministryofjustice/cloud-platform/blob/main/architecture-decision-record/012-One-cluster-for-dev-staging-prod.md). That includes their dev/staging/prod environments - they are not split off. The key reasoning was:

* Strong isolation is already required between apps from different teams (via namespaces, network policies), so there is no difference for isolating environments
* Maintaining clusters for each environment is a cost in effort
Expand Down
2 changes: 1 addition & 1 deletion architecture-decision-record/023-Logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Concerns with existing ElasticSearch logging:
* Service teams have access to other teams' logs, which is a concern should personal information be inadvertantly logged
* Fluentd + AWS OpenSearch combination has no flexibility to parse/define the JSON structure of logs, so all our teams right now have to contend with grabbing the contents of a single log field and parsing it outside ES

With these concerns in mind, and the [migration to EKS](022-EKS.html) meaning we'd need to reimplement log shipping, we reevaluate this strategy.
With these concerns in mind, and the [migration to EKS](https://github.com/ministryofjustice/cloud-platform/blob/main/architecture-decision-record/022-EKS.md) meaning we'd need to reimplement log shipping, we reevaluate this strategy.

## User needs

Expand Down
4 changes: 2 additions & 2 deletions runbooks/source/add-new-receiver-alert-manager.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Add a new Alertmanager receiver and a slack webhook
weight: 85
last_reviewed_on: 2023-11-20
last_reviewed_on: 2024-01-12
review_in: 6 months
---

Expand All @@ -22,7 +22,7 @@ You must have the below details from the development team.

## Creating a new receiver set

1. Fill in the template with the details provided from development team and add the array to [`terraform.tfvars`](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/cloud-platform-components/terraform.tfvars) file.
1. Fill in the template with the details provided from development team and add the array to [`terraform.tfvars`](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components/terraform.tfvars) file.
The `terraform.tfvars` file is encrypted so you have to `git-crypt unlock` to view the contents of the file.
Check [git-crypt documentation in user guide](https://user-guide.cloud-platform.service.justice.gov.uk/documentation/other-topics/git-crypt-setup.html#git-crypt) for more information on how to setup git-crypt.

Expand Down
2 changes: 1 addition & 1 deletion runbooks/source/add-nodes-to-the-eks-cluster.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This can address the problem of CPU high usage/load

### Cluster configuration:

#### [cluster.tf](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/cloud-platform-eks/cluster.tf)
#### [cluster.tf](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/cluster.tf)

Use

Expand Down
4 changes: 1 addition & 3 deletions runbooks/source/disaster-recovery-scenarios.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,7 @@ Plan: 7 to add, 0 to change, 0 to destroy.

In this scenario, terraform state can be restored from the remote_state stored in the terraform backend S3 bucket.

For example [eks-components](https://github.com/ministryofjustice/cloud-platform-infrastructure/tree/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components) state is stored in "aws-accounts/cloud-platform-aws/vpc/eks/components" s3 bucket as defined [here-eks](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components/main.tf/#L5-L14).

or [kops-components](https://github.com/ministryofjustice/cloud-platform-infrastructure/tree/main/terraform/aws-accounts/cloud-platform-aws/vpc/kops/components) state is stored in "aws-accounts/cloud-platform-aws/vpc/kops/components" s3 bucket as defined [here-kops](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/aws-accounts/cloud-platform-aws/vpc/kops/components/main.tf/#L1-L11).
For example [eks/components](https://github.com/ministryofjustice/cloud-platform-infrastructure/tree/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components) state is stored in "aws-accounts/cloud-platform-aws/vpc/eks/components" s3 bucket as defined [here-eks](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components/main.tf/#L5-L14).

Access the S3 bucket where the effected terraform state is stored. From the list of terraform.tfstate file versions, identify the file before the state got removed and download as terraform.tfstate. Upload the file again, this will set uploaded file as latest version.

Expand Down
2 changes: 1 addition & 1 deletion runbooks/source/eks-cluster.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Alternatively, using the `create-cluster` script.

See the file [example.env.create-cluster](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/example.env.create-cluster) in the infrastructure repo. This shows examples of the environment variables which must be set in order to run the `create-cluster.rb` script to create a new cluster.

You can get the auth0 values from the `terraform-provider-auth0` application on [auth0](https://manage.auth0.com/dashboard/eu/justice-cloud-platform/applications).
You can get the auth0 values from the `terraform-provider-auth0` application on [justice-cloud-platform - auth0](https://auth0.com/docs/authenticate/login).

or you can export these env vars in your shell:

Expand Down
3 changes: 2 additions & 1 deletion runbooks/source/how-we-work.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,8 @@ Instead, when not answering queries and reviewing PRs, the Hammer should work on

Most of our user-facing documentation is in the [user guide], and documentation for the team is in the [runbooks] site.

There are also a lot of important `README.md` files like [this one](https://github.com/ministryofjustice/cloud-platform#ministry-of-justice-cloud-platform-master-repo), especially for our terraform modules. We also have code samples like [this](https://github.com/ministryofjustice/cloud-platform-terraform-rds-instance/blob/main/example/rds-postgresql.tf) for each of our terraform modules.
There are also a lot of important `README.md` files like [this one](https://github.com/ministryofjustice/cloud-platform#ministry-of-justice-cloud-platform-master-repo), especially for our terraform modules.
We also have code samples like [this](https://github.com/ministryofjustice/cloud-platform-terraform-rds-instance/blob/main/examples/rds-postgresql.tf) for each of our terraform modules.

It is important to keep all of this up to date as the underlying code changes, so please remember to factor this in when estimating and working on tickets.

Expand Down
2 changes: 1 addition & 1 deletion runbooks/source/joiners-guide.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ git config --global init.templateDir ~/.git-templates/git-secrets

* Github access - (to be done by new starter)
* Explain github for RBAC
* Invite as an admin on [Auth0](https://manage.auth0.com/dashboard/eu/justice-cloud-platform/users)
* Invite as an admin on [justice-cloud-platform - Auth0](https://auth0.com/docs/authenticate/login)
* (Switch to 'justice-cloud-platform tenant, then use the drop-down and select "Invite an admin")
* New starter github user to be added to MOJ github organisation and WebOps team
* Add to [MoJ 1Password](https://ministryofjustice.1password.eu/)
Expand Down
9 changes: 4 additions & 5 deletions runbooks/source/leavers-guide.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Leavers Guide
weight: 9100
last_reviewed_on: 2023-12-13
review_in: 3 months
last_reviewed_on: 2024-01-12
---

# Leavers Guide
Expand Down Expand Up @@ -32,7 +31,7 @@ When CP team members leave, follow this guide, and log completion in a ticket.

#### Slack account deactivation

Cloud Platform maintain a list of webhooks for [Alertmanager Notifications](https://api.slack.com/apps/ABFSJLD8W/incoming-webhooks). When the slack account is deactivated,
Cloud Platform maintain a list of webhooks for Alertmanager Notifications - Incoming Webhooks. When the slack account is deactivated,
these webhooks will still be active. Hence, no action is needed.

Some apps that member installed which require member-specific permissions may be atomatically deactivated.
Expand Down Expand Up @@ -64,9 +63,9 @@ Below are the list of 3rd party accounts that need to be removed when a member l

1. Request Password Management removal - [1Password](https://1password.com/)

2. [Auth0 justice-cloud-platform](https://manage.auth0.com/dashboard/eu/justice-cloud-platform/users)
2. [Auth0 justice-cloud-platform](https://auth0.com/docs/authenticate/login)

3. [Auth0 moj-cloud-platforms](https://manage.auth0.com/dashboard/eu/moj-cloud-platforms-dev/users)
3. [Auth0 moj-cloud-platforms](https://auth0.com/docs/authenticate/login)

4. [Pagerduty](https://moj-digital-tools.pagerduty.com/users)

Expand Down
2 changes: 1 addition & 1 deletion runbooks/source/on-call.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Cloud Platform team members provide support out of hours, as detailed in [Cloud
2. Get production access to supported services.
3. Get access to our on-call tools:
* [Pingdom](https://my.pingdom.com/)
* [Pagerduty](https://moj-digital-tools.pagerduty.com/) (and configure your contact details and notifications, this is the single source of truth for when you are on call.)
* [Pagerduty- moj-digital-tools.pagerduty.com](https://identity.pagerduty.com/global/authn/authentication/PagerDutyGlobalLogin/subdomain) (and configure your contact details and notifications, this is the single source of truth for when you are on call.)
* [AWS](https://mojdsd.signin.aws.amazon.com/)
* the MOJDS VPN (and configure it to “send all traffic over VPN connection”)
4. Do a dry-run of an incident.
Expand Down
5 changes: 1 addition & 4 deletions runbooks/source/tips-and-tricks.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Tips and Tricks
weight: 9200
last_reviewed_on: 2024-05-21
last_reviewed_on: 2024-01-12
review_in: 6 months
---

Expand Down Expand Up @@ -84,9 +84,6 @@ Paste this into the search field on [Prometheus]:
```
max by(node) (max by(instance) (kubelet_running_pod_count{job="kubelet",metrics_path="/metrics"}) * on(instance) group_left(node) kubelet_node_name{job="kubelet",metrics_path="/metrics"})
```
## Output all records from Route53 as a CSV file

Use [this script](https://github.com/ministryofjustice/cloud-platform-infrastructure/blob/main/bin/route53-to-csv.rb)

## Add more RSS feeds to `#cloud-platform-rss` channel

Expand Down
7 changes: 3 additions & 4 deletions runbooks/source/upgrade-terraform-version.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ When all namespaces in the cloud-platform-environments repository are using the
- [Remove](https://github.com/ministryofjustice/cloud-platform-environments/commit/b11b0372fe71289e51739395664355014df0e655) the conditional logic in the apply library.

### Infrastructure state files
The Infrastructure state we have in the Cloud Platform is structured in a tree related to its dependency, so for example, the [components](https://github.com/ministryofjustice/cloud-platform-infrastructure/tree/main/terraform/cloud-platform-components) state (in the output below) relies heavily on the directory above and so on. Here is a snapshot of how our directory looks but this is likely to change:
The Infrastructure state we have in the Cloud Platform is structured in a tree related to its dependency,
so for example, the [components](https://github.com/ministryofjustice/cloud-platform-infrastructure/tree/main/terraform/aws-accounts/cloud-platform-aws/vpc/eks/components) state (in the output below) relies heavily on the directory above and so on.
Here is a snapshot of how our directory looks but this is likely to change:

```
aws-accounts
Expand All @@ -128,16 +130,13 @@ aws-accounts
│ ├── eks # Holding EKS, workspaces for individual clusters.
│ │ └── components # EKS components. Workspaces for individual clusters
│ └── kops # Holding KOPS, workspaces for individual clusters.
│ └── components # KOPS components. Workspaces for individual clusters
├── cloud-platform-dsd
│ └── main.tf
├── cloud-platform-ephemeral-test
│ ├── account
│ └── vpc
│ ├── eks
│ │ └── components
│ └── kops
│ └── components
└── README.md
```

Expand Down

0 comments on commit 9341e0f

Please sign in to comment.