-
Notifications
You must be signed in to change notification settings - Fork 60
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
Migrate wazuh.yml configuration to opensearch_dashboard.yml #339
Migrate wazuh.yml configuration to opensearch_dashboard.yml #339
Comments
Moving the host's config to the opensearch_dashboards.ymlWhen we move the config from Afterwazuh_core.hosts:
manager:
url: 'https://wazuh.manager'
port: 55000
username: wazuh-wui
password: API_PASSWORD
run_as: false
Beforehosts:
- manager:
url: 'https://wazuh.manager'
port: 55000
username: wazuh-wui
password: API_PASSWORD
run_as: false
|
Configuration ManagementThere are various types of configurations, including global and context-specific (plugin). Currently, the configuration located in the When transferring the configuration to the The configurations defined to date are as follows: export const PLUGIN_SETTINGS = {
'alerts.sample.prefix': {
title: 'Sample alerts prefix',
description: 'Define the index name prefix of sample alerts. It must match the template used by the index pattern to avoid unknown fields in dashboards.',
},
'checks.api': {
title: 'API connection',
description: 'Enable or disable the API health check when opening the app.',
},
'checks.fields': {
title: 'Known fields',
description: 'Enable or disable the known fields health check when opening the app.',
},
'checks.maxBuckets': {
title: 'Set max buckets to 200000',
description: 'Change the default value of the plugin platform max buckets configuration.',
},
'checks.metaFields': {
title: 'Remove meta fields',
description: 'Change the default value of the plugin platform metaField configuration.',
},
'checks.pattern': {
title: 'Index pattern',
description: 'Enable or disable the index pattern health check when opening the app.',
},
'checks.setup': {
title: 'API version',
description: 'Enable or disable the setup health check when opening the app.',
},
'checks.template': {
title: 'Index template',
description: 'Enable or disable the template health check when opening the app.',
},
'checks.timeFilter': {
title: 'Set time filter to 24h',
description: 'Change the default value of the plugin platform timeFilter configuration.',
},
'configuration.ui_api_editable': {
title: 'Configuration UI editable',
description: 'Enable or disable the ability to edit the configuration from UI or API endpoints. When disabled, this can only be edited from the configuration file, the related API endpoints are disabled, and the UI is inaccessible.',
},
'cron.prefix': {
title: 'Cron prefix',
description: 'Define the index prefix of predefined jobs.',
},
'cron.statistics.apis': {
title: 'Includes APIs',
description: 'Enter the ID of the hosts you want to save data from, leave this empty to run the task on every host.',
},
'customization.enabled': {
title: 'Status',
description: 'Enable or disable the customization.',
},
'enrollment.dns': {
title: 'Enrollment DNS',
description: 'Specifies the Wazuh registration server, used for the agent enrollment.',
},
'enrollment.password': {
title: 'Enrollment password',
description: 'Specifies the password used to authenticate during the agent enrollment.',
},
hideManagerAlerts: {
title: 'Hide manager alerts',
description: 'Hide the alerts of the manager in every dashboard.',
},
hosts: {
title: 'Server hosts',
description: 'Configure the API connections.',
},
'ip.ignore': {
title: 'Index pattern ignore',
description: 'Disable certain index pattern names from being available in index pattern selector.',
},
'ip.selector': {
title: 'IP selector',
description: 'Define if the user is allowed to change the selected index pattern directly from the top menu bar.'
},
'wazuh.updates.disabled': {
title: 'Check updates',
description: 'Define if the check updates service is active.'
},
'timeout': {
title: 'Request timeout'
},
'wazuh.monitoring.creation': {
title: 'Index creation',
description: 'Define the interval in which a new wazuh-monitoring index will be created.'
},
'wazuh.monitoring.enabled': {
title: 'Status',
description: 'Enable or disable the wazuh-monitoring index creation and/or visualization.'
},
'wazuh.monitoring.frequency': {
title: 'Frequency',
description: 'Frequency, in seconds, of API requests to get the state of the agents and create a new document in the wazuh-monitoring index with this data.'
},
'wazuh.monitoring.pattern': {
title: 'Index pattern',
description: 'Default index pattern to use for Wazuh monitoring.'
},
'wazuh.monitoring.replicas': {
title: 'Index replicas',
description: 'Define the number of replicas to use for the wazuh-monitoring-* indices.'
},
'wazuh.monitoring.shards': {
title: 'Index shards',
description: 'Define the number of shards to use for the wazuh-monitoring-* indices.'
},
'vulnerabilities.pattern': {
title: 'Index pattern',
description: 'Default index pattern to use for vulnerabilities.'
}
} Configuration Availability TypesIt is also important to define the availability requirements for each type of configuration. We can categorize them into several types:
Categorizing ConfigurationsThese criteria necessitate categorizing all available configurations to decide which implementation approach to use. Here are some options:
Configuration Overview TableHere’s a table summarizing the types of configurations and their characteristics:
This table provides a clear overview of the different types of configurations, their descriptions, and possible implementation options, making it easier to understand and decide on the appropriate approach for configuration management. |
Configurations categorizationsSteps to transform the JSON into a Markdown table:
|
Tasks
|
Transform the plugin settings to ui settings
Screen.Recording.2024-12-16.at.6.31.37.PM.mov
Screen.Recording.2024-12-17.at.3.01.58.PM.movDetails on: wazuh/wazuh-dashboard-plugins@bced596 |
Description
As part of the Reporting revamp objective, we need to migrate
wazuh.yml
configuration toopensearch_dashboard.yml
file. Moreover, we want to rename theopensearch_dashboard.yml
file towazuh_dashboard.yml
.Objective
References
The text was updated successfully, but these errors were encountered: