Skip to content

Commit 30e3c0e

Browse files
authored
Merge pull request #33 from epinio/update_s3_documentation
Doc how to configure S3 using Helm
2 parents de6e559 + 113119b commit 30e3c0e

File tree

1 file changed

+21
-36
lines changed

1 file changed

+21
-36
lines changed

src/howtos/setup-external-s3.md

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,31 @@ One of the steps involved in running `epinio push` is storing the requested vers
44
in the configured Epinio S3 compatible storage. By default, Epinio installs and configures [Minio](https://github.com/minio/minio)
55
to be used for this purpose. This document describes how to point Epinio to another S3 compatible storage and skip the Minio installation.
66

7-
The [`epinio install` command](../references/cli/epinio_install.md), has the following optional parameters:
8-
9-
10-
```
11-
--s3-endpoint
12-
--s3-access-key-id
13-
--s3-secret-access-key
14-
--s3-bucket
15-
--s3-location
16-
--s3-use-ssl
17-
```
18-
19-
To configure Epinio to store application sources to an external S3 compatible storage, at least the following should be set:
20-
21-
```
22-
--s3-endpoint
23-
--s3-access-key-id
24-
--s3-secret-access-key
25-
--s3-bucket
26-
```
27-
28-
the other 2 are optional:
29-
30-
```
31-
--s3-location
32-
--s3-use-ssl
33-
```
34-
7+
The Epinio Helm chart has the following optional parameters:
8+
9+
| Variable name | Description | Mandatory |Default |
10+
|:---|:---|:---:|:---:|
11+
| `useS3Storage` | Use S3 storage | yes | "" |
12+
| `s3Bucket` | S3 bucket where you want to store your apps | yes | `epinio` |
13+
| `s3Endpoint` | S3 endpoint | yes | `minio.minio-epinio.svc.cluster.local` |
14+
| `s3AccessKeyId` | S3 access key id to authenticate to the endpoint | yes | "" |
15+
| `s3SecretAccessKey` | S3 secret access key id to authenticate to the endpoint| yes | "" |
16+
| `s3UseSSL` | Use SSL for encryption | no | `false` |
17+
| `s3Location` | S3 region where your bucket is | no | "" |
18+
19+
To configure Epinio to store application sources to an external S3 compatible storage, at least the mandatory options should be set.
3520
(Some implementations don't need the location (e.g. Minio) and `s3-use-ssl` has a default value of "false")
3621

37-
An example that points Epinio to AWS S3 will look like this:
22+
For instance, add the following options to your Helm command to make Epinio pointing to AWS:
3823

3924
```
40-
epinio install \
41-
--s3-endpoint s3.amazonaws.com \
42-
--s3-access-key-id your_access_key_here \
43-
--s3-secret-access-key your_secret_key_here \
44-
--s3-bucket epinio_sources \
45-
--s3-location eu-central-1
46-
--s3-use-ssl
25+
--set useS3Storage=true \
26+
--set s3UseSSL=true \
27+
--set s3Bucket=<your_bucket_here> \
28+
--set s3Location=<your_region_here> \
29+
--set s3Endpoint=s3.amazonaws.com \
30+
--set s3AccessKeyId=<your_access_key_here> \
31+
--set s3SecretAccessKey=<your_secret_access_key_here> \
4732
```
4833

4934
If the bucket doesn't exist, Epinio will try to create it when it first tries

0 commit comments

Comments
 (0)