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.

Sign up for GitHub

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

Jump to bottom

[Migration][discuss] deprecate setting names in opensearch_dashboards.yml #440

Closed
ananzh opened this issue Jun 4, 2021 · 0 comments · Fixed by #493
Closed

[Migration][discuss] deprecate setting names in opensearch_dashboards.yml #440

ananzh opened this issue Jun 4, 2021 · 0 comments · Fixed by #493
Labels
enhancement New feature or request migration Any plans, changes, or enhancements needed for migration proposal

Comments

@ananzh
Copy link
Member

ananzh commented Jun 4, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.

We have many deprecations: ({ renameFromRoot }) in the code to deprecate setting names no longer used. Some of them are old and could be removed. Some related to odfe use and migration which might be affected by our fork and rename. For the migration pain, here are some examples:

example 1:

deprecations: ({ renameFromRoot }) => [
    renameFromRoot('timeline_vis.enabled', 'vis_type_timeline.enabled'),
    renameFromRoot('timeline.enabled', 'vis_type_timeline.enabled'),
    renameFromRoot('timeline.graphiteUrls', 'vis_type_timeline.graphiteUrls'),
    renameFromRoot('timeline.ui.enabled', 'vis_type_timeline.ui.enabled', true),
  ],

example 2:

  deprecations: ({ renameFromRoot }) => [
    renameFromRoot('opensearchDashboards.disableWelcomeScreen', 'home.disableWelcomeScreen'),
  ],

In example1, previous odfe users use timelion.graphiteUrls or vis_type_timelion.graphiteUrls to set allowlist. Now after the rename, due to rename some previous settings in opensearch_dashboards.yml doesn't work. After migration, customers can't use these settings.

Describe the solution you'd like

  1. check all the settings that are affected by rename
  2. use deprecations: ({ renameFromRoot }) to allow deprecations for migration from odfe to dashboards 1.0
    For example,
deprecations: ({ renameFromRoot }) => [
    renameFromRoot('timelion_vis.enabled', 'vis_type_timelion.enabled'),
    renameFromRoot('vis_type_timelion.enabled', 'vis_type_timeline.enabled'),
  ],

customer can still use timelion_vis.enabled or vis_type_timelion.enabled and meanwhile customer will receive a deprecation warning to know what they should change.

Screen Shot 2021-06-04 at 10 43 58 AM

Describe alternatives you've considered

Additional context
@ananzh ananzh added enhancement New feature or request migration Any plans, changes, or enhancements needed for migration proposal labels Jun 4, 2021
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
6084705 
During renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This means that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer was able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
2d53596 
During renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This means that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer was able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
45057bd 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
@kavilla kavilla mentioned this issue Jun 18, 2021
Merged
5 tasks
@kavilla kavilla linked a pull request Jun 18, 2021 that will close this issue
[Build] deprecate renamed configurations #493
Merged
5 tasks
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
647d98c 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
134686c 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 18, 2021
@kavilla
[Build] deprecate renamed configurations
25eb06f 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Added unit tests to test on the server configs.

Issues resolved:
opensearch-project#440

Partially resolves:
opensearch-project#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit that referenced this issue Jun 22, 2021
@kavilla
[Build] deprecate renamed configurations (#493)
e4bd7b3 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Added unit tests to test on the server configs.

Issues resolved:
#440

Partially resolves:
#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit that referenced this issue Jun 22, 2021
@kavilla
[Build] deprecate renamed configurations (#493)
dc611cd 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Added unit tests to test on the server configs.

Issues resolved:
#440

Partially resolves:
#334

Signed-off-by: Kawika Avilla <[email protected]>
kavilla added a commit that referenced this issue Jun 22, 2021
@kavilla
[Build] deprecate renamed configurations (#493)
770c01a 
While renaming after the fork, configurations were renamed
and replaced with keywords related to OpenSearch.

This meant that anyone who migrated to OpenSearch Dashboards
who had configured their YAML file no longer were able to
carry over those changes and run the application. This
prevented the application from starting due to unknown config
keys. Although, this still does not allow the application to
work out of the box because people will need to make sure
then rename their kibana.yml to opensearch_dashboards.yml,
but once they do they do not need to modify the content
of the config.

Added unit tests to test on the server configs.

Issues resolved:
#440

Partially resolves:
#334

Signed-off-by: Kawika Avilla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request migration Any plans, changes, or enhancements needed for migration proposal
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Build] deprecate renamed configurations kavilla/OpenSearch-Dashboards-1
1 participant
@ananzh