From b2a695103de4ee36a446e1123b119d3a859f789a Mon Sep 17 00:00:00 2001 From: thysk Date: Fri, 26 Sep 2025 09:37:19 +0100 Subject: [PATCH] Update the OpenSearch documentation with documents and training --- .../drp/opensearch/documentation-training.rst | 13 +++++++++++++ .../usdf-applications/drp/opensearch/procedures.rst | 3 +++ docs/usdf-applications/drp/opensearch/security.rst | 5 +++++ 3 files changed, 21 insertions(+) diff --git a/docs/usdf-applications/drp/opensearch/documentation-training.rst b/docs/usdf-applications/drp/opensearch/documentation-training.rst index 510c358..b498e0c 100644 --- a/docs/usdf-applications/drp/opensearch/documentation-training.rst +++ b/docs/usdf-applications/drp/opensearch/documentation-training.rst @@ -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 diff --git a/docs/usdf-applications/drp/opensearch/procedures.rst b/docs/usdf-applications/drp/opensearch/procedures.rst index 0706760..b855303 100644 --- a/docs/usdf-applications/drp/opensearch/procedures.rst +++ b/docs/usdf-applications/drp/opensearch/procedures.rst @@ -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. diff --git a/docs/usdf-applications/drp/opensearch/security.rst b/docs/usdf-applications/drp/opensearch/security.rst index cce760d..082af2d 100644 --- a/docs/usdf-applications/drp/opensearch/security.rst +++ b/docs/usdf-applications/drp/opensearch/security.rst @@ -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. + Security Policies ================= .. Describe relevant policies related to the application or the data it processes.