Add documentation for support of AWS SigV4 authorization in Dashboards Data Sources UI (#2942)
* fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2667-sigv4-authz Signed-off-by: cwillum <cwmmoore@amazon.com> --------- Signed-off-by: cwillum <cwmmoore@amazon.com>
This commit is contained in:
parent
a2f3890754
commit
9a729cbc97
|
@ -41,22 +41,45 @@ To create a new data source connection:
|
|||
|
||||
1. Open Dashboards. If you’re not running the security plugin, go to [`http://localhost:5601`](http://localhost:5601/). If you’re running the security plugin, go to [`https://localhost:5601`](https://localhost:5601/) and log in with the username `admin` and password `admin`.
|
||||
|
||||
1. In the Dashboards console, choose **Stack Management** > **Data Sources `Experimental`** > **Data Sources** > **Create data source connection**, as shown in the following image.
|
||||
1. Under **Management** in the OpenSearch Dashboards main menu, choose **Stack Management**, **Data Sources `Experimental`**, **Data Sources**, and then choose **Create data source connection**, as shown in the following image.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-1.png" width=500 alt="Data sources user interface">
|
||||
|
||||
1. Add information to each field to configure **Connection Details**, **Endpoint**, and **Authentication** to connect to a data source, as shown in the following image. For this tutorial, the **Endpoint URL** is `http://localhost:5601/app/management/opensearch-dashboards/dataSources`.
|
||||
1. Add information to each field to configure **Connection Details**, **Endpoint URL**, and **Authentication Method**, as shown in the following image. For this tutorial, the **Endpoint URL** is `http://localhost:5601/app/management/opensearch-dashboards/dataSources`.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-2.png" width=500 alt="Create a data source connection user interface">
|
||||
|
||||
1. Choose **Create data source connection** to save your settings.
|
||||
1. Return to the **Data Sources** main page to confirm that the newly created data source is listed under **Data Sources**, as shown in the following image.
|
||||
In **Connection Details**, enter a title for the connection and the endpoint URL used to connect to the data source. A description of the connection is optional.
|
||||
|
||||
For **Authentication Method**, first select the type of authentication:
|
||||
* **No authentication**: No authentication is used to connect to the data source.
|
||||
* **Username & Password**: A basic username and password are used to connect to the data source.
|
||||
* **AWS SigV4**: An AWS Signature Version 4 authenticating request is used to connect to the data source. AWS SigV4 requires an access key ID and a secret access key. First specify the **Region**, and then enter the **Access Key** and **Secret Key** for authorization. For information on available 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 on SigV4 authentication requests, see [Authenticating Requests (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
|
||||
|
||||
When you select the authentication method, the applicable fields appear for the selected method. Enter the required details.
|
||||
|
||||
After you have entered the appropriate details in all of the required fields, the **Test connection** and **Create data source connection** buttons become active. You can choose **Test connection** to confirm that the connection is valid.
|
||||
|
||||
1. Choose **Create data source connection** to save your settings. The connection is created. The active window returns to the **Data Sources** main page, and the new connection appears in the list of data sources.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-3.png" width=500 alt="Data sources list user interface">
|
||||
|
||||
1. Optional: Select the data source to verify that the settings are configured properly, as shown in the following image.
|
||||
You can also delete the data source connection from this page by selecting the check box to the left of the title and then choosing **Delete 1 connection** to the right of the search bar. Selecting multiple check boxes for multiple connections is also supported.
|
||||
{: .note }
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-4.png" width=500 alt="Data sources settings verification user interface">
|
||||
### Editing and updating a data source connection
|
||||
|
||||
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, as shown in the following image.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-3.5.png" width=500 alt="Data sources settings verification and editing user interface">
|
||||
|
||||
To make changes to **Connection Details**, edit one or both of the **Title** and **Description** fields and choose **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 choose **Save changes** in the lower-right corner of the screen. The changes are saved.
|
||||
|
||||
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 a new password in the first field and then enter it again in the second field to confirm. Choose **Update stored password** in the pop-up window. The new password is saved. Choose **Test connection** in the upper-right corner of the screen to confirm that the connection is valid.
|
||||
|
||||
When **AWS SigV4** is the selected authentication method, you can update the credentials by choosing **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. Choose **Update stored AWS credential** in the pop-up window. The new credentials are saved. Choose **Test connection** in the upper-right corner of the screen to confirm that the connection is valid.
|
||||
|
||||
To delete the data source connection, choose the red trash can icon in the upper-right corner of the screen.
|
||||
|
||||
## Creating an index pattern
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 99 KiB |
Binary file not shown.
After Width: | Height: | Size: 92 KiB |
Binary file not shown.
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 48 KiB |
Binary file not shown.
Before Width: | Height: | Size: 126 KiB |
Loading…
Reference in New Issue