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

Add sample config of multi data source to yml template. #2428

Merged
merged 1 commit into from
Oct 4, 2022

Conversation

zengyan-amazon
Copy link
Member

@zengyan-amazon zengyan-amazon commented Sep 28, 2022

Description

Add sample config of multi data source to yml template.

Issues Resolved

#2427

Check List

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

ashwin-pc
ashwin-pc previously approved these changes Sep 28, 2022

# Set the value of this setting to true to enables the experimental multiple data source
# support feature. Use with caution.
#data_source.enabled: false
Copy link
Member

Choose a reason for hiding this comment

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

nit: For consistency, can we add a space between the comment delimiter and the config key?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the convention in this file is:

  • for comments/explanations, put a space between comment content and comment delimiter #
  • for sample config key/settings, no space between config key and comment delimiter #
    So that it is easy for people to differentiate comment/explanations vs. sample configs

zhongnansu
zhongnansu previously approved these changes Sep 28, 2022
Copy link
Member

@zhongnansu zhongnansu left a comment

Choose a reason for hiding this comment

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

lgtm

Comment on lines +230 to +231
# Set the value of these settings to custermize crypto materials to encryption saved credentials
# in data sources.
Copy link
Member

Choose a reason for hiding this comment

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

Can/should we link to documentation for these settings? It's not at all clear from this file alone what valid values here might look like.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't see other settings has reference to document in the template. there is another PR which provides document of all settings in README #2448

@codecov-commenter
Copy link

Codecov Report

Merging #2428 (6371619) into main (806e96c) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2428      +/-   ##
==========================================
+ Coverage   66.74%   66.75%   +0.01%     
==========================================
  Files        3194     3200       +6     
  Lines       60803    60886      +83     
  Branches     9238     9250      +12     
==========================================
+ Hits        40583    40646      +63     
- Misses      18011    18029      +18     
- Partials     2209     2211       +2     
Impacted Files Coverage Δ
.../plugins/data_source/server/data_source_service.ts 75.00% <0.00%> (-8.34%) ⬇️
...gins/data_source/server/client/configure_client.ts 80.00% <0.00%> (-4.85%) ⬇️
...blic/application/utils/use/use_saved_wizard_vis.ts 2.50% <0.00%> (-0.84%) ⬇️
...pplication/components/data_tab/secondary_panel.tsx 2.32% <0.00%> (-0.24%) ⬇️
src/core/server/http/router/router.ts 74.54% <0.00%> (ø)
...c/plugins/data_source/server/client/client_pool.ts 58.82% <0.00%> (ø)
...s/wizard/public/application/components/top_nav.tsx 5.88% <0.00%> (ø)
...public/visualizations/common/expression_helpers.ts 11.11% <0.00%> (ø)
...index_patterns/fetcher/lib/resolve_time_pattern.ts 100.00% <0.00%> (ø)
...s/wizard/public/saved_visualizations/transforms.ts 100.00% <0.00%> (ø)
... and 14 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

noCharger
noCharger previously approved these changes Sep 29, 2022
Copy link
Contributor

@noCharger noCharger left a comment

Choose a reason for hiding this comment

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

Overall lgtm, we might also add audit configs after it's complete

ananzh
ananzh previously approved these changes Sep 29, 2022
Copy link
Member

@ananzh ananzh left a comment

Choose a reason for hiding this comment

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

I see @ashwin-pc and @joshuarrrr comments have been resolved.
LGTM

@ashwin-pc
Copy link
Member

@zengyan-amazon looks like your original commit is missing a signoff, the rest LGTM

Signed-off-by: Yan Zeng <zengyan@amazon.com>
@kavilla kavilla added backport 2.x v2.4.0 'Issues and PRs related to version v2.4.0' labels Sep 29, 2022
@zengyan-amazon
Copy link
Member Author

fixed sign off commit

@kristenTian kristenTian merged commit 60efd3b into opensearch-project:main Oct 4, 2022
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-2428-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 60efd3bacab8a092bacb5842854d41bf48423fdc
# Push it to GitHub
git push --set-upstream origin backport/backport-2428-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-2428-to-2.x.

zhongnansu pushed a commit to zhongnansu/OpenSearch-Dashboards that referenced this pull request Oct 4, 2022
…earch-project#2428)

Signed-off-by: Yan Zeng <zengyan@amazon.com>

Signed-off-by: Yan Zeng <zengyan@amazon.com>
(cherry picked from commit 60efd3b)
joshuarrrr pushed a commit that referenced this pull request Oct 4, 2022
#2490)

Signed-off-by: Yan Zeng <zengyan@amazon.com>

Signed-off-by: Yan Zeng <zengyan@amazon.com>
(cherry picked from commit 60efd3b)

Co-authored-by: Yan Zeng <46499415+zengyan-amazon@users.noreply.github.com>
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Dec 16, 2022
…earch-project#2428)

Signed-off-by: Yan Zeng <zengyan@amazon.com>

Signed-off-by: Yan Zeng <zengyan@amazon.com>
Signed-off-by: Sergey V. Osipov <sipopo@yandex.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x multiple datasource multiple datasource project v2.4.0 'Issues and PRs related to version v2.4.0'
Projects
None yet
Development

Successfully merging this pull request may close these issues.