Skip to content

Commit 90bf058

Browse files
authored
Updated docs to not include folder creation in s3 mb api call (#690) (#531)
1 parent 087fb29 commit 90bf058

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

SDAccel/docs/Setup_AWS_CLI_and_S3_Bucket.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ The AWS SDAccel scripts require JSON output format and the scripts will not work
88
```
99
$ aws configure # to set your credentials (found in your console.aws.amazon.com page), region (us-east-1) and output (json)
1010
```
11-
This S3 bucket will be used by the AWS SDAccel scripts to upload your DCP to AWS for AFI generation which will be packaged into a tar file.
12-
Start by creating a bucket and a folder within your new bucket:
11+
This S3 bucket will be used by the AWS scripts to upload your DCP to AWS for AFI generation which will be packaged into a tar file.
12+
Start by creating a bucket:
1313
```
1414
$ aws s3 mb s3://<bucket-name> --region us-east-1 # Create an S3 bucket (choose a unique bucket name)
15-
$ aws s3 mb s3://<bucket-name>/<dcp-folder-name> # Create folder for your tarball files
1615
$ touch FILES_GO_HERE.txt # Create a temp file
17-
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Which creates the folder on S3
16+
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Choose a dcp folder name
1817
```
19-
The AFI creation process will generate logs and will be placed in your S3 bucket. These logs can be used for debug if the AFI generation fails.
18+
The AFI creation process will generate logs and will be placed in your S3 bucket. These logs can be used for debug if the AFI generation fails.
2019
Next, create a folder for your log files:
2120
```
22-
$ aws s3 mb s3://<bucket-name>/<logs-folder-name> # Create a folder to keep your logs
2321
$ touch LOGS_FILES_GO_HERE.txt # Create a temp file
24-
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Which creates the folder on S3
22+
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Choose a logs folder name
2523
```
2624
Once your AFI has been created successfully, you are free to delete the tar file and logs as needed. Deleting these files will not delete or modify your AFI.

Vitis/docs/Setup_AWS_CLI_and_S3_Bucket.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ The AWS Vitis scripts require JSON output format and the scripts will not work p
88
```
99
$ aws configure # to set your credentials (found in your console.aws.amazon.com page), region (us-east-1) and output (json)
1010
```
11-
This S3 bucket will be used by the AWS SDAccel scripts to upload your DCP to AWS for AFI generation which will be packaged into a tar file.
12-
Start by creating a bucket and a folder within your new bucket:
11+
This S3 bucket will be used by the AWS scripts to upload your DCP to AWS for AFI generation which will be packaged into a tar file.
12+
Start by creating a bucket:
1313
```
1414
$ aws s3 mb s3://<bucket-name> --region us-east-1 # Create an S3 bucket (choose a unique bucket name)
15-
$ aws s3 mb s3://<bucket-name>/<dcp-folder-name> # Create folder for your tarball files
1615
$ touch FILES_GO_HERE.txt # Create a temp file
17-
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Which creates the folder on S3
16+
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Choose a dcp folder name
1817
```
19-
The AFI creation process will generate logs and will be placed in your S3 bucket. These logs can be used for debug if the AFI generation fails.
18+
The AFI creation process will generate logs and will be placed in your S3 bucket. These logs can be used for debug if the AFI generation fails.
2019
Next, create a folder for your log files:
2120
```
22-
$ aws s3 mb s3://<bucket-name>/<logs-folder-name> # Create a folder to keep your logs
2321
$ touch LOGS_FILES_GO_HERE.txt # Create a temp file
24-
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Which creates the folder on S3
22+
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Choose a logs folder name
2523
```
2624
Once your AFI has been created successfully, you are free to delete the tar file and logs as needed. Deleting these files will not delete or modify your AFI.

0 commit comments

Comments
 (0)