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

Renamed words in /docs/settings/* files. Elastic/elastic not changed. #122

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[role="xpack"]
[[alert-action-settings-kb]]
=== Alerting and action settings in {kib}
[[alert-action-settings-osd]]
=== Alerting and action settings in {osd}
++++
<titleabbrev>Alerting and action settings</titleabbrev>
++++

Alerts and actions are enabled by default in {kib}, but require you configure the following in order to use them:
Alerts and actions are enabled by default in {osd}, but require you configure the following in order to use them:

. <<using-kibana-with-security,Set up {kib} to work with {stack} {security-features}>>.
. <<configuring-tls-kib-es,Set up TLS encryption between {kib} and {es}>>.
. <<using-opensearch-dashboards-with-security,Set up {osd} to work with {stack} {security-features}>>.
. <<configuring-tls-osd-opensearch,Set up TLS encryption between {osd} and {opensearch}>>.
. If you are using an *on-premises* Elastic Stack deployment, <<general-alert-action-settings,specify a value for `xpack.encryptedSavedObjects.encryptionKey`>>.

You can configure the following settings in the `kibana.yml` file.
You can configure the following settings in the `opensearch_dashboards.yml` file.


[float]
Expand All @@ -22,11 +22,11 @@ You can configure the following settings in the `kibana.yml` file.
|===

| `xpack.encryptedSavedObjects.encryptionKey`
| A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {es}. Third party credentials &mdash; such as the username and password used to connect to an SMTP service &mdash; are an example of encrypted properties. +
| A string of 32 or more characters used to encrypt sensitive properties on alerts and actions before they're stored in {opensearch}. Third party credentials &mdash; such as the username and password used to connect to an SMTP service &mdash; are an example of encrypted properties. +
+
If not set, {kib} will generate a random key on startup, but all alert and action functions will be blocked. Generated keys are not allowed for alerts and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerts and actions in high-availability deployments of {kib} will behave unexpectedly if the key isn't the same on all instances of {kib}. +
If not set, {osd} will generate a random key on startup, but all alert and action functions will be blocked. Generated keys are not allowed for alerts and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerts and actions in high-availability deployments of {osd} will behave unexpectedly if the key isn't the same on all instances of {osd}. +
+
Although the key can be specified in clear text in `kibana.yml`, it's recommended to store this key securely in the <<secure-settings,{kib} Keystore>>.
Although the key can be specified in clear text in `opensearch_dashboards.yml`, it's recommended to store this key securely in the <<secure-settings,{osd} Keystore>>.
Be sure to back up the encryption key value somewhere safe, as your alerts and actions will cease to function due to decryption failures should you lose it. If you want to rotate the encryption key, be sure to follow the instructions on <<encryption-key-rotation, encryption key rotation>>.

|===
Expand All @@ -38,20 +38,20 @@ You can configure the following settings in the `kibana.yml` file.
[cols="2*<"]
|===

| `xpack.actions.allowedHosts` {ess-icon}
| A list of hostnames that {kib} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly added to the allowed hosts. An empty list `[]` can be used to block built-in actions from making any external connections. +
| `xpack.actions.allowedHosts` {opensearchs-icon}
| A list of hostnames that {osd} is allowed to connect to when built-in actions are triggered. It defaults to `[*]`, allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly added to the allowed hosts. An empty list `[]` can be used to block built-in actions from making any external connections. +
+
Note that hosts associated with built-in actions, such as Slack and PagerDuty, are not automatically added to allowed hosts. If you are not using the default `[*]` setting, you must ensure that the corresponding endpoints are added to the allowed hosts as well.

| `xpack.actions.enabledActionTypes` {ess-icon}
| A list of action types that are enabled. It defaults to `[*]`, enabling all types. The names for built-in {kib} action types are prefixed with a `.` and include: `.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, and `.webhook`. An empty list `[]` will disable all action types. +
| `xpack.actions.enabledActionTypes` {opensearchs-icon}
| A list of action types that are enabled. It defaults to `[*]`, enabling all types. The names for built-in {osd} action types are prefixed with a `.` and include: `.server-log`, `.slack`, `.email`, `.index`, `.pagerduty`, and `.webhook`. An empty list `[]` will disable all action types. +
+
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {kib} and will not function.
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {osd} and will not function.

|===

[float]
[[alert-settings]]
==== Alert settings

You do not need to configure any additional settings to use alerting in {kib}.
You do not need to configure any additional settings to use alerting in {osd}.
28 changes: 14 additions & 14 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[apm-settings-kb]]
=== APM settings in Kibana
[[apm-settings-osd]]
=== APM settings in OpenSearchDashboards
++++
<titleabbrev>APM settings</titleabbrev>
++++
Expand All @@ -16,31 +16,31 @@ you do not need to configure any settings to use the APM app.
It is enabled by default.

[float]
[[apm-indices-settings-kb]]
[[apm-indices-settings-osd]]
==== APM indices

// This content is reused in the APM app documentation.
// Any changes made in this file will be seen there as well.
// tag::apm-indices-settings[]

Index defaults can be changed in Kibana. Open the main menu, then click *APM > Settings > Indices*.
Index settings in the APM app take precedence over those set in `kibana.yml`.
Index defaults can be changed in OpenSearchDashboards. Open the main menu, then click *APM > Settings > Indices*.
Index settings in the APM app take precedence over those set in `opensearch_dashboards.yml`.

[role="screenshot"]
image::settings/images/apm-settings.png[APM app settings in Kibana]
image::settings/images/apm-settings.png[APM app settings in OpenSearchDashboards]

// end::apm-indices-settings[]

[float]
[[general-apm-settings-kb]]
[[general-apm-settings-osd]]
==== General APM settings

// This content is reused in the APM app documentation.
// Any changes made in this file will be seen there as well.
// tag::general-apm-settings[]

If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
copy and paste the relevant settings into your `opensearch_dashboards.yml` configuration file.
Changing these settings may disable features of the APM App.

[cols="2*<"]
Expand All @@ -54,13 +54,13 @@ Changing these settings may disable features of the APM App.
| `xpack.apm.serviceMapFingerprintGlobalBucketSize`
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.

| `xpack.apm.ui.enabled` {ess-icon}
| `xpack.apm.ui.enabled` {opensearchs-icon}
| Set to `false` to hide the APM app from the main menu. Defaults to `true`.

| `xpack.apm.ui.transactionGroupBucketSize`
| Number of top transaction groups displayed in the APM app. Defaults to `1000`.

| `xpack.apm.ui.maxTraceItems` {ess-icon}
| `xpack.apm.ui.maxTraceItems` {opensearchs-icon}
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.

| `xpack.observability.annotations.index`
Expand All @@ -70,20 +70,20 @@ Changing these settings may disable features of the APM App.
| experimental[] Enables Transaction histogram metrics. Defaults to `false`. When `true`, additional configuration in APM Server is required.
See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.

| `apm_oss.indexPattern` {ess-icon}
| `apm_oss.indexPattern` {opensearchs-icon}
| The index pattern used for integrations with Machine Learning and Query Bar.
It must match all apm indices. Defaults to `apm-*`.

| `apm_oss.errorIndices` {ess-icon}
| `apm_oss.errorIndices` {opensearchs-icon}
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.

| `apm_oss.onboardingIndices`
| Matcher for all onboarding indices. Defaults to `apm-*`.

| `apm_oss.spanIndices` {ess-icon}
| `apm_oss.spanIndices` {opensearchs-icon}
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.

| `apm_oss.transactionIndices` {ess-icon}
| `apm_oss.transactionIndices` {opensearchs-icon}
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.

| `apm_oss.metricsIndices`
Expand Down
8 changes: 4 additions & 4 deletions docs/settings/dev-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[role="xpack"]
[[dev-settings-kb]]
=== Development tools settings in {kib}
[[dev-settings-osd]]
=== Development tools settings in {osd}
++++
<titleabbrev>Development tools settings</titleabbrev>
++++

You do not need to configure any settings to use the development tools in {kib}.
You do not need to configure any settings to use the development tools in {osd}.
They are enabled by default.

[float]
Expand All @@ -14,7 +14,7 @@ They are enabled by default.

[cols="2*<"]
|===
| `xpack.grokdebugger.enabled` {ess-icon}
| `xpack.grokdebugger.enabled` {opensearchs-icon}
| Set to `true` to enable the <<xpack-grokdebugger,Grok Debugger>>. Defaults to `true`.

|===
Expand Down
24 changes: 12 additions & 12 deletions docs/settings/fleet-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
[role="xpack"]
[[fleet-settings-kb]]
=== {fleet} settings in {kib}
[[fleet-settings-osd]]
=== {fleet} settings in {osd}
++++
<titleabbrev>{fleet} settings</titleabbrev>
++++

experimental[]

You can configure `xpack.fleet` settings in your `kibana.yml`.
By default, {fleet} is enabled. To use {fleet}, you also need to configure {kib} and {es} hosts.
You can configure `xpack.fleet` settings in your `opensearch_dashboards.yml`.
By default, {fleet} is enabled. To use {fleet}, you also need to configure {osd} and {opensearch} hosts.

See the {fleet-guide}/index.html[{fleet}] docs for more information.

[[general-fleet-settings-kb]]
[[general-fleet-settings-osd]]
==== General {fleet} settings

[cols="2*<"]
|===
| `xpack.fleet.enabled` {ess-icon}
| `xpack.fleet.enabled` {opensearchs-icon}
| Set to `true` (default) to enable {fleet}.
| `xpack.fleet.agents.enabled` {ess-icon}
| `xpack.fleet.agents.enabled` {opensearchs-icon}
| Set to `true` (default) to enable {fleet}.
|===

Expand All @@ -37,12 +37,12 @@ See the {fleet-guide}/index.html[{fleet}] docs for more information.

[cols="2*<"]
|===
| `xpack.fleet.agents.kibana.host`
| The hostname used by {agent} for accessing {kib}.
| `xpack.fleet.agents.elasticsearch.host`
| The hostname used by {agent} for accessing {es}.
| `xpack.fleet.agents.opensearchDashboards.host`
| The hostname used by {agent} for accessing {osd}.
| `xpack.fleet.agents.opensearch.host`
| The hostname used by {agent} for accessing {opensearch}.
| `xpack.fleet.agents.tlsCheckDisabled`
| Set to `true` to allow {fleet} to run on a {kib} instance without TLS enabled.
| Set to `true` to allow {fleet} to run on a {osd} instance without TLS enabled.
|===

[NOTE]
Expand Down
4 changes: 2 additions & 2 deletions docs/settings/general-infra-logs-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[cols="2*<"]
|===
| `xpack.infra.enabled`
| Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`.
| Set to `false` to disable the Logs and Metrics app plugin {osd}. Defaults to `true`.

| `xpack.infra.sources.default.logAlias`
| Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.
| Index pattern for matching indices that contain log data. Defaults to `filebeat-*,opensearch_dashboards_sample_data_logs*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.

| `xpack.infra.sources.default.metricAlias`
| Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.
Expand Down
6 changes: 3 additions & 3 deletions docs/settings/graph-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[graph-settings-kb]]
=== Graph settings in {kib}
[[graph-settings-osd]]
=== Graph settings in {osd}
++++
<titleabbrev>Graph settings</titleabbrev>
++++
Expand All @@ -13,7 +13,7 @@ You do not need to configure any settings to use the {graph-features}.

[cols="2*<"]
|===
| `xpack.graph.enabled` {ess-icon}
| `xpack.graph.enabled` {opensearchs-icon}
| Set to `false` to disable the {graph-features}.

|===
10 changes: 5 additions & 5 deletions docs/settings/i18n-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
[role="xpack"]
[[i18n-settings-kb]]
=== i18n settings in {kib}
[[i18n-settings-osd]]
=== i18n settings in {osd}
++++
<titleabbrev>i18n settings</titleabbrev>
++++

You do not need to configure any settings to run Kibana in English.
You do not need to configure any settings to run OpenSearchDashboards in English.

[float]
[[general-i18n-settings-kb]]
[[general-i18n-settings-osd]]
==== General i18n settings

`i18n.locale`::
{kib} supports the following locales:
{osd} supports the following locales:
* English - `en` (default)
* Chinese - `zh-CN`
* Japanese - `ja-JP`
8 changes: 4 additions & 4 deletions docs/settings/infrastructure-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[role="xpack"]
[[infrastructure-ui-settings-kb]]
=== Metrics settings in {kib}
[[infrastructure-ui-settings-osd]]
=== Metrics settings in {osd}
++++
<titleabbrev>Metrics settings</titleabbrev>
++++

You do not need to configure any settings to use the Metrics app in {kib}. It is enabled by default.
You do not need to configure any settings to use the Metrics app in {osd}. It is enabled by default.

[float]
[[general-infra-ui-settings-kb]]
[[general-infra-ui-settings-osd]]
==== General Metrics settings

include::general-infra-logs-ui-settings.asciidoc[]
8 changes: 4 additions & 4 deletions docs/settings/logs-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[role="xpack"]
[[logs-ui-settings-kb]]
=== Logs settings in {kib}
[[logs-ui-settings-osd]]
=== Logs settings in {osd}
++++
<titleabbrev>Logs settings</titleabbrev>
++++

You do not need to configure any settings to use the Logs app in {kib}. It is enabled by default.
You do not need to configure any settings to use the Logs app in {osd}. It is enabled by default.

[float]
[[general-logs-ui-settings-kb]]
[[general-logs-ui-settings-osd]]
==== General Logs settings

include::general-infra-logs-ui-settings.asciidoc[]
22 changes: 11 additions & 11 deletions docs/settings/ml-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
[role="xpack"]
[[ml-settings-kb]]
=== Machine learning settings in {kib}
[[ml-settings-osd]]
=== Machine learning settings in {osd}
++++
<titleabbrev>Machine learning settings</titleabbrev>
++++

You do not need to configure any settings to use {kib} {ml-features}. They are
You do not need to configure any settings to use {osd} {ml-features}. They are
enabled by default.

[[general-ml-settings-kb]]
[[general-ml-settings-osd]]
==== General {ml} settings

[cols="2*<"]
|===
| `xpack.ml.enabled` {ess-icon}
| Set to `true` (default) to enable {kib} {ml-features}. +
| `xpack.ml.enabled` {opensearchs-icon}
| Set to `true` (default) to enable {osd} {ml-features}. +
+
If set to `false` in `kibana.yml`, the {ml} icon is hidden in this {kib}
instance. If `xpack.ml.enabled` is set to `true` in `elasticsearch.yml`, however,
If set to `false` in `opensearch_dashboards.yml`, the {ml} icon is hidden in this {osd}
instance. If `xpack.ml.enabled` is set to `true` in `opensearch.yml`, however,
you can still use the {ml} APIs. To disable {ml} entirely, see the
{ref}/ml-settings.html[{es} {ml} settings].
{ref}/ml-settings.html[{opensearch} {ml} settings].

|===

[[advanced-ml-settings-kb]]
[[advanced-ml-settings-osd]]
==== Advanced {ml} settings

Refer to <<kibana-ml-settings,Advanced {ml} settings in {kib}>>.
Refer to <<opensearch-dashboards-ml-settings,Advanced {ml} settings in {osd}>>.
Loading