Skip to content

Commit 63ceef8

Browse files
authored
docs: document cloudflare R2 and Minio (#1058)
Signed-off-by: Miguel Martinez Trivino <[email protected]>
1 parent 2e3ee50 commit 63ceef8

File tree

4 files changed

+59
-4
lines changed

4 files changed

+59
-4
lines changed

docs/docs/reference/operator/cas-backend/cas-backend.mdx

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,13 @@ $ chainloop cas-backend add oci \
129129
#### Rotate credentials
130130

131131
```bash
132-
chainloop cas-backend update oci --id [BACKEND_ID] --username [NEW_USERNAME] --password [NEW_PASSWORD]
132+
chainloop cas-backend update oci --name [BACKEND_NAME] --username [NEW_USERNAME] --password [NEW_PASSWORD]
133133
```
134134

135135
#### Set as default
136136

137137
```bash
138-
chainloop cas-backend update oci --id [BACKEND_ID] --default=true
138+
chainloop cas-backend update oci --name [BACKEND_NAME] --default=true
139139
```
140140

141141
### AWS S3
@@ -205,7 +205,7 @@ We are now ready to connect our AWS account to Chainloop
205205
#### Rotate credentials
206206

207207
```bash
208-
chainloop cas-backend update aws-s3 --id [BACKEND_ID] --access-key-id [new-accessKeyID] --secret-access-key [new-secretAccessKey] --region [new-region]
208+
chainloop cas-backend update aws-s3 --name [BACKEND_NAME] --access-key-id [new-accessKeyID] --secret-access-key [new-secretAccessKey] --region [new-region]
209209
```
210210

211211
### Azure Blob Storage
@@ -265,7 +265,62 @@ At thi point we have all the information we need to connect our Azure storage ac
265265
#### Rotate credentials
266266

267267
```bash
268-
chainloop cas-backend update azure-blob --id [BACKEND_ID] --client-id [new-clientID] --client-secret [new secret] --tenant [updated tenant]
268+
chainloop cas-backend update azure-blob --name [BACKEND_NAME] --client-id [new-clientID] --client-secret [new secret] --tenant [updated tenant]
269+
```
270+
271+
### Cloudflare R2
272+
273+
[Cloudflare R2](https://www.cloudflare.com/developer-platform/r2/) is compatible with AWS S3 and can be configured in Chainloop by providing a custom endpoint.
274+
275+
Pre-requisites
276+
277+
- **AccessKeyID**
278+
- **SecretAccessKey**
279+
- **Bucket Name**
280+
- **Endpoint**
281+
282+
Follow [this instructions](https://developers.cloudflare.com/r2/api/s3/tokens/) to create a compatible AccessKeyID and SecretAccessKey. Then copy the bucket name and endpoint from the bucket settings.
283+
284+
![](./cloudflare.png)
285+
286+
Finally register the Cloudflare R2 bucket using the `aws-s3` provider and providing the custom endpoint.
287+
288+
```bash
289+
$ chainloop cas-backend add aws-s3 \
290+
--access-key-id [accessKeyID] \
291+
--secret-access-key [secretAccessKey] \
292+
--bucket [bucketName] \
293+
--endpoint [endpoint] # provide the custom endpoint
294+
```
295+
296+
### Minio
297+
298+
[Minio](https://min.io/) is an S3-compatible blob storage that can be configured in Chainloop by providing a custom endpoint.
299+
300+
Pre-requisites
301+
302+
- **AccessKeyID**
303+
- **SecretAccessKey**
304+
- **Bucket Name**
305+
- **Minio Endpoint**
306+
307+
308+
You can create a new AccessKey from the Minio console.
309+
310+
![](./minio-1.png)
311+
312+
Then copy the bucket name and Minio endpoint.
313+
314+
![](./minio-2.png)
315+
316+
Finally register the Minio bucket using the `aws-s3` provider and providing the custom endpoint
317+
318+
```bash
319+
$ chainloop cas-backend add aws-s3 \
320+
--access-key-id [accessKeyID] \
321+
--secret-access-key [secretAccessKey] \
322+
--bucket [bucketName] \
323+
--endpoint [endpoint] # provide the custom endpoint
269324
```
270325

271326
## Give it a try
56.6 KB
Loading
115 KB
Loading
109 KB
Loading

0 commit comments

Comments
 (0)