-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
Docs/add helm chart install instructions #127
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Sensitive Data Archive Helm Charts | ||
|
||
## Charts overview | ||
|
||
The `neicnordic` Helm repository contains the following charts (for configuration details click on the links below): | ||
|
||
- [sda-svc - SDA services](https://github.com/neicnordic/sensitive-data-archive/blob/main/charts/sda-svc/README.md) | ||
aaperis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This chart deploys the service components needed to operate the Sensitive Data Archive solution. The charts may include additional service components that might be beneficial for administrative operations or extending the Sensitive Data Archive solutions to facilitate different use cases. | ||
aaperis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [sda-db - SDA database](https://github.com/neicnordic/sensitive-data-archive/blob/main/charts/sda-db/README.md) | ||
|
||
This chart deploys a pre-configured database ([PostgreSQL](https://www.postgresql.org/)) instance for Sensitive Data Archive, the database schemas are designed to adhere to [European Genome-Phenome Archive](https://ega-archive.org/) federated archiving model. | ||
|
||
- [sda-mq - SDA Message broker](https://github.com/neicnordic/sensitive-data-archive/blob/main/charts/sda-mq/README.md) | ||
|
||
This chart deploys a pre-configured message broker ([RabbitMQ](https://www.rabbitmq.com/)) designed for [European Genome-Phenome Archive](https://ega-archive.org/) federated messaging between `CentralEGA` and Local/Federated EGAs but also configurable to support Standalone SDA deployments. | ||
|
||
- [sda-orch - SDA orchestrate service](https://github.com/neicnordic/sensitive-data-archive/blob/main/charts/sda-orch/README.md) | ||
|
||
This chart deploys an orchestration service for the Sensitive Data Archive solution. This is a helper service designed to curate the ingestion flow in an automated manner when the SDA solution is deployed and configured as standalone (non-federated). | ||
|
||
## Usage | ||
|
||
[Helm](https://helm.sh) must be installed to use the charts. | ||
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. | ||
|
||
With Helm properly installed, add the `neicnordic` Helm repository as follows: | ||
|
||
```sh | ||
helm repo add neicnordic https://neicnordic.github.io/sensitive-data-archive | ||
helm repo update | ||
``` | ||
|
||
You can then run | ||
|
||
```sh | ||
helm search repo neicnordic | ||
``` | ||
|
||
to see the available charts. | ||
|
||
## Installing the Charts | ||
|
||
To install a chart with the release name `my-release`: | ||
|
||
```sh | ||
helm install my-release neicnordic/<chart-name> | ||
``` | ||
|
||
To configure a Helm chart with your own values, you can copy the default `values.yaml` file from the chart to your local directory and modify it as needed, or using helm: | ||
|
||
```sh | ||
helm show values neicnordic/<chart-name> > <values-filename>.yaml | ||
``` | ||
|
||
Then, you can install the chart with the following command: | ||
|
||
```sh | ||
helm install my-release -f <values-filename>.yaml neicnordic/<chart-name> | ||
``` | ||
|
||
Example: | ||
|
||
```sh | ||
helm show values neicnordic/sda-svc > my-values.yaml | ||
vi my-values.yaml | ||
aaperis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
helm install my-release neicnordic/sda-svc -f my-values.yaml | ||
``` | ||
|
||
For quick reference to Helm's chart management capabilities see [here](https://helm.sh/docs/intro/cheatsheet/#chart-management). | ||
|
||
## Uninstalling the Chart | ||
|
||
To uninstall/delete the `my-release` deployment: | ||
aaperis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```sh | ||
helm delete my-release | ||
``` | ||
|
||
The command removes all the Kubernetes components associated with the chart and deletes the release. | ||
|
||
## System requirements | ||
|
||
- kubernetes minimal version required for running the helm charts is `>= 1.25` | ||
- helm minimal version required for running the charts is `>=3.5` |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The abbreviation
SDA
and the full nameSensitive Data Archive
are used interchangeably throughout the text. I think we can add the abbreviation(SDA)
at the beginning of the text and then use the short nameSDA
afterwards unless we need to use the full name by purpose.