|
| 1 | +# s3proxy |
| 2 | + |
| 3 | +   |
| 4 | + |
| 5 | +A Helm chart for deploying S3Proxy - Access other storage backends via the S3 API |
| 6 | + |
| 7 | +## Maintainers |
| 8 | + |
| 9 | +| Name | Email | Url | |
| 10 | +| ---- | ------ | --- | |
| 11 | +| CRThaze | | | |
| 12 | + |
| 13 | +## Values |
| 14 | + |
| 15 | +| Key | Type | Default | Description | |
| 16 | +|-----|------|---------|-------------| |
| 17 | +| affinity | object | `{}` | Affinity for pod assignment | |
| 18 | +| autoscaling.enabled | bool | `false` | Enable HPA | |
| 19 | +| autoscaling.maxReplicas | int | `100` | Maximum number of replicas | |
| 20 | +| autoscaling.minReplicas | int | `1` | Minimum number of replicas | |
| 21 | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage | |
| 22 | +| config.authorization | string | `"aws-v4"` | Authorization type (none, aws-v2, aws-v4, aws-v2-or-v4) | |
| 23 | +| config.backend.awsS3.accessKeyId | string | `""` | AWS Access Key ID for backend | |
| 24 | +| config.backend.awsS3.endpoint | string | `""` | S3 endpoint | |
| 25 | +| config.backend.awsS3.region | string | `""` | AWS region | |
| 26 | +| config.backend.awsS3.secretAccessKey | string | `""` | AWS Secret Access Key for backend | |
| 27 | +| config.backend.azureblob.account | string | `""` | Storage account name | |
| 28 | +| config.backend.azureblob.endpoint | string | `""` | Azure endpoint | |
| 29 | +| config.backend.azureblob.key | string | `""` | Storage account key | |
| 30 | +| config.backend.azureblob.sasToken | string | `""` | SAS token | |
| 31 | +| config.backend.b2.account | string | `""` | B2 account ID | |
| 32 | +| config.backend.b2.applicationKey | string | `""` | B2 application key | |
| 33 | +| config.backend.filesystem.basedir | string | `"/data/s3proxy"` | Base directory for filesystem backend | |
| 34 | +| config.backend.googleCloudStorage.clientEmail | string | `""` | Service account email | |
| 35 | +| config.backend.googleCloudStorage.clientId | string | `""` | Client ID | |
| 36 | +| config.backend.googleCloudStorage.privateKey | string | `""` | Private key | |
| 37 | +| config.backend.googleCloudStorage.privateKeyId | string | `""` | Private key ID | |
| 38 | +| config.backend.googleCloudStorage.projectId | string | `""` | GCP project ID | |
| 39 | +| config.backend.provider | string | `"filesystem-nio2"` | Backend provider type (filesystem, filesystem-nio2, transient, transient-nio2, aws-s3, s3, azureblob, azureblob-sdk, b2, google-cloud-storage, openstack-swift, rackspace-cloudfiles-uk, rackspace-cloudfiles-us) | |
| 40 | +| config.backend.swift.authUrl | string | `""` | Authentication URL | |
| 41 | +| config.backend.swift.password | string | `""` | Password | |
| 42 | +| config.backend.swift.region | string | `""` | Region | |
| 43 | +| config.backend.swift.tenantName | string | `""` | Tenant name | |
| 44 | +| config.backend.swift.userName | string | `""` | Username | |
| 45 | +| config.buckets.alias | object | `{}` | Map virtual bucket names to actual backend buckets | |
| 46 | +| config.buckets.locator | list | `[]` | Assign specific buckets to different backends (glob patterns supported) | |
| 47 | +| config.cors.allowCredential | bool | `false` | Allow credentials | |
| 48 | +| config.cors.allowHeaders | list | `["Accept","Content-Type"]` | Allowed headers | |
| 49 | +| config.cors.allowMethods | list | `["GET","PUT","POST","HEAD","DELETE"]` | Allowed methods | |
| 50 | +| config.cors.allowOrigins | list | `[]` | Allowed origins (e.g., ["https://example.com", "https://.+\\.example\\.com"]) | |
| 51 | +| config.cors.enabled | bool | `false` | Enable CORS support | |
| 52 | +| config.credential | string | `""` | S3 Secret Access Key for client authentication | |
| 53 | +| config.identity | string | `""` | S3 Access Key ID for client authentication | |
| 54 | +| config.middlewares.eventualConsistency | bool | `false` | Enable eventual consistency modeling | |
| 55 | +| config.middlewares.largeObjectMocking | bool | `false` | Enable large object mocking | |
| 56 | +| config.middlewares.readOnly | bool | `false` | Make backend read-only | |
| 57 | +| config.middlewares.shardedBackend | bool | `false` | Enable sharded backend containers | |
| 58 | +| config.virtualHost | string | `""` | Virtual Host configuration | |
| 59 | +| extraEnvVars | list | `[]` | Additional environment variables | |
| 60 | +| extraVolumeMounts | list | `[]` | Additional volume mounts | |
| 61 | +| extraVolumes | list | `[]` | Additional volumes | |
| 62 | +| fullnameOverride | string | `""` | String to fully override s3proxy.fullname template | |
| 63 | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | |
| 64 | +| image.repository | string | `"andrewgaul/s3proxy"` | S3Proxy image repository | |
| 65 | +| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | |
| 66 | +| imagePullSecrets | list | `[]` | Image pull secrets | |
| 67 | +| ingress.annotations | object | `{}` | Ingress annotations | |
| 68 | +| ingress.className | string | `""` | Ingress class name | |
| 69 | +| ingress.enabled | bool | `false` | Enable ingress | |
| 70 | +| ingress.hosts | list | `[]` | Ingress hosts configuration | |
| 71 | +| ingress.tls | list | `[]` | TLS configuration | |
| 72 | +| nameOverride | string | `""` | String to partially override s3proxy.fullname template | |
| 73 | +| nodeSelector | object | `{}` | Node selector for pod assignment | |
| 74 | +| persistence.accessMode | string | `"ReadWriteOnce"` | PVC Access Mode | |
| 75 | +| persistence.annotations | object | `{}` | PVC annotations | |
| 76 | +| persistence.enabled | bool | `true` | Enable persistence using PVC | |
| 77 | +| persistence.existingClaim | string | `""` | Use existing PVC | |
| 78 | +| persistence.size | string | `"10Gi"` | PVC Storage Request | |
| 79 | +| persistence.storageClass | string | `""` (uses default StorageClass) | Storage Class | |
| 80 | +| podAnnotations | object | `{}` | Annotations to add to the pod | |
| 81 | +| podSecurityContext | object | `{}` | Pod security context | |
| 82 | +| replicaCount | int | `1` | Number of S3Proxy replicas | |
| 83 | +| resources | object | `{}` | Resource limits and requests | |
| 84 | +| securityContext | object | `{}` | Container security context | |
| 85 | +| service.annotations | object | `{}` | Service annotations | |
| 86 | +| service.port | int | `8080` | Service port | |
| 87 | +| service.targetPort | int | `8080` | Target port (controls both the container port and S3Proxy bind port) | |
| 88 | +| service.type | string | `"ClusterIP"` | Kubernetes service type | |
| 89 | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | |
| 90 | +| serviceAccount.create | bool | `false` | Specifies whether a service account should be created | |
| 91 | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | |
| 92 | +| tolerations | list | `[]` | Tolerations for pod assignment | |
| 93 | + |
| 94 | +---------------------------------------------- |
| 95 | +Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) |
0 commit comments