Skip to content
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] update dev guide to connect to external cluster #9080

Merged
merged 3 commits into from
Dec 25, 2024

Conversation

kavilla
Copy link
Member

@kavilla kavilla commented Dec 19, 2024

Description

An alternative to developing locally and setting up OpenSearch locally
by pointing to a running cluster.

Signed-off-by: Kawika Avilla [email protected]

Issues Resolved

n/a

Changelog

  • doc: update dev guide to connect to external cluster

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

An alternative to developing locally and setting up OpenSearch locally
by pointing to a running cluster.

Issue:
n/a

Signed-off-by: Kawika Avilla <[email protected]>
Signed-off-by: Kawika Avilla <[email protected]>
$ cd ..
$ yarn osd bootstrap --single-version=loose
```
2. Create a configuration directory outside your repository to avoid accidentally committing credentials. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe git can also ignore files locally by:

# ignore file
git update-index --skip-worktree <file-list>

# add back file to track
git update-index --no-skip-worktree <file-list>

Copy link
Collaborator

@Hailong-am Hailong-am left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would like to have something like profile(ideas from spring framework), if a profile has been set to dev, the configuration will read from opensearch_dashboards-dev.yml. by default it opensearch_dashboards.yml.

$ cd ..
$ yarn osd bootstrap --single-version=loose
```
2. Create a configuration directory outside your repository to avoid accidentally committing credentials. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I normally use opensearch_dashboards.dev.yml to keep local dev configuration, this file is git ignored. But seems there is no documentation for this.

@ashwin-pc ashwin-pc merged commit a98e178 into opensearch-project:main Dec 25, 2024
3 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 25, 2024
* [docs] update dev guide to connect to external cluster

An alternative to developing locally and setting up OpenSearch locally
by pointing to a running cluster.

Issue:
n/a

Signed-off-by: Kawika Avilla <[email protected]>

* dont include port

Signed-off-by: Kawika Avilla <[email protected]>

* Changeset file for PR #9080 created/updated

---------

Signed-off-by: Kawika Avilla <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
(cherry picked from commit a98e178)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Qxisylolo pushed a commit to Qxisylolo/OpenSearch-Dashboards that referenced this pull request Dec 26, 2024
…oject#9080)

* [docs] update dev guide to connect to external cluster

An alternative to developing locally and setting up OpenSearch locally
by pointing to a running cluster.

Issue:
n/a

Signed-off-by: Kawika Avilla <[email protected]>

* dont include port

Signed-off-by: Kawika Avilla <[email protected]>

* Changeset file for PR opensearch-project#9080 created/updated

---------

Signed-off-by: Kawika Avilla <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Hailong-am pushed a commit that referenced this pull request Dec 31, 2024
* [docs] update dev guide to connect to external cluster

An alternative to developing locally and setting up OpenSearch locally
by pointing to a running cluster.

Issue:
n/a



* dont include port



* Changeset file for PR #9080 created/updated

---------



(cherry picked from commit a98e178)

Signed-off-by: Kawika Avilla <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x docs Improvements or additions to documentation operational excellence v2.19.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants