Skip to content

Commit 1e87d70

Browse files
authored
Update README.md: Updates installation, configuration and authentication (#300)
1 parent 6c4229b commit 1e87d70

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,42 @@ The Athena data source plugin allows you to query and visualize Athena data metr
88

99
This topic explains options, variables, querying, and other options specific to this data source. Refer to [Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) for instructions on how to add a data source to Grafana.
1010

11+
## Installation
12+
13+
### Grafana Cloud
14+
15+
If you do not have a [Grafana Cloud](https://grafana.com/cloud) account, you can sign up for one [here](https://grafana.com/cloud/grafana).
16+
17+
1. Click on the `Install plugin` button on the [AWS Athena page on Grafana.com](https://grafana.com/grafana/plugins/grafana-athena-datasource/). This will automatically add the plugin to your Grafana instance. It might take up to 30 seconds to install.
18+
19+
2. Login to your Hosted Grafana instance (go to your instances page in your profile): `https://grafana.com/orgs/<yourUserName>/instances` and the AWS Athena data source will be installed.
20+
1121
## Configure the data source in Grafana
1222

13-
To access data source settings:
23+
To configure the Athena data source in Grafana, toggle the menu, open **Connections**, then click **Data Sources** and then either
1424

15-
1. Hover your mouse over the **Configuration** (gear) icon.
16-
1. Click **Data sources**, and then click the AWS Athena data source.
25+
* click **Add new data source**, and then click the AWS Athena data source, if you do not have the AWS Athena data source or
26+
* click Athena if you already have the AWS Athena data source.
1727

1828
| Name | Description |
1929
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2030
| `Name` | The data source name. This is how you refer to the data source in panels and queries. |
2131
| `Default` | Default data source means that it will be pre-selected for new panels. |
22-
| `Auth Provider` | Specify the provider to get credentials. |
23-
| `Access Key ID` | If `Access & secret key` is selected, specify the Access Key of the security credentials to use. |
24-
| `Secret Access Key` | If `Access & secret key` is selected, specify the Secret Key of the security credentials to use. |
25-
| `Credentials Profile Name` | Specify the name of the profile to use (if you use `~/.aws/credentials` file), leave blank for default. |
32+
| `Authentication Provider` | Specify which AWS Credentials chain to use. |
2633
| `Assume Role Arn` (optional) | Specify the ARN of the role to assume. |
2734
| `External ID` (optional) | If you are assuming a role in another account, that has been created with an external ID, specify the external ID here. |
2835
| `Endpoint` (optional) | Optionally, specify a custom endpoint for the service. |
2936
| `Default Region` | Region in which the cluster is deployed. |
30-
| `Catalog (datasource)` | Athena catalog. The list of catalogs will be retrieved automatically. |
37+
| `Data Source` | Athena catalog. The list of catalogs will be retrieved automatically. |
3138
| `Database` | Name of the database within the catalog. |
3239
| `Workgroup` | Workgroup to use. |
3340
| `Output Location` | AWS S3 bucket to store execution outputs. If not specified, the default query result location from the Workgroup configuration will be used. Please note that if [`Override client-side settings`](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html?icmpid=docs_console_unmapped) is enabled in the AWS console, `Output Location` will be ignored. |
3441

3542
## Authentication
3643

37-
For authentication options and configuration details, see [AWS authentication](https://grafana.com/docs/grafana/next/datasources/aws-cloudwatch/aws-authentication/) topic.
44+
Open source Grafana enables the 'AWS SDK Default', 'Credentials file', and 'Access and secret key' authentication provider methods by default. Grafana Cloud enables 'Access and secret' by default. See [select an authentication method](https://grafana.com/docs/grafana/next/datasources/aws-cloudwatch/aws-authentication/#select-an-authentication-method) for more details.
45+
46+
For more information about authentication options and configuration details, see [AWS authentication](https://grafana.com/docs/grafana/next/datasources/aws-cloudwatch/aws-authentication/) topic.
3847

3948
### IAM policies
4049

0 commit comments

Comments
 (0)