Skip to content

Commit b9e7fc8

Browse files
committed
readme updates
1 parent 42129c5 commit b9e7fc8

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

+22-23
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ By default, data extraction is performed every hour, extracting samples aggregat
88

99
S3 exporter is based on a Go lambda function triggered by periodic event from EventBridge.
1010
Job is configured to extract samples for a 60min time window with the default resolution of 5min.
11-
One file is created per execution, containing all samples for selected things. Time series samples are exported at UTC timezone.
12-
By default, all Arduino things present in the account are exported: it is possible to filter them via tags configuration.
11+
One file is created per execution and contains all samples for selected things. Time series samples are exported at UTC timezone.
12+
By default, all Arduino things present in the account are exported: it is possible to filter them via [tags](#tag-filtering).
1313

1414
CSV produced has the following structure:
1515
```console
@@ -20,7 +20,7 @@ timestamp,thing_id,thing_name,property_id,property_name,property_type,value
2020
2024-09-04T11:03:00Z,07846f3c-37ae-4722-a3f5-65d7b4449ad3,H7,137c02d0-b50f-47fb-a2eb-b6d23884ec51,m3,FLOAT,15
2121
```
2222

23-
Files are organized in S3 bucket by date and files of the same day are grouped.
23+
Files are organized by date and files of the same day are grouped.
2424
```
2525
<bucket>:2024-09-04/2024-09-04-10.csv
2626
<bucket>:2024-09-04/2024-09-04-11.csv
@@ -31,39 +31,39 @@ Files are organized in S3 bucket by date and files of the same day are grouped.
3131

3232
It is possible to deploy required resources via [cloud formation template](deployment/cloud-formation-template/deployment.yaml)
3333

34-
CFT deployment requires:
35-
* an AWS account with rights for creating a new CFT stack. Account must have rights to create:
36-
* S3 buckets
37-
* IAM Roles
38-
* Lambda functions
39-
* EventBridge rules
40-
* SSM parameters (Parameter store)
34+
AWS user must have permissions to:
35+
* create a new CFT stack (policy: AWSCloudFormationFullAccess)
36+
* S3 buckets (policy: AmazonS3FullAccess)
37+
* IAM Roles (policy: IAMFullAccess)
38+
* Lambda functions (policy: AWSLambda_FullAccess)
39+
* EventBridge rules (policy: AmazonEventBridgeFullAccess)
40+
* SSM parameters (Parameter store) (policy: AmazonSSMFullAccess)
4141

42-
Before stack creation, two S3 buckets has to be created:
42+
Before stack creation, two S3 buckets have to be created:
4343
* a temporary bucket where lambda binaries and CFT can be uploaded
4444
* CSVs destination bucket, where all generated file will be uploaded
4545
bucket must be in the same region where stack will be created.
4646

47-
To deploy stack, follow these steps:
47+
Follow these steps to deploy a new stack:
4848
* download [lambda code binaries](deployment/binaries/arduino-s3-integration-lambda.zip) and [Cloud Formation Template](deployment/cloud-formation-template/deployment.yaml)
49-
* Upload CFT and binary zip file on an S3 bucket accessible by the AWS account. For the CFT yaml file, copy the Object URL (it will be required in next step).
49+
* upload CFT and binary zip file on an S3 bucket accessible by the AWS account. For the CFT yaml file, copy the Object URL (it will be required in next step).
5050

5151
![object URL](docs/objecturl.png)
5252

53-
* Start creation of a new cloud formation stack. Follow these steps:
53+
* start creation of a new cloud formation stack
5454

5555
![CFT 1](docs/cft-stack-1.png)
5656

57-
* Fill all required parameters.
57+
* fill all required parameters.
5858
<br/>**Mandatory**: Arduino API key and secret, S3 bucket where code has been uploaded, destination S3 bucket
5959
<br/>**Optional**: tag filter for filtering things, organization identifier and samples resolution
6060

6161
![CFT 2](docs/cft-stack-2.png)
6262

6363
### Configuration parameters
6464

65-
Here is a list of all configuration properties available in 'Parameter store'.
66-
These parameters are filled by CFT and can be adjusted later in case of need (for example, API keys rotation)
65+
Here is a list of all configuration properties supported by exporter. It is possible to edit them in AWS Parameter store.
66+
These parameters are filled by CFT at stack creation time and can be adjusted later in case of need (for example, API keys rotation)
6767

6868
| Parameter | Description |
6969
| --------- | ----------- |
@@ -76,17 +76,16 @@ These parameters are filled by CFT and can be adjusted later in case of need (fo
7676

7777
### Tag filtering
7878

79-
It is possible to filter only the Things of interest.
80-
You can use tag filtering if you need to reduce data export to a specific set of Things.
79+
It is possible to filter only the Arduino Things of interest.
80+
You can use tag filtering if you need to reduce export to a specific set of Things.
8181

82-
* Add a tag in Arduino Cloud UI on all Things you want to export. To do that, select a thing and go in 'metadata' section and add a new tag.
82+
* Add a tag in Arduino Cloud UI on all Things you want to export. To do that, select a thing, go in 'Metadata' section and 'Add' a new tag.
8383

84+
![tag 2](docs/tag-2.png)
8485

8586
![tag 1](docs/tag-1.png)
8687

87-
![tag 2](docs/tag-2.png)
88-
89-
* Configure tag filter during CFT creation of by editing '/arduino/s3-importer/iot/filter/tags' parameter.
88+
* Configure tag filter during CFT creation of by editing '/arduino/s3-importer/iot/filter/tags' parameter (syntax: tag1=value1,tag2=value2).
9089

9190
![tag filter](docs/tag-filter.png)
9291

0 commit comments

Comments
 (0)