Skip to content

Commit

Permalink
Updated docs to not include folder creation in s3 mb api call (#690) (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
deeppat authored Aug 6, 2021
1 parent 087fb29 commit 90bf058
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
12 changes: 5 additions & 7 deletions SDAccel/docs/Setup_AWS_CLI_and_S3_Bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,17 @@ The AWS SDAccel scripts require JSON output format and the scripts will not work
```
$ aws configure # to set your credentials (found in your console.aws.amazon.com page), region (us-east-1) and output (json)
```
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.
Start by creating a bucket and a folder within your new bucket:
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.
Start by creating a bucket:
```
$ aws s3 mb s3://<bucket-name> --region us-east-1 # Create an S3 bucket (choose a unique bucket name)
$ aws s3 mb s3://<bucket-name>/<dcp-folder-name> # Create folder for your tarball files
$ touch FILES_GO_HERE.txt # Create a temp file
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Which creates the folder on S3
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Choose a dcp folder name
```
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.
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.
Next, create a folder for your log files:
```
$ aws s3 mb s3://<bucket-name>/<logs-folder-name> # Create a folder to keep your logs
$ touch LOGS_FILES_GO_HERE.txt # Create a temp file
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Which creates the folder on S3
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Choose a logs folder name
```
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.
12 changes: 5 additions & 7 deletions Vitis/docs/Setup_AWS_CLI_and_S3_Bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,17 @@ The AWS Vitis scripts require JSON output format and the scripts will not work p
```
$ aws configure # to set your credentials (found in your console.aws.amazon.com page), region (us-east-1) and output (json)
```
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.
Start by creating a bucket and a folder within your new bucket:
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.
Start by creating a bucket:
```
$ aws s3 mb s3://<bucket-name> --region us-east-1 # Create an S3 bucket (choose a unique bucket name)
$ aws s3 mb s3://<bucket-name>/<dcp-folder-name> # Create folder for your tarball files
$ touch FILES_GO_HERE.txt # Create a temp file
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Which creates the folder on S3
$ aws s3 cp FILES_GO_HERE.txt s3://<bucket-name>/<dcp-folder-name>/ # Choose a dcp folder name
```
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.
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.
Next, create a folder for your log files:
```
$ aws s3 mb s3://<bucket-name>/<logs-folder-name> # Create a folder to keep your logs
$ touch LOGS_FILES_GO_HERE.txt # Create a temp file
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Which creates the folder on S3
$ aws s3 cp LOGS_FILES_GO_HERE.txt s3://<bucket-name>/<logs-folder-name>/ # Choose a logs folder name
```
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 comments on commit 90bf058

Please sign in to comment.