Skip to content

Update the OpenSearch documentation with documents and training #45

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.

Sign up for GitHub

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

Open
thysk wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update the OpenSearch documentation with documents and training #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2a6951
Update the OpenSearch documentation with documents and training
Sep 26, 2025
7f870e5
Merge branch 'lsst:main' into update-opensearch-information
thysk Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/usdf-applications/drp/opensearch/documentation-training.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,16 @@
Documentation and Training
##########################
.. Links to other documentation sites and training if available

Documentation
=============
.. List of links to other documentation sites if available.

- OpenSearch Documentation: https://opensearch.org/docs/latest/
- Grafana Documentation: https://grafana.com/docs/grafana/latest/

Training
========
.. Links to training materials if available.

- Rucio Monitoring and Metrics training: https://github.com/rucio/monitoring-templates/tree/main/message-monitoring
3 changes: 3 additions & 0 deletions docs/usdf-applications/drp/opensearch/procedures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ Deployment
.. Deployment process for the application. Included upgrades and rollback procedures

Deployment is with a Makefile at https://github.com/slaclab/rubin-opensearch-deploy
Changes made to the configuration or resource requests are made on the GitHub repository and deployed with the Makefile. This should only be done during a maintenance window.

Maintenance
===========
.. Maintenance tasks. How maintenance is communicated and carried out.

Maintenance is infrequent and typically only for upgrades. Maintenance is communicated through the rubinobs-opensearch Slack channel.

Backup
======
.. Procedures for backup including how to verify backups.
Expand Down
5 changes: 5 additions & 0 deletions docs/usdf-applications/drp/opensearch/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,15 @@ Service accounts
================
.. Describe Kubernetes, Database, or Application Service accounts used by the application.

Each service that uses OpenSearch has its own service account. The OpenSearch cluster itself also has an admin account.
All the accounts and information to log into the OpenSearch cluster are stored in HashiCorp Vault.

Security Incident Response
==========================
.. Information and procedures for handling security incidents.

Any security incidents should be reported to the LSST Security Team following the procedures outlined in the LSST Security Incident Response Plan.
Copy link
Copy Markdown
Contributor

@villarrealas villarrealas Mar 16, 2026

Choose a reason for hiding this comment

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

Is it possible to link to the LSST Security Incident Response Plan here?


Security Policies
=================
.. Describe relevant policies related to the application or the data it processes.
Expand Down