Skip to content

Commit 3093d74

Browse files
author
Samuel MEYNARD
committed
docs: helm
1 parent 7d9f90e commit 3093d74

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed

‎README.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,80 @@
11
# nginx-s3-gateway-chart
22

33
This chart deploy Nginx S3 gateway with customizable configuration
4+
5+
## How to add this helm repository
6+
7+
``` sh
8+
helm repo add olopost https://olopost.github.io/nginx-s3-gateway-chart
9+
```
10+
11+
to verify you can type the following command
12+
13+
``` console
14+
$ helm repo list
15+
16+
NAME URL
17+
olopost https://olopost.github.io/nginx-s3-gateway-chart
18+
```
19+
20+
## To deploy the helm
21+
22+
``` sh
23+
helm install nginx-s3 olopost/nginx-s3 -f values.yaml
24+
```
25+
26+
# nginx-s3 helm chart doc
27+
28+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
29+
30+
Nginx S3 gateway
31+
32+
## Values
33+
34+
| Key | Type | Default | Description |
35+
|-----|------|---------|-------------|
36+
| affinity | object | `{}` | |
37+
| autoscaling.enabled | bool | `false` | |
38+
| autoscaling.maxReplicas | int | `100` | |
39+
| autoscaling.minReplicas | int | `1` | |
40+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
41+
| fullnameOverride | string | `""` | |
42+
| image.pullPolicy | string | `"IfNotPresent"` | |
43+
| image.repository | string | `"ghcr.io/nginxinc/nginx-s3-gateway/nginx-oss-s3-gateway"` | |
44+
| image.tag | string | `"latest-20221216"` | |
45+
| imagePullSecrets | list | `[]` | |
46+
| ingress.annotations | object | `{}` | |
47+
| ingress.className | string | `""` | |
48+
| ingress.enabled | bool | `false` | |
49+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
50+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
51+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
52+
| ingress.tls | list | `[]` | |
53+
| nameOverride | string | `""` | |
54+
| nginx.s3.accessKey | string | `"access"` | |
55+
| nginx.s3.allowDirectoryListing | bool | `false` | |
56+
| nginx.s3.awsSigsVersion | int | `4` | |
57+
| nginx.s3.bucketName | string | `"name"` | |
58+
| nginx.s3.debug | bool | `false` | |
59+
| nginx.s3.provideIndexPage | bool | `false` | |
60+
| nginx.s3.region | string | `"fra"` | |
61+
| nginx.s3.secretKey | string | `"secret"` | |
62+
| nginx.s3.server.host | string | `"localhost"` | |
63+
| nginx.s3.server.port | int | `443` | |
64+
| nginx.s3.server.proto | string | `"https"` | |
65+
| nginx.s3.style | string | `"virtual"` | |
66+
| nodeSelector | object | `{}` | |
67+
| podAnnotations | object | `{}` | |
68+
| podSecurityContext | object | `{}` | |
69+
| replicaCount | int | `1` | |
70+
| resources | object | `{}` | |
71+
| securityContext | object | `{}` | |
72+
| service.port | int | `80` | |
73+
| service.type | string | `"ClusterIP"` | |
74+
| serviceAccount.annotations | object | `{}` | |
75+
| serviceAccount.create | bool | `true` | |
76+
| serviceAccount.name | string | `""` | |
77+
| tolerations | list | `[]` | |
78+
79+
----------------------------------------------
80+
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

‎charts/nginx-s3-gateway/README.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# nginx-s3
2+
3+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
4+
5+
Nginx S3 gateway
6+
7+
## Values
8+
9+
| Key | Type | Default | Description |
10+
|-----|------|---------|-------------|
11+
| affinity | object | `{}` | |
12+
| autoscaling.enabled | bool | `false` | |
13+
| autoscaling.maxReplicas | int | `100` | |
14+
| autoscaling.minReplicas | int | `1` | |
15+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16+
| fullnameOverride | string | `""` | |
17+
| image.pullPolicy | string | `"IfNotPresent"` | |
18+
| image.repository | string | `"ghcr.io/nginxinc/nginx-s3-gateway/nginx-oss-s3-gateway"` | |
19+
| image.tag | string | `"latest-20221216"` | |
20+
| imagePullSecrets | list | `[]` | |
21+
| ingress.annotations | object | `{}` | |
22+
| ingress.className | string | `""` | |
23+
| ingress.enabled | bool | `false` | |
24+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
25+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
26+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
27+
| ingress.tls | list | `[]` | |
28+
| nameOverride | string | `""` | |
29+
| nginx.s3.accessKey | string | `"access"` | |
30+
| nginx.s3.allowDirectoryListing | bool | `false` | |
31+
| nginx.s3.awsSigsVersion | int | `4` | |
32+
| nginx.s3.bucketName | string | `"name"` | |
33+
| nginx.s3.debug | bool | `false` | |
34+
| nginx.s3.provideIndexPage | bool | `false` | |
35+
| nginx.s3.region | string | `"fra"` | |
36+
| nginx.s3.secretKey | string | `"secret"` | |
37+
| nginx.s3.server.host | string | `"localhost"` | |
38+
| nginx.s3.server.port | int | `443` | |
39+
| nginx.s3.server.proto | string | `"https"` | |
40+
| nginx.s3.style | string | `"virtual"` | |
41+
| nodeSelector | object | `{}` | |
42+
| podAnnotations | object | `{}` | |
43+
| podSecurityContext | object | `{}` | |
44+
| replicaCount | int | `1` | |
45+
| resources | object | `{}` | |
46+
| securityContext | object | `{}` | |
47+
| service.port | int | `80` | |
48+
| service.type | string | `"ClusterIP"` | |
49+
| serviceAccount.annotations | object | `{}` | |
50+
| serviceAccount.create | bool | `true` | |
51+
| serviceAccount.name | string | `""` | |
52+
| tolerations | list | `[]` | |
53+
54+
----------------------------------------------
55+
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

0 commit comments

Comments
 (0)