docs(administration): add opensearch configuration documentation (#209) #209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Aug 29, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
0159f50 to
be2286b
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Aug 30, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
be2286b to
27c4f5a
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Aug 30, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
27c4f5a to
8702cc4
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 2, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
8702cc4 to
9025dbb
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 6, 2024
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 6, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
9025dbb to
4d68793
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 6, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
4d68793 to
ff41e6d
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 6, 2024
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 16, 2024
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 16, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
ff41e6d to
692ba88
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 16, 2024
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 16, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
692ba88 to
8f2a3f6
Compare
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
8f2a3f6 to
9840f2f
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Sep 26, 2024
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Oct 10, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
9840f2f to
2ad5a7f
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Oct 18, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
2ad5a7f to
259562e
Compare
jlemesh
added a commit
to jlemesh/docs.reana.io
that referenced
this pull request
Oct 18, 2024
jlemesh
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
259562e to
bdd9526
Compare
mdonadoni
force-pushed
the
feature_add_configuring_opensearch_docs
branch
from
bdd9526 to
e4dcd21
Compare
Alputer
reviewed
Nov 26, 2024
| ## Internal OpenSearch deployment | ||
|
|
||
| Even though not recommended, OpenSearch can also be deployed via the REANA Helm Chart. | ||
| It is normally configured to have two users, `reana` and `fluentibit`, used by the respective services to access OpenSearch. |
| Even though not recommended, OpenSearch can also be deployed via the REANA Helm Chart. | ||
| It is normally configured to have two users, `reana` and `fluentibit`, used by the respective services to access OpenSearch. | ||
|
|
||
| For a standard REANA deployment, theseare the Helm values you need to configure: |
|
|
||
| ### Persistent storage | ||
|
|
||
| There are multiple ways to configure persistent strage for OpenSearch. |
| Note that you can further customise OpenSearch's persistent volumes, for example by specifying the `size`, `labels` and `annotations`. For more details, see the [values of the OpenSearch Helm Chart](https://github.com/opensearch-project/helm-charts/blob/e43cf7dea1c01570971c70ff7d120b165bcfc28e/charts/opensearch/values.yaml#L197-L221). | ||
|
|
||
| Alternatively, `PersistentVolumeClaim`s can be created for each node manually, but their names should be the same that would be generated by `volumeClaimTemplates`. In this way, `volumeClaimTemplates` will pick the existing volumes by their names and will not create new ones. | ||
| in particular each claim should be named as `<clusterName|nameOverride|fullnameOverride>-<nodeGroup>-<clusterName|nameOverride|fullnameOverride>-<nodeGroup>-<N>`, where `N` is the number of an OpenSearch node. |
There was a problem hiding this comment.
in particular --> In particular
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes reanahub/reana#824
Add OpenSearch configuration documentation. Helm chart updated in reanahub/reana#827.