Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/s3proxy/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.0.4
version: 0.0.5

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
51 changes: 37 additions & 14 deletions charts/s3proxy/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,53 @@

## Installation

### Add the repository (if published)

```bash
helm repo add s3proxy <REPO_URL>
helm repo update
```

### Install the chart

```bash
# Install with default values (filesystem backend)
helm install my-s3proxy ./{{ template "chart.name" . }}
helm install my-s3proxy oci://ghcr.io/comet-ml/{{ template "chart.name" . }}

# Install with custom values
helm install my-s3proxy ./{{ template "chart.name" . }} -f my-values.yaml
helm install my-s3proxy oci://ghcr.io/comet-ml/{{ template "chart.name" . }} -f override-values.yaml
```

## Configuration

The following section lists the configurable parameters of the {{ template "chart.name" . }} chart and their default values.

### General Parameters

{{ template "chart.valuesSection" . }}
{{- define "renderMarkdownLine" }}
{{- $code := (mustRegexReplaceAll "\x60([^\x60]*)\x60" . "<code>${1}</code>") }}
{{- $italStar := (mustRegexReplaceAll `([^\*]|\*\*)\*([^ \*].*[^ \*]|[^ \*])\*([^\*]|\*\*)` $code "${1}<i>${2}</i>${3}") }}
{{- $italScore := (mustRegexReplaceAll "( |__)_([^ _].*[^ _]|[^ _])_( |__)" $italStar "${1}<i>${2}</i>${3}") }}
{{- $boldStar := (mustRegexReplaceAll `\*\*([^ \*].*[^ \*]|[^ \*])\*\*` $italScore "<b>${1}</b>") }}
{{- $boldScore := (mustRegexReplaceAll "__([^ _].*[^ _]|[^ _])__" $boldStar "<b>${1}</b>") }}
{{- $boldScore }}
{{- end -}}

{{- define "chart.valuesTableHtml" }}
*Scroll sideways to see all columns.*

<table>
<thead>
<th>Key</th>
<th>Description</th>
<th>Type</th>
<th>Default</th>
</thead>
<tbody>
{{- range .Values }}
<tr>
<td><code>{{ .Key }}</code></td>
<td>{{ template "renderMarkdownLine" (default .AutoDescription .Description) }}</td>
<td><code>{{ .Type }}</code></td>
<td>{{ template "renderMarkdownLine" (default .AutoDefault .Default) }}</td>
</tr>
{{- end }}
</tbody>
</table>
{{- end }}

{{ template "chart.valuesSectionHtml" . }}

## Usage Examples

Expand Down Expand Up @@ -87,7 +110,7 @@ config:
provider: "aws-s3"
awsS3:
region: "us-west-2"
accessKeyId: "aws-access-key-id" # For s3proxy to connect to AWS
accessKeyID: "aws-access-key-id" # For s3proxy to connect to AWS
secretAccessKey: "aws-secret-access-key"

persistence:
Expand Down Expand Up @@ -135,7 +158,7 @@ config:
backend:
provider: "google-cloud-storage"
googleCloudStorage:
projectId: "my-project"
projectID: "my-project"
clientEmail: "service-account@my-project.iam.gserviceaccount.com"
privateKey: |
-----BEGIN RSA PRIVATE KEY-----
Expand Down
6 changes: 3 additions & 3 deletions charts/s3proxy/override-values.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ config:
aws: true # Set to true for AWS S3 (aws-s3 provider), false for generic S3
region: "us-west-2"
# endpoint: "https://s3.amazonaws.com" # Optional custom endpoint (e.g., MinIO, Ceph)
accessKeyId: "AKIAIOSFODNN7EXAMPLE"
accessKeyID: "AKIAIOSFODNN7EXAMPLE"
secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

# Azure Blob Storage backend
Expand All @@ -81,7 +81,7 @@ config:
# Google Cloud Storage backend
googleCloudStorage:
enabled: false # Set to true to use GCS backend
projectId: "my-project"
projectID: "my-project"

# Service account email or user email (required for both authentication methods)
clientEmail: "service-account@my-project.iam.gserviceaccount.com"
Expand Down Expand Up @@ -122,7 +122,7 @@ config:
# OpenStack Swift backend
openstackSwift:
enabled: false # Set to true to use Swift backend
authUrl: "https://auth.cloud.com/v2.0"
authURL: "https://auth.cloud.com/v2.0"
tenantName: "my-tenant"
userName: "my-user"
password: "my-password"
Expand Down
10 changes: 5 additions & 5 deletions charts/s3proxy/templates/configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ data:

# Google Cloud Storage backend configuration
jclouds.provider=google-cloud-storage
{{- if .Values.config.backends.googleCloudStorage.projectId }}
jclouds.project-id={{ .Values.config.backends.googleCloudStorage.projectId }}
{{- if .Values.config.backends.googleCloudStorage.projectID }}
jclouds.project-id={{ .Values.config.backends.googleCloudStorage.projectID }}
{{- end }}
# Credentials will be merged from the secret properties file
# jclouds.identity and jclouds.credential will be provided by the secret
Expand All @@ -156,8 +156,8 @@ data:

# OpenStack Swift backend configuration
jclouds.provider=openstack-swift
{{- if .Values.config.backends.openstackSwift.authUrl }}
jclouds.keystone.auth-url={{ .Values.config.backends.openstackSwift.authUrl }}
{{- if .Values.config.backends.openstackSwift.authURL }}
jclouds.keystone.auth-url={{ .Values.config.backends.openstackSwift.authURL }}
{{- end }}
{{- if .Values.config.backends.openstackSwift.region }}
jclouds.region={{ .Values.config.backends.openstackSwift.region }}
Expand All @@ -178,4 +178,4 @@ data:
{{- end }}
# Credentials will be merged from the secret properties file
# jclouds.identity and jclouds.credential will be provided by the secret
{{- end }}
{{- end }}
6 changes: 3 additions & 3 deletions charts/s3proxy/templates/secret.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ stringData:

{{- if .Values.config.backends.s3.enabled }}
# S3 backend credentials
{{- if .Values.config.backends.s3.accessKeyId }}
jclouds.identity={{ .Values.config.backends.s3.accessKeyId }}
{{- if .Values.config.backends.s3.accessKeyID }}
jclouds.identity={{ .Values.config.backends.s3.accessKeyID }}
{{- end }}
{{- if .Values.config.backends.s3.secretAccessKey }}
jclouds.credential={{ .Values.config.backends.s3.secretAccessKey }}
Expand Down Expand Up @@ -74,4 +74,4 @@ stringData:
{{- if .Values.config.backends.rackspaceCloudfiles.apiKey }}
jclouds.credential={{ .Values.config.backends.rackspaceCloudfiles.apiKey }}
{{- end }}
{{- end }}
{{- end }}
6 changes: 3 additions & 3 deletions charts/s3proxy/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ config:
# -- S3 endpoint
endpoint: ""
# -- S3 Access Key ID for backend
accessKeyId: ""
accessKeyID: ""
# -- S3 Secret Access Key for backend
secretAccessKey: ""

Expand All @@ -204,7 +204,7 @@ config:
# -- Enable Google Cloud Storage backend
enabled: false
# -- GCP project ID
projectId: ""
projectID: ""
# -- Private key (only used when jsonCredentials.enabled is false)
privateKey: ""
# -- Service account email or user email (used with both privateKey and jsonCredentials methods)
Expand Down Expand Up @@ -232,7 +232,7 @@ config:
# -- Enable OpenStack Swift backend
enabled: false
# -- Authentication URL
authUrl: ""
authURL: ""
# -- Tenant name
tenantName: ""
# -- Username
Expand Down