Common-Library Enhancement Tracker

[PrivatePuffin]

We're planning to completely refactor the common chart and here are some important key notes that need to be tracked/completed:

Post 01-03-2023

HIGH PRIO: Buglist

• [x] Portal button not working (assigned: @stavros-k )
• [x] fix scale cert not showing in GUI (Assigned: @Ornias1993 )
• [ ] fix prometheus metrics endpoint not working in grafana (at all?)
• [ ] fix no ingress option being shown in blocky (Assigned: @Ornias1993 )
• [ ] fix grafana metrics not being fetched by prometheus
• [ ] add authelia metrics endpoints
• [x] Actually expose the query logging options in blocky gui and make postgres optional (Assigned: @Ornias1993 )
• [x] Prometheus trowing service-class line 46 error (eq related) on SCALE only (assigned: @stavros-k )
• [x] k8s-gateway not working on blocky (Assigned: @Ornias1993 )
• [x] grafana env vars not being rendered (Assigned: @Ornias1993 )

Implementation Tracking:

• [x] Last-day-before-codefreeze container updates
• [x] Merge *arr breaking changes
• [x] Merge vikunja breaking changes
• [x] Adapt and test Enterprise Apps
• [x] Move Vaultwarden to enterprise and adapt for new common (test as well)
• [x] Move Authelia to enterprise and adapt for new common (test as well)
• [x] Adapt and test dependency Apps (except postgresql)
• [x] Adapt incubator Apps
• [x] Adapt stable Apps
• [x] Adapt and test postgresql dependency App
• [x] Redesign and move nextcloud app to enterprise train

After Adaptation Polish checking:

• [x] check and polish incubator apps (assigned: @xstar97 )
• [x] check and polish stable apps (assigned: @stavros-k )
• [x] rewrite certificate docs (assigned: @StevenMcElligott and/or @xstar97 )
• [x] check and update vpn docs (assigned: @StevenMcElligott and/or @xstar97 )
• [x] check and update stable docs (assigned: @StevenMcElligott and/or @xstar97 )
• [x] check and update incubator docs (assigned: @StevenMcElligott and/or @xstar97 )
• [x] check and update configuration sections style docs (assigned: @StevenMcElligott and/or @xstar97 )
• [x] Add CNPG configuration section docs (assigned: @StevenMcElligott and/or @xstar97 )

Pre 01-03-2023

GUI tracking changes tracking list:

• [x] Adapt questions template for metrics (assigned: @Ornias1993 )
• [x] Adapt questions for VPN (move to gluetun) (assigned: @Ornias1993 )
• [x] Adapt charts-repo questions for ingress to support new certificate system
• [x] Adapt questions template for workloads (assigned: @Ornias1993 )
• [x] Adapt questions for securityContext (assigned: @Ornias1993 )
• [x] Add Netshoot GUI element (assigned: @Ornias1993 )
• [x] Add CNPG section (assigned: @Ornias1993 )
• [x] Adapt questions.yaml portal configmap link (assigned: @Ornias1993 )
• [x] Add postgresql -> migration code (assigned: @Ornias1993 )
• [x] Readd openvpn (assigned: @Ornias1993 )
• [x] Readd wireguard (assigned: @Ornias1993 )
• [x] Ensure all common dependencies are updated and pinned (assigned: @Ornias1993 )
• [x] check openvpn and wireguard unittests (assigned: @stavros-k )
• [x] Add python migration thingy to remove metrics when .Values.metrics.enabled is present (assigned: @stavros-k )

Required for release (priority):

• [x] Readd/redesign vpn addon
• [x] Fix adding the vpn container to the selected pods (assigned: @stavros-k )
• [x] Readd/redesign codeserver addon as a seperate pod
• [x] Fix adding the codeserver workloads (assigned: @stavros-k )
• [x] reAdd portal system
• [x] Connect portal with ingress
• [x] fixup persistence unittests (assigned: @Ornias1993 )
• [x] write pre-release announcement (assigned: @Ornias1993 )
• [x] Give codeserver addon soft affinity to stick to the main pod. (assigned: @stavros-k )
• [x] ensure all persistence is (also) attached to codeserver addon pod (assigned: @stavros-k )
• [x] fix initcontainer tests (assigned: @stavros-k )
• [x] fix codeserver addon basic unittests (assigned: @Ornias1993 )
• [x] Fix dependency init containers not being created (assigned: @stavros-k )
• [x] move resources to .Values.resources (assigned: @Ornias1993 )
• [x] move PUID and UMASK to container security context (assigned: @Ornias1993 )
• [x] fix unittests for PUID, UMASK and resources (assigned: @stavros-k )
• [x] devicesList permission patches (assigned: @stavros-k )
• [x] fix vpn addons (assigned: @stavros-k )
• [x] fix vpn addon basic unittests (assigned: @stavros-k )

Big changes:

• [x] Restructure for future multipod support
• [x] Add multi-pod support

General Changes Tracking list:

• [x] Build new vpn addon for wireguard and openvpn
• [x] Rebuild cnpg backend
• [x] Append connection information to notex.txt (assigned: @Ornias1993 )
• [x] Append website docs instructions to notes.txt (assigned: @Ornias1993 )
• [x] CNPG: Move secrets to class
• [x] CNPG: Move metrics to class
• [x] Add ALPHA/BETA support for gateway API route creation

When possible/reasonable

Unit Tests Tracking list

This section lists the required unittests, some might already be present (and can be checked off after verifying they exists), others need to be writhen from scratch. Feel free to submit PR's for additional unittests to the following branch: https://github.com/truecharts/library-charts

Metrics:

• [ ] Add unittests for basic settings such as displayed in values.yaml

HPA:

• [ ] test if defaults are all set correctly on main HPA
• [ ] test if additional HPA's can be created with correct defaults
• [ ] targetKind: test can be set
• [ ] target: test can be set
• [ ] minReplicas: test can be set
• [ ] maxReplicas: test can be set
• [ ] targetCPUUtilizationPercentage: test can be set
• [ ] targetMemoryUtilizationPercentage: check if can be set

networkPolicy:

• [ ] test if can be enabled
• [ ] test if podSelector defaults to helm-chart selector labels
• [ ] test if policyTypes can be set
• [ ] test if egress can be set
• [ ] test if ingress can be set
• [ ] test if multiple can be added.

addons:

• [ ] cover more setup options with tests

Ingress:

• [x] Review of current ingress unittest coverage
• [x] ensure traefik annotations get set
• [x] ensure middleware options work
• [x] Ensure normal ingress is fully usable without SCALE certs
• [x] Test SCALE Cert generation
• [x] Test SCALE certificate loaded with Ingress

Portal:

• [x] Add unittests

gatewayAPI:

• Add route unittests

cnpg:

• [x] add cluster unittests
• [x] add pooler unittests
• [x] add secrets unittests

Dependencies:

• [x] Add postgresql unittests
• [ ] Add redis Unittests
• [ ] Add mariadb unittests
• [ ] Add mongodb unittests
• [ ] Add clickhouse unittests
• [ ] Add Solr unittests

Common feature (To add):

• [ ] Add affinity support
• [ ] GPU definition in the resources

[PrivatePuffin]

@all-contributors please add @Sagit-chu for video and doc

[allcontributors[bot]]

@Ornias1993

I've put up a pull request to add @Sagit-chu! :tada:

[PrivatePuffin]

@all-contributors please add @brunofatia for financial

[allcontributors[bot]]

@Ornias1993

I've put up a pull request to add @brunofatia! :tada:

[truecharts-admin]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in two weeks if no further activity occurs. Thank you for your contributions.

[PrivatePuffin]

Nearly all done or moved to projects instead