Skip to content

Commit 9df8902

Browse files
CometActionsCometActions
committed
Update README.md with helm-docs
1 parent 76576a8 commit 9df8902

File tree

1 file changed

+126
-30
lines changed

1 file changed

+126
-30
lines changed

‎README.md‎

Lines changed: 126 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# s3proxy
22

3-
![Version: 0.0.5](https://img.shields.io/badge/Version-0.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.7.0](https://img.shields.io/badge/AppVersion-2.7.0-informational?style=flat-square)
3+
![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.7.0](https://img.shields.io/badge/AppVersion-2.7.0-informational?style=flat-square)
44

55
A Helm chart for deploying S3Proxy - Access other storage backends via the S3 API
66

@@ -106,7 +106,25 @@ The following section lists the configurable parameters of the s3proxy chart and
106106
</tr>
107107
<tr>
108108
<td><code>config.backends.azureblob.key</code></td>
109-
<td>Storage account key</td>
109+
<td>Storage account key configuration</td>
110+
<td><code>object</code></td>
111+
<td><code>{"existingSecret":"","secretKey":"accountKey","value":""}</code></td>
112+
</tr>
113+
<tr>
114+
<td><code>config.backends.azureblob.key.existingSecret</code></td>
115+
<td>Name of existing secret containing the storage account key</td>
116+
<td><code>string</code></td>
117+
<td><code>""</code></td>
118+
</tr>
119+
<tr>
120+
<td><code>config.backends.azureblob.key.secretKey</code></td>
121+
<td>Key in the existing secret containing the storage account key</td>
122+
<td><code>string</code></td>
123+
<td><code>"accountKey"</code></td>
124+
</tr>
125+
<tr>
126+
<td><code>config.backends.azureblob.key.value</code></td>
127+
<td>Storage account key value</td>
110128
<td><code>string</code></td>
111129
<td><code>""</code></td>
112130
</tr>
@@ -118,7 +136,25 @@ The following section lists the configurable parameters of the s3proxy chart and
118136
</tr>
119137
<tr>
120138
<td><code>config.backends.azureblob.sasToken</code></td>
121-
<td>SAS token</td>
139+
<td>SAS token configuration</td>
140+
<td><code>object</code></td>
141+
<td><code>{"existingSecret":"","secretKey":"sasToken","value":""}</code></td>
142+
</tr>
143+
<tr>
144+
<td><code>config.backends.azureblob.sasToken.existingSecret</code></td>
145+
<td>Name of existing secret containing the SAS token</td>
146+
<td><code>string</code></td>
147+
<td><code>""</code></td>
148+
</tr>
149+
<tr>
150+
<td><code>config.backends.azureblob.sasToken.secretKey</code></td>
151+
<td>Key in the existing secret containing the SAS token</td>
152+
<td><code>string</code></td>
153+
<td><code>"sasToken"</code></td>
154+
</tr>
155+
<tr>
156+
<td><code>config.backends.azureblob.sasToken.value</code></td>
157+
<td>SAS token value</td>
122158
<td><code>string</code></td>
123159
<td><code>""</code></td>
124160
</tr>
@@ -130,7 +166,25 @@ The following section lists the configurable parameters of the s3proxy chart and
130166
</tr>
131167
<tr>
132168
<td><code>config.backends.b2.applicationKey</code></td>
133-
<td>B2 application key</td>
169+
<td>B2 application key configuration</td>
170+
<td><code>object</code></td>
171+
<td><code>{"existingSecret":"","secretKey":"applicationKey","value":""}</code></td>
172+
</tr>
173+
<tr>
174+
<td><code>config.backends.b2.applicationKey.existingSecret</code></td>
175+
<td>Name of existing secret containing the application key</td>
176+
<td><code>string</code></td>
177+
<td><code>""</code></td>
178+
</tr>
179+
<tr>
180+
<td><code>config.backends.b2.applicationKey.secretKey</code></td>
181+
<td>Key in the existing secret containing the application key</td>
182+
<td><code>string</code></td>
183+
<td><code>"applicationKey"</code></td>
184+
</tr>
185+
<tr>
186+
<td><code>config.backends.b2.applicationKey.value</code></td>
187+
<td>Application key value</td>
134188
<td><code>string</code></td>
135189
<td><code>""</code></td>
136190
</tr>
@@ -160,7 +214,7 @@ The following section lists the configurable parameters of the s3proxy chart and
160214
</tr>
161215
<tr>
162216
<td><code>config.backends.googleCloudStorage.clientEmail</code></td>
163-
<td>Service account email or user email (used with both privateKey and jsonCredentials methods)</td>
217+
<td>Service account email or user email</td>
164218
<td><code>string</code></td>
165219
<td><code>""</code></td>
166220
</tr>
@@ -171,38 +225,26 @@ The following section lists the configurable parameters of the s3proxy chart and
171225
<td><code>false</code></td>
172226
</tr>
173227
<tr>
174-
<td><code>config.backends.googleCloudStorage.jsonCredentials</code></td>
175-
<td>JSON credentials configuration</td>
228+
<td><code>config.backends.googleCloudStorage.privateKey</code></td>
229+
<td>Private key configuration</td>
176230
<td><code>object</code></td>
177-
<td><code>{"enabled":false,"existingSecret":"","jsonContent":"","secretKey":"credentials.json"}</code></td>
178-
</tr>
179-
<tr>
180-
<td><code>config.backends.googleCloudStorage.jsonCredentials.enabled</code></td>
181-
<td>Use JSON credentials file instead of privateKey</td>
182-
<td><code>bool</code></td>
183-
<td><code>false</code></td>
231+
<td><code>{"existingSecret":"","secretKey":"private.key","value":""}</code></td>
184232
</tr>
185233
<tr>
186-
<td><code>config.backends.googleCloudStorage.jsonCredentials.existingSecret</code></td>
187-
<td>Name of existing secret containing GCP credentials JSON</td>
234+
<td><code>config.backends.googleCloudStorage.privateKey.existingSecret</code></td>
235+
<td>Name of existing secret containing the private key</td>
188236
<td><code>string</code></td>
189237
<td><code>""</code></td>
190238
</tr>
191239
<tr>
192-
<td><code>config.backends.googleCloudStorage.jsonCredentials.jsonContent</code></td>
193-
<td>JSON content for creating a new secret (takes precedence over existingSecret)</td>
240+
<td><code>config.backends.googleCloudStorage.privateKey.secretKey</code></td>
241+
<td>Key in the existing secret containing the private key (in PEM format)</td>
194242
<td><code>string</code></td>
195-
<td><code>""</code></td>
243+
<td><code>"private.key"</code></td>
196244
</tr>
197245
<tr>
198-
<td><code>config.backends.googleCloudStorage.jsonCredentials.secretKey</code></td>
199-
<td>Key in the secret containing the JSON credentials (default: credentials.json)</td>
200-
<td><code>string</code></td>
201-
<td><code>"credentials.json"</code></td>
202-
</tr>
203-
<tr>
204-
<td><code>config.backends.googleCloudStorage.privateKey</code></td>
205-
<td>Private key (only used when jsonCredentials.enabled is false)</td>
246+
<td><code>config.backends.googleCloudStorage.privateKey.value</code></td>
247+
<td>Private key value (in PEM format)</td>
206248
<td><code>string</code></td>
207249
<td><code>""</code></td>
208250
</tr>
@@ -226,7 +268,25 @@ The following section lists the configurable parameters of the s3proxy chart and
226268
</tr>
227269
<tr>
228270
<td><code>config.backends.openstackSwift.password</code></td>
229-
<td>Password</td>
271+
<td>Password configuration</td>
272+
<td><code>object</code></td>
273+
<td><code>{"existingSecret":"","secretKey":"password","value":""}</code></td>
274+
</tr>
275+
<tr>
276+
<td><code>config.backends.openstackSwift.password.existingSecret</code></td>
277+
<td>Name of existing secret containing the password</td>
278+
<td><code>string</code></td>
279+
<td><code>""</code></td>
280+
</tr>
281+
<tr>
282+
<td><code>config.backends.openstackSwift.password.secretKey</code></td>
283+
<td>Key in the existing secret containing the password</td>
284+
<td><code>string</code></td>
285+
<td><code>"password"</code></td>
286+
</tr>
287+
<tr>
288+
<td><code>config.backends.openstackSwift.password.value</code></td>
289+
<td>Password value</td>
230290
<td><code>string</code></td>
231291
<td><code>""</code></td>
232292
</tr>
@@ -250,7 +310,25 @@ The following section lists the configurable parameters of the s3proxy chart and
250310
</tr>
251311
<tr>
252312
<td><code>config.backends.rackspaceCloudfiles.apiKey</code></td>
253-
<td>API key</td>
313+
<td>API key configuration</td>
314+
<td><code>object</code></td>
315+
<td><code>{"existingSecret":"","secretKey":"apiKey","value":""}</code></td>
316+
</tr>
317+
<tr>
318+
<td><code>config.backends.rackspaceCloudfiles.apiKey.existingSecret</code></td>
319+
<td>Name of existing secret containing the API key</td>
320+
<td><code>string</code></td>
321+
<td><code>""</code></td>
322+
</tr>
323+
<tr>
324+
<td><code>config.backends.rackspaceCloudfiles.apiKey.secretKey</code></td>
325+
<td>Key in the existing secret containing the API key</td>
326+
<td><code>string</code></td>
327+
<td><code>"apiKey"</code></td>
328+
</tr>
329+
<tr>
330+
<td><code>config.backends.rackspaceCloudfiles.apiKey.value</code></td>
331+
<td>API key value</td>
254332
<td><code>string</code></td>
255333
<td><code>""</code></td>
256334
</tr>
@@ -304,7 +382,25 @@ The following section lists the configurable parameters of the s3proxy chart and
304382
</tr>
305383
<tr>
306384
<td><code>config.backends.s3.secretAccessKey</code></td>
307-
<td>S3 Secret Access Key for backend</td>
385+
<td>S3 Secret Access Key configuration</td>
386+
<td><code>object</code></td>
387+
<td><code>{"existingSecret":"","secretKey":"secretAccessKey","value":""}</code></td>
388+
</tr>
389+
<tr>
390+
<td><code>config.backends.s3.secretAccessKey.existingSecret</code></td>
391+
<td>Name of existing secret containing the secret access key</td>
392+
<td><code>string</code></td>
393+
<td><code>""</code></td>
394+
</tr>
395+
<tr>
396+
<td><code>config.backends.s3.secretAccessKey.secretKey</code></td>
397+
<td>Key in the existing secret containing the secret access key</td>
398+
<td><code>string</code></td>
399+
<td><code>"secretAccessKey"</code></td>
400+
</tr>
401+
<tr>
402+
<td><code>config.backends.s3.secretAccessKey.value</code></td>
403+
<td>Secret access key value</td>
308404
<td><code>string</code></td>
309405
<td><code>""</code></td>
310406
</tr>

0 commit comments

Comments
 (0)