Skip to content

Update documentation to reflect transition from Elasticsearch to OpenSearch - #5677

Merged
hannako merged 2 commits into
mainfrom
es2os
Oct 7, 2026
Merged

hannako merged 2 commits into
mainfrom
es2os

Conversation

@koetsier

@koetsier koetsier commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

@stringiest stringiest left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi, just a couple of changes I think.

Not sure if you planned to change all the filenames from elasticsearch to opensearch in a later PR? I haven't added comments for all of them.

Comment on lines 29 to 44
@@ -43,13 +43,13 @@ There are tabs for 'Cluster health' and 'Instance health'. The graphs in the
console link to AWS Cloudwatch, where historic metrics can be viewed over custom
time periods.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I wonder if this whole section can be removed? It looks like the nagios-plugins repo was archived in 2020.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think this whole section and others need updating. Much of this hasn't been updated since 2017/2019! I wrote a new card for this: https://gov-uk.atlassian.net/browse/SCH-2389

using the following:

```
gds govuk connect ssh --environment staging search -- -N -L 9200:elasticsearch6:80

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does this code block also need updating to reference opensearch?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

none of this works anymore. And with rake tasks having to be approved I think there's going to be a lot more updates

#### Logging

Access to logs is detailed in the [logging documentation](/manual/logging.html#elasticsearch).
Access to logs is detailed in the [logging documentation](/manual/logging.html#opensearch).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I wonder if this should stay as elasticsearch? It relates the the cluster used by logit for logging rather than the search cluster.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we also rename this file to opensearch-cluster-health.html.md?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we also rename this file?

[analysed]: https://docs.opensearch.org/latest/analyzers/
[filters]: https://docs.opensearch.org/latest/query-dsl/
[aggregates]: https://docs.opensearch.org/latest/aggregations/
[reindex-guide]: https://docs.publishing.service.gov.uk/manual/reindex-elasticsearch.html

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do this link and the associated file need renaming to reindex-opensearch.html?

Comment thread source/manual/databases.html.md Outdated
Mongo databases are hosted either in DocumentDB clusters (managed by AWS) or MongoDB clusters (managed by us on self-hosted EC2 instances). On production, there is currently one DocumentDB cluster for Licensify and one 'shared' DocumentDB cluster, each with three instances. There is also one Mongo cluster of three EC2s. We have agreed that [we should move apps from MongoDB to DocumentDB](/repos/govuk-aws/architecture/decisions/0038-mongo_replacement_by_documentdb.html).

ElasticSearch is hosted in [AWS's OpenSearch service](https://eu-west-1.console.aws.amazon.com/esv3/home?region=eu-west-1#opensearch/domains). It has [two types of node](https://github.com/alphagov/govuk-aws/blob/6b5f78824bb14f5f6aaa7f7d269915b7831a13c3/terraform/projects/app-elasticsearch6/main.tf#L186-L193) - "master" and "data" (instance).
OpenSearch is hosted in [AWS's OpenSearch service](https://eu-west-1.console.aws.amazon.com/esv3/home?region=eu-west-1#opensearch/domains). It has [two types of node](https://github.com/alphagov/govuk-aws/blob/6b5f78824bb14f5f6aaa7f7d269915b7831a13c3/terraform/projects/app-elasticsearch6/main.tf#L186-L193) - "master" and "data" (instance).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@koetsier

Copy link
Copy Markdown
Contributor Author

I renamed the files and updated the changes you mentioned. I haven't done 'opensearch-cluster-health.html.md' yet because I think that needs a bit more thinking and linking to grafana dashboards etc.

@stringiest stringiest left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks great! 🌟

@hannako
hannako merged commit f78ceb4 into main Oct 7, 2026
6 checks passed
@hannako
hannako deleted the es2os branch October 7, 2026 10:04
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.

3 participants