Mirrors/Stirling-PDF
Mirrors/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Frooodle/Stirling-PDF.git synced 2025-02-02 00:16:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: add helm chart github action (#2113)

Browse Source 
* feat: add helm chart github action

Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>

* fix: remove test branch

Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>

* fix: run helm-docs-built after syncing version

Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>

* fix: helm repo url

---------

Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
This commit is contained in:
Ludovic Ortega 2024-11-04 21:13:26 +01:00 committed by GitHub
parent 645c5ff36f
commit 40ffb6559d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 264 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
.github/workflows/lint-helm-charts.yml vendored Normal file
View File

@ -0,0 +1,47 @@
name: Lint and Test Helm Charts
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
jobs:
lint-test:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Helm
uses: azure/setup-helm@v4
- name: Set up python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Run pre-commit
uses: pre-commit/action@v3.0.1
with:
extra_args: helm-docs-built
- name: Set up chart-testing
uses: helm/chart-testing-action@v2
- name: Run chart-testing (list-changed)
id: list-changed
run: |
changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }})
if [[ -n "$changed" ]]; then
echo "changed=true" >> "$GITHUB_OUTPUT"
fi
- name: Run chart-testing
if: steps.list-changed.outputs.changed == 'true'
run: ct lint --target-branch ${{ github.event.repository.default_branch }} --validate-maintainers=false

31
.github/workflows/release-helm-charts.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: Release Helm charts
on:
push:
branches:
- main
permissions:
contents: write
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up git config
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Run chart-releaser
uses: helm/chart-releaser-action@v1.6.0
with:
config: "./cr.yaml"
charts_dir: "chart"
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

4
.github/workflows/sync_files.yml vendored
View File

@ -26,6 +26,10 @@ jobs:
run: pip install pyyaml run: pip install pyyaml
- name: Sync versions - name: Sync versions
run: python .github/scripts/gradle_to_chart.py run: python .github/scripts/gradle_to_chart.py
- name: Run pre-commit helm-docs-built
uses: pre-commit/action@v3.0.1
with:
extra_args: helm-docs-built
- name: Set up git config - name: Set up git config
run: | run: |
git config --global user.name "github-actions[bot]" git config --global user.name "github-actions[bot]"

6
.pre-commit-config.yaml
View File

@ -37,3 +37,9 @@ repos:
language: python language: python
exclude: ^(src/main/resources/static/pdfjs|src/main/resources/static/pdfjs-legacy) exclude: ^(src/main/resources/static/pdfjs|src/main/resources/static/pdfjs-legacy)
files: ^.*(\.html|\.css|\.js)$ files: ^.*(\.html|\.css|\.js)$
- repo: https://github.com/norwoodj/helm-docs
rev: v1.14.2
hooks:
- id: helm-docs-built
args:
- --chart-search-root=chart

95
chart/stirling-pdf/README.md Normal file
View File

@ -0,0 +1,95 @@
# stirling-pdf-chart
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 0.30.1](https://img.shields.io/badge/AppVersion-0.30.1-informational?style=flat-square)
locally hosted web application that allows you to perform various operations on PDF files
**Homepage:** <https://github.com/Stirling-Tools/Stirling-PDF>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| Stirling-Tools | | <https://github.com/Stirling-Tools/Stirling-PDF> |
## Source Code
* <https://github.com/Stirling-Tools/Stirling-PDF>
## Chart Repo
Add the following repo to use the chart:
```console
helm repo add stirling-pdf https://stirling-tools.github.io/Stirling-PDF
```
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| commonLabels | object | `{}` | Labels to apply to all resources |
| containerSecurityContext | object | `{}` | |
| deployment.annotations | object | `{}` | Stirling-pdf Deployment annotations |
| deployment.extraVolumeMounts | list | `[]` | Additional volumes to mount |
| deployment.extraVolumes | list | `[]` | Additional volumes |
| deployment.labels | object | `{}` | |
| deployment.sidecarContainers | object | `{}` | of the chart's content, send notifications... |
| envs | list | `[]` | |
| extraArgs | list | `[]` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"frooodle/s-pdf"` | |
| image.tag | string | `nil` | |
| ingress | object | `{"annotations":{},"enabled":false,"hosts":[],"ingressClassName":null,"labels":{},"pathType":"ImplementationSpecific"}` | Ingress for load balancer |
| ingress.annotations | object | `{}` | Stirling-pdf Ingress annotations |
| ingress.hosts | list | `[]` | Must be provided if Ingress is enabled |
| ingress.ingressClassName | string | `nil` | See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress |
| ingress.labels | object | `{}` | Stirling-pdf Ingress labels |
| nodeSelector | object | `{}` | |
| persistence.accessMode | string | `"ReadWriteOnce"` | |
| persistence.enabled | bool | `false` | |
| persistence.labels | object | `{}` | |
| persistence.path | string | `"/tmp"` | |
| persistence.pv | object | `{"accessMode":"ReadWriteOnce","capacity":{"storage":"8Gi"},"enabled":false,"nfs":{"path":null,"server":null},"pvname":null}` | stirling-pdf data Persistent Volume Storage Class If defined, storageClassName: <storageClass> If set to "-", storageClassName: "", which disables dynamic provisioning If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. (gp2 on AWS, standard on GKE, AWS & OpenStack) storageClass: "-" volumeName: |
| persistence.size | string | `"8Gi"` | |
| podAnnotations | object | `{}` | Read more about kube2iam to provide access to s3 https://github.com/jtblin/kube2iam |
| podLabels | object | `{}` | ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| priorityClassName | string | `""` | |
| probes.liveness.failureThreshold | int | `3` | |
| probes.liveness.initialDelaySeconds | int | `5` | |
| probes.liveness.periodSeconds | int | `10` | |
| probes.liveness.successThreshold | int | `1` | |
| probes.liveness.timeoutSeconds | int | `1` | |
| probes.livenessHttpGetConfig.scheme | string | `"HTTP"` | |
| probes.readiness.failureThreshold | int | `3` | |
| probes.readiness.initialDelaySeconds | int | `5` | |
| probes.readiness.periodSeconds | int | `10` | |
| probes.readiness.successThreshold | int | `1` | |
| probes.readiness.timeoutSeconds | int | `1` | |
| probes.readinessHttpGetConfig.scheme | string | `"HTTP"` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| rootPath | string | `"/"` | Rootpath for the application |
| secret.labels | object | `{}` | |
| securityContext | object | `{"enabled":true,"fsGroup":1000}` | does not allow this, try setting securityContext: {} |
| service.annotations | object | `{}` | |
| service.externalPort | int | `8080` | |
| service.externalTrafficPolicy | string | `"Local"` | |
| service.labels | object | `{}` | |
| service.loadBalancerIP | string | `nil` | Only valid if service.type: LoadBalancer |
| service.loadBalancerSourceRanges | list | `[]` | Only valid if service.type: LoadBalancer |
| service.nodePort | string | `nil` | |
| service.servicename | string | `nil` | |
| service.targetPort | string | `nil` | from deployment above. Leave empty to use stirling-pdf directly. |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.automountServiceAccountToken | bool | `false` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| serviceMonitor.enabled | bool | `false` | |
| serviceMonitor.labels | object | `{}` | |
| serviceMonitor.metricsPath | string | `"/metrics"` | |
| strategy.type | string | `"RollingUpdate"` | |
| tolerations | list | `[]` | |
| volumePermissions | object | `{"image":{"pullPolicy":"Always","registry":"docker.io","repository":"bitnami/minideb","tag":"buster"}}` | volumePermissions: Change the owner of the persistent volume mountpoint to RunAsUser:fsGroup |

25
chart/stirling-pdf/README.md.gotmpl Normal file
View File

@ -0,0 +1,25 @@
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
## Chart Repo
Add the following repo to use the chart:
```console
helm repo add stirling-pdf https://docs.stirlingpdf.com/Stirling-PDF/
```
{{ template "chart.valuesSection" . }}

109
chart/stirling-pdf/values.yaml
View File

@ -1,4 +1,5 @@
extraArgs: [] extraArgs:
[]
# - --storage-timestamp-tolerance 1s # - --storage-timestamp-tolerance 1s
replicaCount: 1 replicaCount: 1
strategy: strategy:
@ -10,12 +11,11 @@ image:
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
secret: secret:
labels: {} labels: {}
## Labels to apply to all resources # -- Labels to apply to all resources
##
commonLabels: {} commonLabels: {}
# team_name: dev # team_name: dev
# rootpath for the application # -- Rootpath for the application
rootPath: / rootPath: /
envs: [] envs: []
@ -31,22 +31,22 @@ envs: []
# value: "en_GB" # value: "en_GB"
deployment: deployment:
## stirling-pdf Deployment annotations # -- Stirling-pdf Deployment annotations
annotations: {} annotations: {}
# name: value # name: value
labels: {} labels: {}
# name: value # name: value
# additional volumes # -- Additional volumes
extraVolumes: [] extraVolumes: []
# - name: nginx-config # - name: nginx-config
# secret: # secret:
# secretName: nginx-config # secretName: nginx-config
# additional volumes to mount # -- Additional volumes to mount
extraVolumeMounts: [] extraVolumeMounts: []
## sidecarContainers for the stirling-pdf # -- sidecarContainers for the stirling-pdf
# Can be used to add a proxy to the pod that does # -- Can be used to add a proxy to the pod that does
# scanning for secrets, signing, authentication, validation # -- scanning for secrets, signing, authentication, validation
# of the chart's content, send notifications... # -- of the chart's content, send notifications...
sidecarContainers: {} sidecarContainers: {}
## Example sidecarContainer which uses an extraVolume from above and ## Example sidecarContainer which uses an extraVolume from above and
## a named port that can be referenced in the service as targetPort. ## a named port that can be referenced in the service as targetPort.
@ -60,33 +60,34 @@ deployment:
# readOnly: true # readOnly: true
# mountPath: /etc/nginx # mountPath: /etc/nginx
## Pod annotations # -- Pod annotations
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ # -- ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
## Read more about kube2iam to provide access to s3 https://github.com/jtblin/kube2iam # -- Read more about kube2iam to provide access to s3 https://github.com/jtblin/kube2iam
## podAnnotations:
podAnnotations: {} {}
# iam.amazonaws.com/role: role-arn # iam.amazonaws.com/role: role-arn
## Pod labels # -- Pod labels
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ # -- ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
podLabels: {} podLabels:
{}
# name: value # name: value
service: service:
servicename: servicename:
type: ClusterIP type: ClusterIP
externalTrafficPolicy: Local externalTrafficPolicy: Local
## Uses pre-assigned IP address from cloud provider # -- Uses pre-assigned IP address from cloud provider
## Only valid if service.type: LoadBalancer # -- Only valid if service.type: LoadBalancer
loadBalancerIP: loadBalancerIP:
## Limits which cidr blocks can connect to service's load balancer # -- Limits which cidr blocks can connect to service's load balancer
## Only valid if service.type: LoadBalancer # -- Only valid if service.type: LoadBalancer
loadBalancerSourceRanges: [] loadBalancerSourceRanges: []
# clusterIP: None # clusterIP: None
externalPort: 8080 externalPort: 8080
## targetPort of the container to use. If a sidecar should handle the # -- targetPort of the container to use. If a sidecar should handle the
## requests first, use the named port from the sidecar. See sidecar example # -- requests first, use the named port from the sidecar. See sidecar example
## from deployment above. Leave empty to use stirling-pdf directly. # -- from deployment above. Leave empty to use stirling-pdf directly.
targetPort: targetPort:
nodePort: nodePort:
annotations: {} annotations: {}
@ -133,10 +134,10 @@ serviceAccount:
## Annotations for the Service Account ## Annotations for the Service Account
annotations: {} annotations: {}
# UID/GID 1000 is the default user "stirling-pdf" used in # -- UID/GID 1000 is the default user "stirling-pdf" used in
# the container image starting in v0.8.0 and above. This # -- the container image starting in v0.8.0 and above. This
# is required for local persistent storage. If your cluster # -- is required for local persistent storage. If your cluster
# does not allow this, try setting securityContext: {} # -- does not allow this, try setting securityContext: {}
securityContext: securityContext:
enabled: true enabled: true
fsGroup: 1000 fsGroup: 1000
@ -159,7 +160,8 @@ persistence:
enabled: false enabled: false
accessMode: ReadWriteOnce accessMode: ReadWriteOnce
size: 8Gi size: 8Gi
labels: {} labels:
{}
# name: value # name: value
path: /tmp path: /tmp
## A manually managed Persistent Volume and Claim ## A manually managed Persistent Volume and Claim
@ -167,13 +169,12 @@ persistence:
## If defined, PVC must be created manually before volume will be bound ## If defined, PVC must be created manually before volume will be bound
# existingClaim: # existingClaim:
## stirling-pdf data Persistent Volume Storage Class # -- stirling-pdf data Persistent Volume Storage Class
## If defined, storageClassName: <storageClass> # If defined, storageClassName: <storageClass>
## If set to "-", storageClassName: "", which disables dynamic provisioning # If set to "-", storageClassName: "", which disables dynamic provisioning
## If undefined (the default) or set to null, no storageClassName spec is # If undefined (the default) or set to null, no storageClassName spec is
## set, choosing the default provisioner. (gp2 on AWS, standard on # set, choosing the default provisioner. (gp2 on AWS, standard on
## GKE, AWS & OpenStack) # GKE, AWS & OpenStack)
##
# storageClass: "-" # storageClass: "-"
# volumeName: # volumeName:
pv: pv:
@ -186,9 +187,8 @@ persistence:
server: server:
path: path:
## Init containers parameters: # -- Init containers parameters:
## volumePermissions: Change the owner of the persistent volume mountpoint to RunAsUser:fsGroup # -- volumePermissions: Change the owner of the persistent volume mountpoint to RunAsUser:fsGroup
##
volumePermissions: volumePermissions:
image: image:
registry: docker.io registry: docker.io
@ -202,25 +202,25 @@ volumePermissions:
# pullSecrets: # pullSecrets:
# - myRegistryKeySecretName # - myRegistryKeySecretName
## Ingress for load balancer # -- Ingress for load balancer
ingress: ingress:
enabled: false enabled: false
pathType: "ImplementationSpecific" pathType: "ImplementationSpecific"
## stirling-pdf Ingress labels # -- Stirling-pdf Ingress labels
## labels:
labels: {} {}
# dns: "route53" # dns: "route53"
## stirling-pdf Ingress annotations # -- Stirling-pdf Ingress annotations
## annotations:
annotations: {} {}
# kubernetes.io/ingress.class: nginx # kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true" # kubernetes.io/tls-acme: "true"
## stirling-pdf Ingress hostnames # -- Stirling-pdf Ingress hostnames
## Must be provided if Ingress is enabled # -- Must be provided if Ingress is enabled
## hosts:
hosts: [] []
# - name: stirling-pdf.domain1.com # - name: stirling-pdf.domain1.com
# path: / # path: /
# tls: false # tls: false
@ -234,7 +234,6 @@ ingress:
# ## Secrets must be added manually to the namespace # ## Secrets must be added manually to the namespace
# tlsSecret: stirling-pdf.domain2-tls # tlsSecret: stirling-pdf.domain2-tls
# For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName # -- For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName
# See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress # -- See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress
ingressClassName: ingressClassName:

2
cr.yaml Normal file
View File

@ -0,0 +1,2 @@
skip-existing: true
generate-release-notes: true