Skip to content

Commit 32116d8

Browse files
committed
Edit docs.
1 parent 80dc43a commit 32116d8

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/src/user-guide/guides-using-object-storage/clp-config.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ logs_input:
1919
type: "<type>"
2020
# type-specific settings
2121
```
22-
* `<type>` and the type-specific settings are described in the
23-
[configuring AWS authentication](#configuring-aws-authentication) section.
22+
23+
`<type>` and the type-specific settings are described in the
24+
[configuring AWS authentication](#configuring-aws-authentication) section.
2425

2526
## Configuration for archive storage
2627

docs/src/user-guide/guides-using-object-storage/clp-usage.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,18 @@ angle brackets (`<>`) with the appropriate values:
1111
```bash
1212
sbin/compress.sh \
1313
--timestamp-key <timestamp-key> \
14-
<URL>
14+
<url>
1515
```
1616

17-
Currently, CLP supports the following two types of URLs:
18-
19-
* ```https://s3.<region-code>.amazonaws.com/<bucket-name>/<prefix>```
20-
* ```https://<bucket-name>.s3.<region-code>.amazonaws.com/<prefix>```
21-
22-
Where:
23-
* `<bucket-name>` is the name of the S3 bucket containing your logs.
24-
* `<region-code>` is the AWS region [code][aws-region-codes] for the S3 bucket containing your logs.
25-
* `<prefix>` is the prefix of all logs you wish to compress and must begin with the
26-
`<all-logs-prefix>` value from the [compression IAM policy][compression-iam-policy].
17+
* `<url>` is a URL identifying the logs to compress. It can have one of two formats:
18+
* `https://<bucket-name>.s3.<region-code>.amazonaws.com/<prefix>`
19+
* `https://s3.<region-code>.amazonaws.com/<bucket-name>/<prefix>`
20+
* The fields in `<url>` are as follows:
21+
* `<bucket-name>` is the name of the S3 bucket containing your logs.
22+
* `<region-code>` is the AWS region [code][aws-region-codes] for the S3 bucket containing your
23+
logs.
24+
* `<prefix>` is the prefix of all logs you wish to compress and must begin with the
25+
`<all-logs-prefix>` value from the [compression IAM policy][compression-iam-policy].
2726

2827
:::{note}
2928
Compressing from S3 only supports a single URL but will compress any logs that have the given

0 commit comments

Comments
 (0)