diff --git a/charts/s3proxy/Chart.yaml b/charts/s3proxy/Chart.yaml index e343e43..6150fce 100644 --- a/charts/s3proxy/Chart.yaml +++ b/charts/s3proxy/Chart.yaml @@ -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 diff --git a/charts/s3proxy/README.md.gotmpl b/charts/s3proxy/README.md.gotmpl index ed1c067..f1f5d1f 100644 --- a/charts/s3proxy/README.md.gotmpl +++ b/charts/s3proxy/README.md.gotmpl @@ -21,30 +21,53 @@ ## Installation -### Add the repository (if published) - -```bash -helm repo add s3proxy -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" . "${1}") }} + {{- $italStar := (mustRegexReplaceAll `([^\*]|\*\*)\*([^ \*].*[^ \*]|[^ \*])\*([^\*]|\*\*)` $code "${1}${2}${3}") }} + {{- $italScore := (mustRegexReplaceAll "( |__)_([^ _].*[^ _]|[^ _])_( |__)" $italStar "${1}${2}${3}") }} + {{- $boldStar := (mustRegexReplaceAll `\*\*([^ \*].*[^ \*]|[^ \*])\*\*` $italScore "${1}") }} + {{- $boldScore := (mustRegexReplaceAll "__([^ _].*[^ _]|[^ _])__" $boldStar "${1}") }} + {{- $boldScore }} +{{- end -}} + +{{- define "chart.valuesTableHtml" }} +*Scroll sideways to see all columns.* + + + + + + + + + + {{- range .Values }} + + + + + + + {{- end }} + +
KeyDescriptionTypeDefault
{{ .Key }}{{ template "renderMarkdownLine" (default .AutoDescription .Description) }}{{ .Type }}{{ template "renderMarkdownLine" (default .AutoDefault .Default) }}
+{{- end }} + +{{ template "chart.valuesSectionHtml" . }} ## Usage Examples @@ -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: @@ -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----- diff --git a/charts/s3proxy/override-values.example.yaml b/charts/s3proxy/override-values.example.yaml index 1ab76fa..c2b9fa8 100644 --- a/charts/s3proxy/override-values.example.yaml +++ b/charts/s3proxy/override-values.example.yaml @@ -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 @@ -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" @@ -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" diff --git a/charts/s3proxy/templates/configmap.yaml b/charts/s3proxy/templates/configmap.yaml index cc07dc7..1c7fd8a 100644 --- a/charts/s3proxy/templates/configmap.yaml +++ b/charts/s3proxy/templates/configmap.yaml @@ -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 @@ -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 }} @@ -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 }} \ No newline at end of file +{{- end }} diff --git a/charts/s3proxy/templates/secret.yaml b/charts/s3proxy/templates/secret.yaml index 0c6371f..cdadb0f 100644 --- a/charts/s3proxy/templates/secret.yaml +++ b/charts/s3proxy/templates/secret.yaml @@ -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 }} @@ -74,4 +74,4 @@ stringData: {{- if .Values.config.backends.rackspaceCloudfiles.apiKey }} jclouds.credential={{ .Values.config.backends.rackspaceCloudfiles.apiKey }} {{- end }} -{{- end }} \ No newline at end of file +{{- end }} diff --git a/charts/s3proxy/values.yaml b/charts/s3proxy/values.yaml index 3ad4155..d192f54 100644 --- a/charts/s3proxy/values.yaml +++ b/charts/s3proxy/values.yaml @@ -182,7 +182,7 @@ config: # -- S3 endpoint endpoint: "" # -- S3 Access Key ID for backend - accessKeyId: "" + accessKeyID: "" # -- S3 Secret Access Key for backend secretAccessKey: "" @@ -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) @@ -232,7 +232,7 @@ config: # -- Enable OpenStack Swift backend enabled: false # -- Authentication URL - authUrl: "" + authURL: "" # -- Tenant name tenantName: "" # -- Username