Skip to content

Commit 83918b9

Browse files
terminalnodemnencia
authored andcommitted
docs: update minio object store docs
The MinIO Gateway is deprecated as of 2022-02-24: https://blog.min.io/deprecation-of-the-minio-gateway/ These updated docs explain how to use MinIO's S3-compatible object storage without the need for setting up a dedicated gateway. Signed-off-by: Alexander Rundberg <[email protected]>
1 parent 7904b43 commit 83918b9

File tree

1 file changed

+17
-74
lines changed

1 file changed

+17
-74
lines changed

web/docs/object_stores.md

Lines changed: 17 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -384,87 +384,30 @@ write permissions to the bucket.
384384
---
385385

386386

387-
## MinIO Gateway
387+
## MinIO Object Store
388388

389-
MinIO Gateway can proxy requests to cloud object storage providers like S3 or GCS.
390-
For more information, refer to [MinIO official documentation](https://docs.min.io/).
389+
For the lastest documentation on MinIO, please refer to the
390+
[MinIO official documentation](https://docs.min.io/).
391391

392-
### Setup
392+
MinIO Object Store's API is compatible with S3, the default configuration of the tenant
393+
will create these services:
394+
- `<tenant>-console` on port 9090 (with autocert) or 9443 (without autocert)
395+
- `<tenant>-hl` on port 9000
393396

394-
Create MinIO access credentials:
397+
The `console` service is for managing the tenant, while the `hl` service exposes the S3
398+
compatible API. If your tenant is configured with `requestAutoCert` you will communicate
399+
to these services over HTTPS, if not you will use HTTP.
400+
401+
For authentication you can use your username and password, or create an access key.
402+
Whichever method you choose, it has to be stored as a secret.
395403

396404
```sh
397405
kubectl create secret generic minio-creds \
398-
--from-literal=MINIO_ACCESS_KEY=<minio access key> \
399-
--from-literal=MINIO_SECRET_KEY=<minio secret key>
400-
```
401-
402-
:::note
403-
Cloud Object Storage credentials will be used only by MinIO Gateway in this
404-
case.
405-
:::
406-
407-
Expose MinIO Gateway via `ClusterIP`:
408-
409-
```yaml
410-
apiVersion: v1
411-
kind: Service
412-
metadata:
413-
name: minio-gateway-service
414-
spec:
415-
type: ClusterIP
416-
ports:
417-
- port: 9000
418-
targetPort: 9000
419-
protocol: TCP
420-
selector:
421-
app: minio
422-
```
423-
424-
Here follows an excerpt of an example of deployment relaying to S3:
425-
426-
```yaml
427-
apiVersion: apps/v1
428-
kind: Deployment
429-
[...]
430-
spec:
431-
containers:
432-
- name: minio
433-
image: minio/minio:RELEASE.2020-06-03T22-13-49Z
434-
args: ["gateway", "s3"]
435-
ports:
436-
- containerPort: 9000
437-
env:
438-
- name: MINIO_ACCESS_KEY
439-
valueFrom:
440-
secretKeyRef:
441-
name: minio-creds
442-
key: MINIO_ACCESS_KEY
443-
- name: MINIO_SECRET_KEY
444-
valueFrom:
445-
secretKeyRef:
446-
name: minio-creds
447-
key: MINIO_SECRET_KEY
448-
- name: AWS_ACCESS_KEY_ID
449-
valueFrom:
450-
secretKeyRef:
451-
name: aws-creds
452-
key: ACCESS_KEY_ID
453-
- name: AWS_SECRET_ACCESS_KEY
454-
valueFrom:
455-
secretKeyRef:
456-
name: aws-creds
457-
key: ACCESS_SECRET_KEY
458-
# Uncomment the below section if session token is required
459-
# - name: AWS_SESSION_TOKEN
460-
# valueFrom:
461-
# secretKeyRef:
462-
# name: aws-creds
463-
# key: ACCESS_SESSION_TOKEN
406+
--from-literal=MINIO_ACCESS_KEY=<minio access key or username> \
407+
--from-literal=MINIO_SECRET_KEY=<minio secret key or password>
464408
```
465409

466-
Proceed by configuring MinIO Gateway service as the `endpointURL` in the
467-
`ObjectStore` definition, then choose a bucket name to replace `BUCKET_NAME`:
410+
Finally, create the Barman ObjectStore:
468411

469412
```yaml
470413
apiVersion: barmancloud.cnpg.io/v1
@@ -474,7 +417,7 @@ metadata:
474417
spec:
475418
configuration:
476419
destinationPath: s3://BUCKET_NAME/
477-
endpointURL: http://minio-gateway-service:9000
420+
endpointURL: http://<tenant>-hl:9000
478421
s3Credentials:
479422
accessKeyId:
480423
name: minio-creds

0 commit comments

Comments
 (0)