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 page for migrating to Dashboards #74

Merged
merged 1 commit into from
Jul 12, 2021
Merged

Add page for migrating to Dashboards #74

merged 1 commit into from
Jul 12, 2021

Conversation

aetter
Copy link
Contributor

@aetter aetter commented Jul 7, 2021

Description

[Describe what this change achieves]

Issues Resolved

#71

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@aetter aetter requested a review from dblock July 7, 2021 23:25
@aetter
Copy link
Contributor Author

aetter commented Jul 7, 2021

@tmarkley @kavilla

@dblock
Copy link
Member

dblock commented Jul 8, 2021

I don't know about the implementation details to review this, I think @tmarkley or maybe @mihirsoni?

@dblock
Copy link
Member

dblock commented Jul 8, 2021

@saratvemulapalli

@aetter aetter added upcoming release Don't merge until the version or feature is available and removed upcoming release Don't merge until the version or feature is available labels Jul 8, 2021
@aetter
Copy link
Contributor Author

aetter commented Jul 12, 2021

I'm very happy to make changes based on reviewer feedback, but I'm merging now so that we have this content for 1.0.0.

@aetter aetter merged commit 5996966 into main Jul 12, 2021
@kavilla
Copy link
Member

kavilla commented Jul 12, 2021

Hey thanks for this. Looks pretty good.

Just some mentions

Port your settings from <kibana-dir>/config/kibana.yml to <dashboards-dir>/config/opensearch_dashboards.yml.

I think to be safe, I would tell people to create a backup of kibana.yml. Just in case they moved their file and rename it.

In general, settings with elasticsearch in their names map to opensearch (e.g. elasticsearch.shardTimeout and opensearch.shardTimeout) and settings with kibana in their names map to opensearchDashboards (e.g. kibana.defaultAppId and opensearchDashboards.defaultAppId). Most other settings use the same names.

This is true, thanks for putting that. But subsequent changes were made to allow for the previous settings to still work with a deprecation message. Should we mention as a note that they shouldn't have to rename the settings right away? We thought it was a better experience for people to just have to rename the file and it work out of the box with warning messages.

@aetter
Copy link
Contributor Author

aetter commented Jul 12, 2021

This is true, thanks for putting that. But subsequent changes were made to allow for the previous settings to still work with a deprecation message. Should we mention as a note that they shouldn't have to rename the settings right away? We thought it was a better experience for people to just have to rename the file and it work out of the box with warning messages.

Got it, thanks for reviewing. I must have tested right before that change made its way in; I tried porting kibana.yml over as-is, and Dashboards failed to start. I'll test again later today and modify as necessary. In the meantime, I've updated the docs with a recommendation to take a backup.

@aetter aetter deleted the dashboards-migration branch July 12, 2021 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants