https://github.com/netcracker/qubership-opensearch
https://github.com/netcracker/qubership-opensearch
opensearch qubership-infra saqs
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/netcracker/qubership-opensearch
- Owner: Netcracker
- License: apache-2.0
- Created: 2024-11-18T11:07:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-19T11:41:42.000Z (5 months ago)
- Last Synced: 2026-01-19T17:51:16.369Z (5 months ago)
- Topics: opensearch, qubership-infra, saqs
- Language: Go
- Homepage:
- Size: 6.84 MB
- Stars: 4
- Watchers: 7
- Forks: 9
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Qubership OpenSearch
Qubership OpenSearch is a comprehensive solution for deploying OpenSearch in Kubernetes with High Availability (HA), Disaster Recovery (DR), and Multi-AZ setups.
Includes tools for backup management, monitoring, database as a service API and integration testing to ensure reliable operation and security.
Designed for creating resilient and secure OpenSearch clusters in a cloud-native environment.
## Documentation
* [Architecture guide](/docs/public/architecture.md).
* [Installation guide](/docs/public/installation.md).
* [Monitoring guide](/docs/public/monitoring.md)
* [Troubleshooting guide](/docs/public/troubleshooting.md).
* [Internal Developer Guide](/docs/internal/developing.md).
* [Guides](/docs/public).
* [Quick Start](/operator/charts/helm/opensearch-service/README.md).
## Repository structure
* `./operator/charts` - directory with main HELM chart for OpenSearch and integration tests.
* `./operator/config` - directory with YAML resources for operator framework.
* `./operator/controllers` - directory with operator's Golang source code which implements controller functionality.
* `./operator/dev-kit` - directory with scripts for working with Golang Operator Framework.
* `./operator/disasterrecovery` - directory with operator's Golang source code which implements disaster recovery functionality.
* `./docs` - directory with actual documentation for OpenSearch service component.
* `./integration-tests` - directory with Robot Framework test cases for OpenSearch.
* `./tls-init` - directory with source code, Dockerfile and CI/CD config files for `tls-init` job.
* `./operator/utils` - directory with operator's Golang source code which implements common functions.
## How to start
### Deploy to k8s
#### Pure helm
1. Build operator and integration tests, if you need non-main versions.
2. Prepare kubeconfig on you host machine to work with target cluster.
3. Prepare `sample.yaml` file with deployment parameters, which should contains custom docker images if it is needed.
4. Store `sample.yaml` file in `/charts/helm/opensearch-service` directory.
5. Go to `/charts/helm/opensearch-service` directory.
6. Run the following command:
```sh
helm install opensearch-service ./ -f sample.yaml -n
```
### Integration tests and ATP Storage (S3)
Integration tests can optionally upload results to an S3-compatible storage (ATP Storage).
The defaults are defined in `operator/charts/helm/opensearch-service/values.yaml` under `integrationTests`:
- `integrationTests.atpReport.enabled`: `false` - when `false`, ATP S3-related environment variables are not passed to the pod
- `integrationTests.atpReport.atpStorage.bucket`: `""` - when empty, S3 upload is disabled and results stay local
- `integrationTests.atpReport.atpStorage.serverUrl`: `"https://s3.amazonaws.com"`
- `integrationTests.atpReport.atpStorage.serverUiUrl`: `""`
- `integrationTests.atpReport.atpStorage.region`: `"us-east-1"`
- `integrationTests.environmentName`: `"opensearch"`
- `integrationTests.atpReportViewUiUrl`: `""`
To enable upload, set `integrationTests.atpReport.enabled` to `true` and configure at least `integrationTests.atpReport.atpStorage.bucket` and credentials:
- `integrationTests.atpReport.atpStorage.username`
- `integrationTests.atpReport.atpStorage.password`
### Smoke tests
There is no smoke tests.
### How to debug
#### VSCode
To debug Operator in VSCode you can use `Launch operator` configuration which is already defined in
`.vscode/launch.json` file.
The developer should configure environment variables:
* `KUBECONFIG` - developer should **need to define** `KUBECONFIG` environment variable
which should contains path to the kube-config file. It can be defined on configuration level
or on the level of user's environment variables.
* `OPENSEARCH_USERNAME` - username for REST API access.
* `OPENSEARCH_PASSWORD` - password for REST API access.
* `OPENSEARCH_HOST` - OpenSearch's Ingress.
* `OPENSEARCH_NAME`, `WATCH_NAMESPACE`.
### How to troubleshoot
There are no well-defined rules for troubleshooting, as each task is unique, but there are some tips that can do:
* Deploy parameters.
* Application manifest.
* Logs from all OpenSearch service pods: operator, OpenSearch, monitoring and others.
Also, developer can take a look on [Troubleshooting guide](/docs/public/troubleshooting.md).
## Evergreen strategy
To keep the component up to date, the following activities should be performed regularly:
* Vulnerabilities fixing.
* OpenSearch upgrade.
* Bug-fixing, improvement and feature implementation for operator and other related supplementary services.
## Useful links
* [OpenSearch Doc Portal](https://opensearch.org/docs/latest/)
* [Internal Developer Guide](/docs/internal/developing.md).