Improve values.yaml documentation and configuration structure
All checks were successful
Helm Chart Build / lint-only (push) Has been skipped
Helm Chart Build / build-helm (push) Successful in 8s
Build and Deploy / build-api (push) Successful in 43s
Build and Deploy / build-web (push) Successful in 1m4s

Enhanced values.yaml with comprehensive documentation and better organization:

Documentation improvements:
- Added detailed inline comments for all API7 Gateway configuration sections
- Documented Ingress routing behavior (gateway vs direct service routing)
- Explained Service Discovery benefits and requirements
- Added detailed plugin configuration documentation (rate limiting, CORS, auth)
- Included usage examples and production recommendations

Configuration enhancements:
- Added gateway.gatewayNamespace for better organization
- Added TLS certificate configuration options (duration, renewBefore, algorithm, size)
- Added ADC resource limits configuration
- Improved CORS and rate limiting documentation with parameter explanations
- Added consumer/authentication documentation

Template updates:
- Updated certificate.yaml to use configurable TLS parameters
- Updated job-adc-sync.yaml to use configurable ADC resources

The values.yaml now serves as comprehensive documentation for all
API7 Gateway features and configuration options, making it easier
for users to understand and customize their deployment.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
d.viti
2025-10-09 15:29:32 +02:00
parent e995482bfd
commit f5a4071b71
3 changed files with 162 additions and 77 deletions

View File

@@ -16,15 +16,15 @@ spec:
- {{ . | quote }}
{{- end }}
privateKey:
algorithm: RSA
algorithm: {{ .Values.api7.tls.privateKey.algorithm | default "RSA" }}
encoding: PKCS1
size: 2048
size: {{ .Values.api7.tls.privateKey.size | default 2048 }}
rotationPolicy: {{ .Values.api7.tls.privateKey.rotationPolicy | default "Always" }}
usages:
- digital signature
- key encipherment
- server auth
- client auth
duration: 2160h # 90 days
renewBefore: 720h # 30 days before expiry
duration: {{ .Values.api7.tls.duration | default "2160h" }}
renewBefore: {{ .Values.api7.tls.renewBefore | default "720h" }}
{{- end }}

View File

@@ -63,13 +63,10 @@ spec:
- name: adc-config
mountPath: /config
readOnly: true
{{- if .Values.api7.adc.resources }}
resources:
limits:
cpu: 500m
memory: 256Mi
requests:
cpu: 100m
memory: 128Mi
{{- toYaml .Values.api7.adc.resources | nindent 12 }}
{{- end }}
volumes:
- name: adc-config
configMap: