-
Notifications
You must be signed in to change notification settings - Fork 0
feat(api): add Helm chart for docspec API v3.0.1 #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| { | ||
| "charts/common": "0.1.0" | ||
| "charts/common": "0.1.0", | ||
| "charts/api": "0.0.1" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| dependencies: | ||
| - name: common | ||
| repository: oci://ghcr.io/docspec | ||
| version: 0.1.0 | ||
| digest: sha256:95ae0fb91e1fdf11ebef816ec098a87711783f18b9a65f43e7cbb2c44e609ee2 | ||
| generated: "2026-04-28T15:17:40.367790072+02:00" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| apiVersion: v2 | ||
| name: api | ||
| description: Helm chart for the docspec document conversion API | ||
| type: application | ||
| version: 0.0.1 | ||
| kubeVersion: ">=1.28.0" | ||
| home: https://github.com/docspec/charts | ||
| sources: | ||
| - https://github.com/docspec/charts | ||
| - https://github.com/docspecio/api | ||
| maintainers: | ||
| - name: docspec | ||
| keywords: | ||
| - docspec | ||
| - document-conversion | ||
| - api | ||
| dependencies: | ||
| - name: common | ||
| version: "0.x.x" | ||
| repository: "oci://ghcr.io/docspec" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| {{- $localPort := .Values.service.port -}} | ||
| docspec API is now installed. | ||
|
|
||
| Get the API URL: | ||
| {{- if .Values.ingress.enabled }} | ||
| http{{ if .Values.ingress.tls }}s{{ end }}://{{ .Values.ingress.hostname }}/conversion | ||
| {{- else }} | ||
| kubectl port-forward svc/{{ include "api.names.fullname" . }} {{ $localPort }}:{{ .Values.service.port }} -n {{ include "api.names.namespace" . }} | ||
| Then: http://localhost:{{ $localPort }}/conversion | ||
| {{- end }} | ||
|
|
||
| Health check: | ||
| curl http://localhost:{{ $localPort }}/health | ||
|
|
||
| Convert a document: | ||
| curl -X POST http://localhost:{{ $localPort }}/conversion \ | ||
| -H "Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document" \ | ||
| --data-binary @document.docx |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| {{/* | ||
| Expand the name of the chart. | ||
| */}} | ||
| {{- define "api.names.name" -}} | ||
| {{- include "common.names.name" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Create a default fully qualified app name. | ||
| */}} | ||
| {{- define "api.names.fullname" -}} | ||
| {{- include "common.names.fullname" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Allow the release namespace to be overridden. | ||
| */}} | ||
| {{- define "api.names.namespace" -}} | ||
| {{- include "common.names.namespace" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Create chart name and version as used by the chart label. | ||
| */}} | ||
| {{- define "api.names.chart" -}} | ||
| {{- include "common.names.chart" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Kubernetes standard labels. | ||
| */}} | ||
| {{- define "api.labels.standard" -}} | ||
| {{- include "common.labels.standard" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Labels used on selector.matchLabels and Service spec.selector. | ||
| */}} | ||
| {{- define "api.labels.matchLabels" -}} | ||
| {{- include "common.labels.matchLabels" . -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Return the proper image name. | ||
| Usage: {{ include "api.image" . }} | ||
| */}} | ||
| {{- define "api.image" -}} | ||
| {{- include "common.images.image" (dict "imageRoot" .Values.image "global" .Values.global) -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Return the ServiceAccount name to use. | ||
| Usage: {{ include "api.serviceAccountName" . }} | ||
| */}} | ||
| {{- define "api.serviceAccountName" -}} | ||
| {{- include "common.rbac.serviceAccountName" (dict "serviceAccount" .Values.serviceAccount "context" $) -}} | ||
| {{- end -}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| {{- $fullName := include "api.names.fullname" . -}} | ||
| apiVersion: {{ include "common.capabilities.deployment.apiVersion" . }} | ||
| kind: Deployment | ||
| metadata: | ||
| name: {{ $fullName }} | ||
| namespace: {{ include "api.names.namespace" . }} | ||
| labels: {{- include "api.labels.standard" . | nindent 4 }} | ||
| {{- if .Values.commonAnnotations }} | ||
| annotations: {{- include "common.tplvalues.render" (dict "value" .Values.commonAnnotations "context" $) | nindent 4 }} | ||
| {{- end }} | ||
| spec: | ||
| {{- if not .Values.autoscaling.enabled }} | ||
| replicas: {{ .Values.replicaCount }} | ||
| {{- end }} | ||
| selector: | ||
| matchLabels: {{- include "api.labels.matchLabels" . | nindent 6 }} | ||
| template: | ||
| metadata: | ||
| labels: {{- include "api.labels.matchLabels" . | nindent 8 }} | ||
| {{- if .Values.podLabels }} | ||
| {{- include "common.tplvalues.render" (dict "value" .Values.podLabels "context" $) | nindent 8 }} | ||
| {{- end }} | ||
| {{- if .Values.podAnnotations }} | ||
| annotations: {{- include "common.tplvalues.render" (dict "value" .Values.podAnnotations "context" $) | nindent 8 }} | ||
| {{- end }} | ||
| spec: | ||
| serviceAccountName: {{ include "api.serviceAccountName" . }} | ||
| {{- include "common.images.renderPullSecrets" (dict "images" (list .Values.image) "context" $) | nindent 6 }} | ||
| securityContext: {{- toYaml .Values.podSecurityContext | nindent 8 }} | ||
| {{- with .Values.nodeSelector }} | ||
| nodeSelector: {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with .Values.affinity }} | ||
| affinity: {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with .Values.tolerations }} | ||
| tolerations: {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with .Values.extraVolumes }} | ||
| volumes: {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| containers: | ||
| - name: api | ||
| image: {{ include "api.image" . }} | ||
| imagePullPolicy: {{ .Values.image.pullPolicy }} | ||
| securityContext: {{- toYaml .Values.containerSecurityContext | nindent 12 }} | ||
| ports: | ||
| - name: http | ||
| containerPort: {{ .Values.containerPorts.http }} | ||
| protocol: TCP | ||
| env: | ||
| - name: PORT | ||
| value: {{ .Values.containerPorts.http | quote }} | ||
| {{- with .Values.extraEnvVars }} | ||
| {{- toYaml . | nindent 12 }} | ||
| {{- end }} | ||
| resources: {{- include "common.resources.preset.apply" (dict "type" .Values.resourcesPreset "resources" .Values.resources) | nindent 12 }} | ||
| livenessProbe: {{- toYaml .Values.livenessProbe | nindent 12 }} | ||
| readinessProbe: {{- toYaml .Values.readinessProbe | nindent 12 }} | ||
| {{- with .Values.extraVolumeMounts }} | ||
| volumeMounts: {{- toYaml . | nindent 12 }} | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| {{- if .Values.autoscaling.enabled -}} | ||
| apiVersion: {{ include "common.capabilities.hpa.apiVersion" . }} | ||
| kind: HorizontalPodAutoscaler | ||
| metadata: | ||
| name: {{ include "api.names.fullname" . }} | ||
| namespace: {{ include "api.names.namespace" . }} | ||
| labels: {{- include "api.labels.standard" . | nindent 4 }} | ||
| spec: | ||
| scaleTargetRef: | ||
| apiVersion: {{ include "common.capabilities.deployment.apiVersion" . }} | ||
| kind: Deployment | ||
| name: {{ include "api.names.fullname" . }} | ||
| minReplicas: {{ .Values.autoscaling.minReplicas }} | ||
| maxReplicas: {{ .Values.autoscaling.maxReplicas }} | ||
| metrics: | ||
| {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} | ||
| - type: Resource | ||
| resource: | ||
| name: cpu | ||
| target: | ||
| type: Utilization | ||
| averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} | ||
| {{- end }} | ||
| {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} | ||
| - type: Resource | ||
| resource: | ||
| name: memory | ||
| target: | ||
| type: Utilization | ||
| averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} | ||
| {{- end }} | ||
| {{- end }} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.