You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _dashboards/management/multi-data-sources.md
+46-11
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,6 @@ redirect_from:
11
11
12
12
You can ingest, process, and analyze data from multiple data sources in OpenSearch Dashboards. You configure the data sources in the **Dashboards Management** > **Data sources** app, as shown in the following image.
13
13
14
-
15
14
<imgsrc="{{site.url}}{{site.baseurl}}/images/dashboards/data-sources-management.png"alt="Dashboards Management Data sources main screen"width="700">
16
15
17
16
## Getting started
@@ -23,11 +22,11 @@ The following tutorial guides you through configuring and using multiple data so
23
22
To use multiple data sources, you must enable the `data_source.enabled` setting. It is disabled by default. To enable multiple data sources:
24
23
25
24
1. Open your local copy of the OpenSearch Dashboards configuration file, `opensearch_dashboards.yml`. If you don't have a copy, [`opensearch_dashboards.yml`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/config/opensearch_dashboards.yml) is available on GitHub.
26
-
2. Set `data_source.enabled:` to `true` and save the YAML file.
25
+
2. Set `data_source.enabled:` to `true` and save the YAML file.
27
26
3. Restart the OpenSearch Dashboards container.
28
27
4. Verify that the configuration settings were configured properly by connecting to OpenSearch Dashboards and viewing the **Dashboards Management** navigation menu. **Data sources** appears in the sidebar. You'll see a view similar to the following image.
29
28
30
-
<imgsrc="{{site.url}}{{site.baseurl}}/images/dashboards/multidatasources.png"alt="Data sources in sidebar within Dashboards Management"width="700">
29
+
<imgsrc="{{site.url}}{{site.baseurl}}/images/dashboards/multidatasources.png"alt="Data sources in sidebar within Dashboards Management"width="700">
31
30
32
31
### Step 2: Create a new data source connection
33
32
@@ -36,14 +35,15 @@ A data source connection specifies the parameters needed to connect to a data so
36
35
To create a new data source connection:
37
36
38
37
1. From the OpenSearch Dashboards main menu, select **Dashboards Management** > **Data sources** > **Create data source connection**.
38
+
39
39
2. Add the required information to each field to configure the **Connection Details** and **Authentication Method**.
40
40
41
41
- Under **Connection Details**, enter a title and endpoint URL. For this tutorial, use the URL `http://localhost:5601/app/management/opensearch-dashboards/dataSources`. Entering a description is optional.
42
42
43
43
- Under **Authentication Method**, select an authentication method from the dropdown list. Once an authentication method is selected, the applicable fields for that method appear. You can then enter the required details. The authentication method options are:
44
-
-**No authentication**: No authentication is used to connect to the data source.
45
-
-**Username & Password**: A basic username and password are used to connect to the data source.
46
-
-**AWS SigV4**: An AWS Signature Version 4 authenticating request is used to connect to the data source. AWS Signature Version 4 requires an access key and a secret key.
44
+
-**No authentication**: No authentication is used to connect to the data source.
45
+
-**Username & Password**: A basic username and password are used to connect to the data source.
46
+
-**AWS SigV4**: An AWS Signature Version 4 authenticating request is used to connect to the data source. AWS Signature Version 4 requires an access key and a secret key.
47
47
- For AWS Signature Version 4 authentication, first specify the **Region**. Next, select the OpenSearch service from the **Service Name** list. The options are **Amazon OpenSearch Service** and **Amazon OpenSearch Serverless**. Last, enter the **Access Key** and **Secret Key** for authorization.
48
48
49
49
For information about available AWS Regions for AWS accounts, see [Available Regions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions). For more information about AWS Signature Version 4 authentication requests, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
@@ -58,12 +58,11 @@ To create a new data source connection:
58
58
- To make changes to the data source connection, select a connection in the list on the **Data Sources** main page. The **Connection Details** window opens.
59
59
60
60
- To make changes to **Connection Details**, edit one or both of the **Title** and **Description** fields and select **Save changes** in the lower-right corner of the screen. You can also cancel changes here. To change the **Authentication Method**, choose a different authentication method, enter your credentials (if applicable), and then select **Save changes** in the lower-right corner of the screen. The changes are saved.
61
-
61
+
62
62
- When **Username & Password** is the selected authentication method, you can update the password by choosing **Update stored password** next to the **Password** field. In the pop-up window, enter a new password in the first field and then enter it again in the second field to confirm. Select **Update stored password** in the pop-up window. The new password is saved. Select **Test connection** to confirm that the connection is valid.
63
-
64
63
- When **AWS SigV4** is the selected authentication method, you can update the credentials by selecting **Update stored AWS credential**. In the pop-up window, enter a new access key in the first field and a new secret key in the second field. Select **Update stored AWS credential** in the pop-up window. The new credentials are saved. Select **Test connection** in the upper-right corner of the screen to confirm that the connection is valid.
65
64
66
-
5. Delete the data source connection by selecting the check box to the left of the title and then choosing **Delete 1 connection**. Selecting multiple check boxes for multiple connections is supported. Alternatively, select the trash can icon ({::nomarkdown}<imgsrc="{{site.url}}{{site.baseurl}}/images/dashboards/trash-can-icon.png"class="inline-icon"alt="trash can icon"/>{:/}).
65
+
5. Delete the data source connection by selecting the check box to the left of the title and then choosing **Delete 1 connection**. Selecting multiple check boxes for multiple connections is supported. Alternatively, select the {::nomarkdown}<imgsrc="{{site.url}}{{site.baseurl}}/images/dashboards/trash-can-icon.png"class="inline-icon"alt="trash can icon"/>{:/} icon.
67
66
68
67
An example data source connection screen is shown in the following image.
69
68
@@ -93,11 +92,13 @@ To select a data source through the Dev Tools console, follow these steps:
93
92
6. Repeat the preceding steps for each data source you want to select.
94
93
95
94
### Upload saved objects to a dashboard from connected data sources
96
-
To upload saved objects from connected data sources to a dashboard with multiple data sources, export them as an NDJSON file from the data source's **Saved object management** page. Then upload the file to the dashboard's **Saved object management** page. This method can make it easier to transfer saved objects between dashboards. The following 20-second video shows this feature in action.
97
95
96
+
To upload saved objects from connected data sources to a dashboard with multiple data sources, export them as an NDJSON file from the data source's **Saved object management** page. Then upload the file to the dashboard's **Saved object management** page. This method can simplify the transfer of saved objects between dashboards. The following 20-second video shows this feature in action.
98
97
99
98
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/import_saved_objects_with_file_upload.gif" alt="Multiple data sources in Saved object management">{: .img-fluid}
100
99
100
+
#### Import saved objects from a connected data source
101
+
101
102
Follow these steps to import saved objects from a connected data source:
102
103
103
104
1. Locate your `opensearch_dashboards.yml` file and open it in your preferred text editor.
@@ -106,7 +107,41 @@ Follow these steps to import saved objects from a connected data source:
106
107
4. Select **Import** > **Select file** and upload the file acquired from the connected data source.
107
108
5. Choose the appropriate **Data source** from the dropdown menu, set your **Conflict management** option, and then select the **Import** button.
108
109
109
-
## Next steps
110
+
### Show or hide authentication methods for multiple data sources
111
+
Introduced 2.13
112
+
{: .label .label-purple }
113
+
114
+
A feature flag in your `opensearch_dashboards.yml` file allows you to show or hide authentication methods within the `data_source` plugin. The following example setting, shown in a 10-second demo, hides the authentication method for `AWSSigV4`.
115
+
116
+
````
117
+
# Set enabled to false to hide the authentication method from multiple data source in OpenSearch Dashboards.
118
+
# If this setting is commented out, then all three options will be available in OpenSearch Dashboards.
119
+
# The default value will be considered as true.
120
+
data_source.authTypes:
121
+
NoAuthentication:
122
+
enabled: true
123
+
UsernamePassword:
124
+
enabled: true
125
+
AWSSigV4:
126
+
enabled: false
127
+
````
128
+
129
+
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/multidata-hide-show-auth.gif" alt="Multiple data sources hide and show authentication">{: .img-fluid}
130
+
131
+
### Hide the local cluster option for multiple data sources
132
+
Introduced 2.13
133
+
{: .label .label-purple }
134
+
135
+
A feature flag in your `opensearch_dashboards.yml` file allows you to hide the local cluster option within the `data_source` plugin. This option hides the local cluster from the data source dropdown menu and index creation page, which is ideal for environments with or without a local OpenSearch cluster. The following example setting, shown in a 20-second demo, hides the local cluster.
136
+
137
+
````
138
+
# hide local cluster in the data source dropdown and index pattern creation page.
139
+
data_source.hideLocalCluster: true
140
+
````
141
+
142
+
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/multidata-hide-localcluster.gif" alt="Multiple data sources hide local cluster">{: .img-fluid}
143
+
144
+
## Next steps
110
145
111
146
Once you've configured your multiple data sources, you can start exploring that data. See the following resources to learn more:
0 commit comments