opensearch-project / opensearch-project/.github

[GitHub Request] Add OpenSearch Endpoint as a GitHub Secret for OpenSearch Dashboards

Open
#247 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

github-request
Dominant language
No language data
Stars
41
Forks
74
Avg merge
3d 19h
Merged PRs (30d)
1

Description

What is the type of request?

Secret Update

Details of the request

OpenSearch Dashboards currently has no integration testing for S3 datasets in Discover 2.0. Because of the technicalities and challenges behind setting up an OpenSearch environment with S3 support on a GitHub runner, we plan on temporarily adding a working endpoint with S3 support as a secret, and use that as a single backend for Cypress integration tests per PR.

Additional information to support your request

This should be a temporary workaround to get integration testing for this feature, and will be worked on in collaboration between the opensearch-sql maintainers and OpenSearch-Dashboards to get a locally built OpenSearch with S3 support within GitHub Runners.

Not sure where to include this endpoint and the necessary username and password.

When does this request need to be completed?

As soon as possible. There are ongoing changes for this feature, and we want to catch regressions as new PRs come in without needing to manually sign off each time.

Notes

Track the progress of your request here: https://github.com/orgs/opensearch-project/projects/208/views/33.
Member of @opensearch-project/admin will take a look at the request soon.
Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository file or test entry point is named. Start by reviewing the GitHub Actions workflows and Cypress integration-test setup for Discover 2.0, then confirm how secrets are passed to the tests. Done means the temporary endpoint credentials are securely available to pull-request runs and S3 dataset regressions are exercised automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
cypress, github-actions
Domain
ci-cd, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.