feat(stable): BREAKING CHANGE migrate to new common part 1 (#7900)

**Description**
Part 1 of the migration to new common on the stable train.
This basically breaks most/all charts requiring a reinstall on SCALE as
well.

Helm users shouldn't need a reinstall but could migrate their
values.yaml modification manually besides backing-up and porting the
databases.

There be Dragons basically, as we obviously cannot 100% go over
each-and-every single app in the stable train like we did in the
enterprise train.

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [x] 🪛 Bugfix
- [x] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
Via CI and manually validation in a lot of cases where the CI did not
correctly check things.
Additional catalog item creation tooling for local testing has been
added as well.

**📃 Notes:**
There will be issues in the future but we should get as much working
well as we can.

**✔️ Checklist:**

- [x] ⚖️ My code follows the style guidelines of this project
- [x] 👀 I have performed a self-review of my own code
- [x] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [x] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [x] ⬆️ I increased versions for any altered app according to semantic
versioning

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
This commit is contained in:
Kjeld Schouten-Lebbing
2023-04-11 12:07:17 +02:00
committed by GitHub
parent 14bc83d3c7
commit 0b726419d4
1146 changed files with 15731 additions and 17107 deletions
+4 -8
View File
@@ -3,15 +3,12 @@ appVersion: "5.7.18"
dependencies:
- name: common
repository: https://library-charts.truecharts.org
version: 11.1.2
- condition: postgresql.enabled
name: postgresql
repository: https://deps.truecharts.org/
version: 11.0.31
version: 12.2.32
- condition: redis.enabled
name: redis
repository: https://deps.truecharts.org
version: 5.0.33
version: 6.0.18
deprecated: false
description: A free and open source personal finance manager
home: https://truecharts.org/charts/stable/fireflyiii
@@ -29,9 +26,8 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/fireflyiii
- https://github.com/firefly-iii/firefly-iii/
type: application
version: 19.0.26
version: 20.0.0
annotations:
truecharts.org/catagories: |
- finacial
truecharts.org/SCALE-support: "true"
truecharts.org/grade: U
+106
View File
@@ -0,0 +1,106 @@
Business Source License 1.1
Parameters
Licensor: The TrueCharts Project, it's owner and it's contributors
Licensed Work: The TrueCharts "Blocky" Helm Chart
Additional Use Grant: You may use the licensed work in production, as long
as it is directly sourced from a TrueCharts provided
official repository, catalog or source. You may also make private
modification to the directly sourced licenced work,
when used in production.
The following cases are, due to their nature, also
defined as 'production use' and explicitly prohibited:
- Bundling, including or displaying the licensed work
with(in) another work intended for production use,
with the apparent intend of facilitating and/or
promoting production use by third parties in
violation of this license.
Change Date: 2050-01-01
Change License: 3-clause BSD license
For information about alternative licensing arrangements for the Software,
please contact: legal@truecharts.org
Notice
The Business Source License (this document, or the “License”) is not an Open
Source license. However, the Licensed Work will eventually be made available
under an Open Source License, as stated in this License.
License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
“Business Source License” is a trademark of MariaDB Corporation Ab.
-----------------------------------------------------------------------------
Business Source License 1.1
Terms
The Licensor hereby grants you the right to copy, modify, create derivative
works, redistribute, and make non-production use of the Licensed Work. The
Licensor may make an Additional Use Grant, above, permitting limited
production use.
Effective on the Change Date, or the fourth anniversary of the first publicly
available distribution of a specific version of the Licensed Work under this
License, whichever comes first, the Licensor hereby grants you rights under
the terms of the Change License, and the rights granted in the paragraph
above terminate.
If your use of the Licensed Work does not comply with the requirements
currently in effect as described in this License, you must purchase a
commercial license from the Licensor, its affiliated entities, or authorized
resellers, or you must refrain from using the Licensed Work.
All copies of the original and modified Licensed Work, and derivative works
of the Licensed Work, are subject to this License. This License applies
separately for each version of the Licensed Work and the Change Date may vary
for each version of the Licensed Work released by Licensor.
You must conspicuously display this License on each original or modified copy
of the Licensed Work. If you receive the Licensed Work in original or
modified form from a third party, the terms and conditions set forth in this
License apply to your use of that work.
Any use of the Licensed Work in violation of this License will automatically
terminate your rights under this License for the current and all other
versions of the Licensed Work.
This License does not grant you any right in any trademark or logo of
Licensor or its affiliates (provided that you may use a trademark or logo of
Licensor as expressly required by this License).
TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.
MariaDB hereby grants you permission to use this License’s text to license
your works, and to refer to it using the trademark “Business Source License”,
as long as you comply with the Covenants of Licensor below.
Covenants of Licensor
In consideration of the right to use this License’s text and the “Business
Source License” name and trademark, Licensor covenants to MariaDB, and to all
other recipients of the licensed work to be provided by Licensor:
1. To specify as the Change License the GPL Version 2.0 or any later version,
or a license that is compatible with GPL Version 2.0 or a later version,
where “compatible” means that software provided under the Change License can
be included in a program with software provided under GPL Version 2.0 or a
later version. Licensor may specify additional Change Licenses without
limitation.
2. To either: (a) specify an additional grant of rights to use that does not
impose any additional restriction on the right granted in this License, as
the Additional Use Grant; or (b) insert the text “None”.
3. To specify a Change Date.
4. Not to modify this License in any other way.
+27 -33
View File
@@ -10,37 +10,31 @@ questions:
# Include{replicas1}
# Include{podSpec}
# Include{containerMain}
- variable: env
group: "App Configuration"
label: "Image Environment"
schema:
additional_attrs: true
type: dict
attrs:
- variable: APP_URL
label: "APP_URL"
description: "Application URL eg. https://fireflyiii.mydomain.com"
schema:
type: string
default: "http://localhost:10082"
- variable: TRUSTED_PROXIES
label: "TRUSTED_PROXIES"
description: "TRUSTED_PROXIES"
schema:
type: string
default: "172.16.0.0/16"
# Include{containerBasic}
# Include{containerAdvanced}
- variable: env
group: "App Configuration"
label: "Image Environment"
schema:
additional_attrs: true
type: dict
attrs:
- variable: APP_URL
label: "APP_URL"
description: "Application URL eg. https://fireflyiii.mydomain.com"
schema:
type: string
default: "http://localhost:10082"
- variable: TRUSTED_PROXIES
label: "TRUSTED_PROXIES"
description: "TRUSTED_PROXIES"
schema:
type: string
default: "172.16.0.0/16"
# Include{containerConfig}
# Include{serviceRoot}
- variable: main
label: "Main Service"
description: "The Primary service on which the healthcheck runs, often the webUI"
schema:
additional_attrs: true
type: dict
attrs:
# Include{serviceMain}
# Include{serviceSelectorLoadBalancer}
# Include{serviceSelectorExtras}
- variable: main
@@ -89,16 +83,16 @@ questions:
schema:
type: int
default: 0
- variable: runAsGroup
label: "runAsGroup"
description: "The groupID this App of the user running the application"
schema:
type: int
default: 0
- variable: runAsGroup
label: "runAsGroup"
description: "The groupID this App of the user running the application"
schema:
type: int
default: 0
# Include{securityContextContainer}
# Include{securityContextAdvanced}
# Include{securityContextPod}
- variable: fsGroup
- variable: fsGroup
label: "fsGroup"
description: "The group that should own ALL storage."
schema:
@@ -0,0 +1 @@
{{- include "tc.v1.common.lib.chart.notes" $ -}}
+27 -49
View File
@@ -1,54 +1,32 @@
{{/* Define the cronjob */}}
{{- define "fireflyiii.cronjob" -}}
{{- $jobName := include "tc.common.names.fullname" . }}
{{- $basename := include "tc.v1.common.lib.chart.names.fullname" $ -}}
enabled: true
type: "CronJob"
schedule: "0 8 * * *"
podSpec:
restartPolicy: Never
containers:
cron:
enabled: true
primary: true
probes:
startup:
enabled: false
readiness:
enabled: false
liveness:
enabled: false
imageSelector: alpineImage
args:
- curl
- "http://{{ $basename }}.ix-{{ .Release.Name }}.svc.cluster.local:{{ .Values.service.main.ports.main.port }}/api/v1/cron/$(STATIC_CRON_TOKEN)"
env:
STATIC_CRON_TOKEN:
secretKeyRef:
name: secrets
key: STATIC_CRON_TOKEN
---
apiVersion: batch/v1
kind: CronJob
metadata:
name: {{ printf "%s-cronjob" $jobName }}
labels:
{{- include "tc.common.labels" . | nindent 4 }}
spec:
schedule: "{{ .Values.cronjob.schedule }}"
concurrencyPolicy: Forbid
{{- with .Values.cronjob.failedJobsHistoryLimit }}
failedJobsHistoryLimit: {{ . }}
{{- end }}
{{- with .Values.cronjob.successfulJobsHistoryLimit }}
successfulJobsHistoryLimit: {{ . }}
{{- end }}
jobTemplate:
metadata:
spec:
template:
metadata:
spec:
securityContext:
runAsUser: 568
runAsGroup: 568
restartPolicy: Never
containers:
- name: {{ .Chart.Name }}
securityContext:
privileged: false
readOnlyRootFilesystem: true
allowPrivilegeEscalation: false
runAsNonRoot: true
capabilities:
drop:
- ALL
env:
- name: STATIC_CRON_TOKEN
valueFrom:
secretKeyRef:
name: fireflyiii-secrets
key: STATIC_CRON_TOKEN
image: "{{ .Values.ubuntuImage.repository }}:{{ .Values.ubuntuImage.tag }}"
args:
- curl
- "http://{{ $jobName }}.ix-{{ .Release.Name }}.svc.cluster.local:{{ .Values.service.main.ports.main.port }}/api/v1/cron/$(STATIC_CRON_TOKEN)"
resources:
{{ toYaml .Values.resources | indent 16 }}
{{- end -}}
@@ -1,24 +1,17 @@
{{/* Define the secrets */}}
{{- define "fireflyiii.secrets" -}}
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
name: fireflyiii-secrets
{{- $fireflyiiiprevious := lookup "v1" "Secret" .Release.Namespace "fireflyiii-secrets" }}
{{- $static_cron_token := "" }}
{{- $app_key := "" }}
{{- $secretName := (printf "%s-fireflyiii-secrets" (include "tc.v1.common.lib.chart.names.fullname" $)) }}
{{- $fireflyiiiprevious := lookup "v1" "Secret" .Release.Namespace $secretName }}
enabled: true
data:
{{- if $fireflyiiiprevious}}
STATIC_CRON_TOKEN: {{ index $fireflyiiiprevious.data "STATIC_CRON_TOKEN" }}
APP_KEY: {{ index $fireflyiiiprevious.data "APP_KEY" }}
{{- if $fireflyiiiprevious }}
STATIC_CRON_TOKEN: {{ index $fireflyiiiprevious.data "STATIC_CRON_TOKEN" | b64dec }}
APP_KEY: {{ index $fireflyiiiprevious.data "APP_KEY" | b64dec }}
{{- else }}
{{- $static_cron_token := randAlphaNum 32 }}
{{- $app_key := randAlphaNum 32 }}
STATIC_CRON_TOKEN: {{ $static_cron_token | b64enc }}
APP_KEY: {{ $app_key | b64enc }}
STATIC_CRON_TOKEN: {{ $static_cron_token }}
APP_KEY: {{ $app_key }}
{{- end }}
{{- end -}}
+10 -4
View File
@@ -1,11 +1,17 @@
{{/* Make sure all variables are set properly */}}
{{- include "tc.common.loader.init" . }}
{{- include "tc.v1.common.loader.init" . }}
{{/* Render secrets for fireflyiii */}}
{{- include "fireflyiii.secrets" . }}
{{- $secrets := include "fireflyiii.secrets" . | fromYaml -}}
{{- if $secrets -}}
{{- $_ := set .Values.secret "secrets" $secrets -}}
{{- end -}}
{{/* Render cronjob for fireflyiii */}}
{{- include "fireflyiii.cronjob" . }}
{{- $cronjob := include "fireflyiii.cronjob" . | fromYaml -}}
{{- if $cronjob -}}
{{- $_ := set .Values.workload "cron" $cronjob -}}
{{- end -}}
{{/* Render the templates */}}
{{ include "tc.common.loader.apply" . }}
{{ include "tc.v1.common.loader.apply" . }}
+63 -60
View File
@@ -4,12 +4,63 @@ image:
tag: 5.7.18@sha256:e3334cf84059830c9df3ed1d23f7cc79d8320a7d90f5667072ae47a3ccb031fa
securityContext:
readOnlyRootFilesystem: false
runAsNonRoot: false
container:
readOnlyRootFilesystem: false
runAsNonRoot: false
runAsUser: 0
runAsGroup: 0
podSecurityContext:
runAsUser: 0
runAsGroup: 0
workload:
main:
podSpec:
containers:
main:
probes:
liveness:
path: "/login"
readiness:
path: "/login"
startup:
path: "/login"
env:
DB_USERNAME: "{{ .Values.cnpg.main.user }}"
DB_DATABASE: "{{ .Values.cnpg.main.database }}"
DB_CONNECTION: pgsql
DB_PORT: 5432
REDIS_DB: "0"
REDIS_CACHE_DB: "1"
CACHE_DRIVER: redis
SESSION_DRIVER: redis
REDIS_SCHEME: tcp
REDIS_PORT: 6379
APP_URL: ""
TRUSTED_PROXIES: "172.16.0.0/16"
DB_HOST:
secretKeyRef:
name: cnpg-main-urls
key: host
DB_PASSWORD:
secretKeyRef:
name: cnpg-main-user
key: password
REDIS_HOST:
secretKeyRef:
expandObjectName: false
name: '{{ printf "%s-%s" .Release.Name "rediscreds" }}'
key: plainhost
REDIS_PASSWORD:
secretKeyRef:
expandObjectName: false
name: '{{ printf "%s-%s" .Release.Name "rediscreds" }}'
key: redis-password
STATIC_CRON_TOKEN:
secretKeyRef:
name: secrets
key: STATIC_CRON_TOKEN
APP_KEY:
secretKeyRef:
name: secrets
key: APP_KEY
service:
main:
@@ -18,54 +69,6 @@ service:
port: 10082
targetPort: 8080
probes:
liveness:
path: "/login"
readiness:
path: "/login"
startup:
path: "/login"
env:
DB_USERNAME: "{{ .Values.postgresql.postgresqlUsername }}"
DB_DATABASE: "{{ .Values.postgresql.postgresqlDatabase }}"
DB_CONNECTION: pgsql
DB_PORT: 5432
REDIS_DB: "0"
REDIS_CACHE_DB: "1"
CACHE_DRIVER: redis
SESSION_DRIVER: redis
REDIS_SCHEME: tcp
REDIS_PORT: 6379
APP_URL: ""
TRUSTED_PROXIES: "172.16.0.0/16"
DB_HOST:
secretKeyRef:
name: dbcreds
key: plainhost
DB_PASSWORD:
secretKeyRef:
name: dbcreds
key: postgresql-password
REDIS_HOST:
secretKeyRef:
name: rediscreds
key: plainhost
REDIS_PASSWORD:
secretKeyRef:
name: rediscreds
key: redis-password
STATIC_CRON_TOKEN:
secretKeyRef:
name: fireflyiii-secrets
key: STATIC_CRON_TOKEN
APP_KEY:
secretKeyRef:
name: fireflyiii-secrets
key: APP_KEY
persistence:
data:
enabled: true
@@ -80,14 +83,14 @@ cronjob:
# Enabled redis
redis:
enabled: true
existingSecret: "rediscreds"
# Enabled postgres
postgresql:
enabled: true
existingSecret: "dbcreds"
postgresqlUsername: firefly
postgresqlDatabase: firefly
cnpg:
main:
enabled: true
user: firefly
database: firefly
portal:
enabled: true
open:
enabled: true