Move AWS policy docs to documentation page.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
@@ -150,6 +150,39 @@ permissions to:
|
||||
- `s3:ListBucket` - To retrieve bucket metadata
|
||||
- `s3:GetObject` - To retrieve files from the bucket
|
||||
|
||||
> Note: If you need to migrate documentation objects from an older-style path
|
||||
> format including case-sensitive entity metadata, you will need to add some
|
||||
> additional permissions to be able to perform the migration, including:
|
||||
>
|
||||
> - `s3:PutBucketAcl` (for copying files,
|
||||
> [more info here](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html))
|
||||
> - `s3:DeleteObject` and `s3:DeleteObjectVersion` (for deleting migrated files,
|
||||
> [more info here](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html))
|
||||
>
|
||||
> ...And you will need to ensure the permissions apply to the bucket itself, as
|
||||
> well as all resources under the bucket. See the example policy below.
|
||||
|
||||
```json
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "TechDocsWithMigration",
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"s3:PutObject",
|
||||
"s3:GetObject",
|
||||
"s3:DeleteObjectVersion",
|
||||
"s3:ListBucket",
|
||||
"s3:DeleteObject",
|
||||
"s3:PutObjectAcl"
|
||||
],
|
||||
"Resource": ["arn:aws:s3:::your-bucket", "arn:aws:s3:::your-bucket/*"]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**4a. (Recommended) Setup authentication the AWS way, using environment
|
||||
variables**
|
||||
|
||||
|
||||
@@ -313,19 +313,6 @@ export class AwsS3Publish implements PublisherBase {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* todo: Put this documentation somewhere the user will actually see and read
|
||||
* it.
|
||||
*
|
||||
* Note: In addition to the usual `PutObject`, `ListBucket` and `GetObject`
|
||||
* actions, will need to add `PutObjectAcl` for copying files as well as
|
||||
* `DeleteObject` if the removeOriginal flag is set to true. You may need to
|
||||
* ensure access to the bucket resource in the following way:
|
||||
* [
|
||||
* "arn:aws:s3:::your-bucket",
|
||||
* "arn:aws:s3:::your-bucket/*"
|
||||
* ]
|
||||
*/
|
||||
async migrateDocsCase({
|
||||
removeOriginal = false,
|
||||
concurrency = 25,
|
||||
|
||||
@@ -323,10 +323,6 @@ export class AzureBlobStoragePublish implements PublisherBase {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* todo: Put this documentation somewhere the user will actually see and read
|
||||
* it.
|
||||
*/
|
||||
async migrateDocsCase({
|
||||
removeOriginal = false,
|
||||
concurrency = 25,
|
||||
|
||||
Reference in New Issue
Block a user