Skip to content

Commit 5960340

Browse files
committed
Merge branch 'main' into sto-com
2 parents f0b1949 + 4f5bc91 commit 5960340

7 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎docs/background/object-storage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Object storage in {{brand}}
22

3-
Object storage in {{brand}} is implemented via the [Ceph Object Gateway](https://docs.ceph.com/en/latest/radosgw/index.html), also known as `radosgw` (commonly pronounced "[rados](https://docs.ceph.com/en/latest/glossary/#term-RADOS) gateway").
3+
Object storage in {{brand}} is implemented via the [Ceph Object Gateway](https://docs.ceph.com/en/tentacle/radosgw/index.html), also known as `radosgw` (commonly pronounced "[rados](https://docs.ceph.com/en/tentacle/glossary/#term-RADOS) gateway").
44

55
This facility exposes access to objects via two RESTful APIs: the [Amazon S3 API](https://docs.aws.amazon.com/AmazonS3/latest/API/), and the [OpenStack Swift API](https://docs.openstack.org/api-ref/object-store/).
66
It is, however, important to understand that radosgw shares no code with Amazon S3, nor with OpenStack Swift.
77

88
As such, object storage in {{brand}} is not expected to behave *exactly* as Amazon S3 or OpenStack Swift, although it tracks their behavior very closely.
9-
The Ceph upstream documentation lists API deviations from the respective reference implementations, for both the [S3](https://docs.ceph.com/en/latest/radosgw/s3/) and the [Swift](https://docs.ceph.com/en/latest/radosgw/swift/) API.
9+
The Ceph upstream documentation lists API deviations from the respective reference implementations, for both the [S3](https://docs.ceph.com/en/tentacle/radosgw/s3/) and the [Swift](https://docs.ceph.com/en/tentacle/radosgw/swift/) API.
1010
Our [reference section](../reference/index.md) lists additional [limitations](../reference/limitations/object-storage.md) specific to {{brand}}.
1111

1212
## Object storage integration with OpenStack authentication

‎docs/howto/object-storage/s3/object-lock.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ To configure the legal hold for all objects in a bucket, use the following comma
179179
```bash
180180
aws --profile {{api_region|lower}} \
181181
s3api list-objects \
182-
--bucket <bucket-name \
182+
--bucket <bucket-name> \
183183
| jq .Contents[].Key \
184184
| xargs -n1 aws --profile {{api_region|lower}} s3api put-object-legal-hold --legal-hold Status=ON --bucket <bucket-name> --key
185185
```

‎docs/howto/object-storage/s3/presign.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To create a pre-signed URL for an object, you use the following command (replace
2525
```bash
2626
aws --profile {{api_region|lower}} \
2727
s3 presign \
28-
--expires-in <seconds>
28+
--expires-in <seconds> \
2929
s3://<bucket-name>/<object-name>
3030
```
3131
=== "mc"
@@ -111,7 +111,7 @@ To ensure that an object named `bar.pdf` in a bucket named `foo` is always downl
111111
=== "s3cmd"
112112
```bash
113113
s3cmd -c ~/.s3cfg-{{api_region|lower}} modify \
114-
--add-header 'Content-Disposition: attachment; filename="bar.pdf"'
114+
--add-header 'Content-Disposition: attachment; filename="bar.pdf"' \
115115
s3://foo/bar.pdf
116116
```
117117

@@ -122,9 +122,9 @@ To ensure that an object named `bar.pdf` in a bucket named `foo` is always downl
122122
```bash
123123
aws --profile {{api_region|lower}} \
124124
s3api copy-object \
125-
--copy-source <bucket-name>/<object-name>
125+
--copy-source <bucket-name>/<object-name> \
126126
--content-disposition 'attachment;filename="bar.pdf"' \
127-
--metadata-directive replace
127+
--metadata-directive replace \
128128
--bucket <bucket-name> \
129129
--key <object-name>
130130
```
@@ -134,7 +134,7 @@ To ensure that an object named `bar.pdf` in a bucket named `foo` is always downl
134134
`s3cmd` comes with a handy `modify --add-header` subcommand for updating object metadata in-place:
135135
```bash
136136
s3cmd -c ~/.s3cfg-{{api_region|lower}} modify \
137-
--add-header 'Content-Disposition: attachment; filename="bar.pdf"'
137+
--add-header 'Content-Disposition: attachment; filename="bar.pdf"' \
138138
s3://foo/bar.pdf
139139
```
140140

‎docs/howto/object-storage/s3/public-bucket.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Making a bucket globally readable entails setting a *bucket policy* that enables
1111
1212
## Prerequisites
1313

14-
Object versioning requires that you configure your environment with [working S3-compatible credentials](credentials.md).
14+
To set up a public bucket, you must first configure your environment with [working S3-compatible credentials](credentials.md).
1515

1616
## Setting a public read policy for a bucket
1717

‎docs/howto/object-storage/s3/sse-c.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In order to generate encryption key and store it in Barbican, proceed as follows
5252

5353
## Managing encrypted objects in S3
5454

55-
Once you have your encryption secret available, you can create or access enabled objects.
55+
Once you have your encryption secret available, you can create or access encrypted objects.
5656

5757
=== "aws"
5858
1. Create an S3 bucket:
@@ -94,14 +94,14 @@ Once you have your encryption secret available, you can create or access enabled
9494
```bash
9595
mc cp \
9696
--recursive \
97-
--encrypt-key "{{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted=${secret}"
97+
--encrypt-key "{{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted=${secret}" \
9898
~/media/ {{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted
9999
```
100100
3. Retrieve a file from S3 and decrypt it.
101101
Again, specify the encryption key in the same manner:
102102
```bash
103103
mc cp \
104-
--encrypt-key "{{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted=${secret}"
104+
--encrypt-key "{{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted=${secret}" \
105105
{{api_region|lower}}/{{brand|lower|replace(' ','')}}-encrypted/file.png .
106106
```
107107

@@ -129,7 +129,7 @@ Once you have your encryption secret available, you can create or access enabled
129129
env_auth = false
130130
access_key_id = <access key id>
131131
secret_access_key = <secret key>
132-
endpoint = {{api_region|lower}}.{{api_domain}}
132+
endpoint = s3-{{api_region|lower}}.{{api_domain}}
133133
acl = private
134134
sse_customer_algorithm = AES256
135135
```

‎docs/howto/object-storage/swift/versioning.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Using the Swift API, you have the option to retain multiple versions of an objec
55
## Prerequisites
66

77
In order to manage object versioning, be sure that you have [installed and configured](index.md) the `swift` command-line interface (CLI).
8-
There is presently no way to set object expiry with the `openstack` CLI.
8+
There is presently no way to manage object versioning with the `openstack` CLI.
99

1010
Also, ensure that you have configured a [private container](private-container.md), i.e. one with an empty Read ACL.
1111
The examples in this how-to guide assume that your container is named `private-container`, and that it presently contains a single object named `testobj.txt`.

‎docs/reference/versions/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ In {{brand_public}} we upgrade OpenStack releases annually; this means that we n
2121

2222
[Ceph major releases](https://docs.ceph.com/en/latest/releases/index.html#release-timeline) are also named in alphabetical order, and occur on a roughly annual schedule.
2323

24-
{{brand}} currently runs Ceph [Reef](https://docs.ceph.com/en/latest/releases/reef/) and [Tentacle](https://docs.ceph.com/en/latest/releases/tentacle/).
24+
{{brand}} currently runs Ceph [Reef](https://docs.ceph.com/en/reef/releases/reef/) and [Tentacle](https://docs.ceph.com/en/tentacle/releases/tentacle/).

0 commit comments

Comments
 (0)