Skip to content
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.

Sign up for GitHub

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

Various Helm Chart maintenance updates #158

Merged
merged 6 commits into from
Apr 13, 2023
Merged

Various Helm Chart maintenance updates #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c9ad48a
Updated email validator to use a custom regex
kamorel Apr 12, 2023
a8cd4c7
Update hpa to use version autoscaling/v2 - #145
jujaga Apr 12, 2023
79d87ca
Update chart template secrets to always base64 encrypt values - #154
jujaga Apr 12, 2023
4fc835e
Decouple patroni and external database template dependency - #131
jujaga Apr 12, 2023
340fad0
Expose database pool connections as environment variables - #152
jujaga Apr 13, 2023
1ede154
Bump helm chart to 0.0.13
jujaga Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions app/config/custom-environment-variables.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
{
"basicAuth": {
"enabled": "BASICAUTH_ENABLED",
"username": "BASICAUTH_USERNAME",
"password": "BASICAUTH_PASSWORD"
"password": "BASICAUTH_PASSWORD",
"username": "BASICAUTH_USERNAME"
},
"db": {
"enabled": "DB_ENABLED",
"database": "DB_DATABASE",
"host": "DB_HOST",
"username": "DB_USERNAME",
"password": "DB_PASSWORD",
"port": "DB_PORT"
"poolMin": "DB_POOL_MIN",
"poolMax": "DB_POOL_MAX",
"port": "DB_PORT",
"username": "DB_USERNAME"
},
"keycloak": {
"enabled": "KC_ENABLED",
Expand Down
2 changes: 2 additions & 0 deletions app/config/default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
"database": "coms",
"host": "localhost",
"port": "5432",
"poolMin": "2",
"poolMax": "10",
"username": "app"
},
"objectStorage": {
Expand Down
4 changes: 2 additions & 2 deletions app/knexfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ module.exports = {
directory: __dirname + '/src/db/migrations'
},
pool: {
min: 2,
max: 10
min: parseInt(config.get('db.poolMin')),
max: parseInt(config.get('db.poolMax'))
// This shouldn't be here: https://github.com/knex/knex/issues/3455#issuecomment-535554401
// propagateCreateError: false
},
Expand Down
6 changes: 6 additions & 0 deletions app/src/components/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ module.exports = Object.freeze({
URL: 'url'
},

/**
* Generic email regex modified to require domain of at least 2 characters
* @see {@link https://emailregex.com/}
*/
EMAILREGEX: '^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]{2,})+$',
Copy link
Contributor

@bcgv123 bcgv123 Apr 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering would be better to define the constant like: "EMAIL_REGEX" instead as combined (one word)? In the future we will have a multiple word constant, it might look nicer to split by _


/** Maximum Content Length supported by S3 CopyObjectCommand */
MAXCOPYOBJECTLENGTH: 5 * 1024 * 1024 * 1024,

Expand Down
4 changes: 2 additions & 2 deletions app/src/validators/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const { Joi: baseJoi } = require('express-validation');

const { Permissions } = require('../components/constants');
const { EMAILREGEX, Permissions } = require('../components/constants');

/**
* @constant Joi
Expand Down Expand Up @@ -39,7 +39,7 @@ const type = {
truthy: Joi.boolean()
.truthy('true', 1, '1', 't', 'yes', 'y', 'false', 0, '0', 'f', 'no', 'n'),

email: Joi.string().max(255).email(),
email: Joi.string().pattern(new RegExp(EMAILREGEX)).max(255),

uuidv4: Joi.string().guid({
version: 'uuidv4'
Expand Down
21 changes: 12 additions & 9 deletions app/tests/unit/validators/common.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const crypto = require('crypto');
const jestJoi = require('jest-joi');
expect.extend(jestJoi.matchers);

const { Permissions } = require('../../../src/components/constants');
const { EMAILREGEX, Permissions } = require('../../../src/components/constants');
Copy link
Contributor

@TimCsaky TimCsaky Apr 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just wondering, if BCBox needs to validate the email address .. so that it only calls the COMS search endpoint once the email is valid.
is the problem that as the bcbox user types, before the email is valid, it is passing it to coms?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of Kyle's PR. The regex is being backported from BCBox to here so that it remains in alignment - the Joi email definition isn't sufficiently meeting our needs.

const { scheme, type } = require('../../../src/validators/common');

describe('type', () => {
Expand Down Expand Up @@ -50,7 +50,6 @@ describe('type', () => {

describe('email', () => {
const model = type.email.describe();

it('is a string', () => {
expect(model).toBeTruthy();
expect(model.type).toEqual('string');
Expand All @@ -60,14 +59,18 @@ describe('type', () => {
expect(Array.isArray(model.rules)).toBeTruthy();
expect(model.rules).toHaveLength(2);
expect(model.rules).toEqual(expect.arrayContaining([
expect.objectContaining(
{
'args': {
'limit': 255
},
'name': 'max'
expect.objectContaining({
'args': {
'regex': new RegExp(EMAILREGEX).toString()
},
'name': 'pattern'
}),
expect.objectContaining({
'args': {
'limit': 255
},
{ 'name': 'email' })
'name': 'max'
})
]));
});

Expand Down
2 changes: 1 addition & 1 deletion charts/coms/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: common-object-management-service
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.0.12
version: 0.0.13
kubeVersion: ">= 1.13.0"
description: A microservice for managing access control to S3 Objects
# A chart can be either an 'application' or a 'library' chart.
Expand Down
23 changes: 15 additions & 8 deletions charts/coms/templates/deploymentconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{{ $dbHostName := .Values.config.configMap.DB_HOST }}
{{ $dbSecretName := printf "%s-%s" (include "coms.fullname" .) "passphrase" }}
{{- if .Values.patroni.enabled }}
{{ $dbHostName = include "patroni.fullname" .Subcharts.patroni }}
{{ $dbSecretName = include "patroni.fullname" .Subcharts.patroni }}
{{- end }}

{{- define "coms.connectsTo" -}}
apiVersion: apps/v1
kind: StatefulSet
Expand Down Expand Up @@ -40,19 +47,19 @@ spec:
valueFrom:
secretKeyRef:
key: app-db-name
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
- name: DB_HOST
value: {{ include "patroni.fullname" .Subcharts.patroni }}
value: {{ $dbHostName }}
- name: DB_USERNAME
valueFrom:
secretKeyRef:
key: app-db-username
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
- name: DB_PASSWORD
valueFrom:
secretKeyRef:
key: app-db-password
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
{{- end }}
type: Rolling
template:
Expand Down Expand Up @@ -115,19 +122,19 @@ spec:
valueFrom:
secretKeyRef:
key: app-db-name
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
- name: DB_HOST
value: {{ include "patroni.fullname" .Subcharts.patroni }}
value: {{ $dbHostName }}
- name: DB_USERNAME
valueFrom:
secretKeyRef:
key: app-db-username
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
- name: DB_PASSWORD
valueFrom:
secretKeyRef:
key: app-db-password
name: {{ include "patroni.fullname" .Subcharts.patroni }}
name: {{ $dbSecretName }}
{{- end }}
{{- if or .Values.features.oidcAuth .Values.config.configMap.KC_ENABLED }}
- name: KC_CLIENTID
Expand Down
2 changes: 1 addition & 1 deletion charts/coms/templates/hpa.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{- if .Values.autoscaling.enabled }}
---
apiVersion: autoscaling/v2beta2
apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
name: {{ include "coms.fullname" . }}
Expand Down
56 changes: 28 additions & 28 deletions charts/coms/templates/secret.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{{- $bPassword := (randAlphaNum 32) | b64enc }}
{{- $bUsername := (randAlphaNum 32) | b64enc }}
{{- $pPassword := (randAlphaNum 32) | b64enc }}
{{- $pUsername := (randAlphaNum 32) | b64enc }}
{{- $baPassword := (randAlphaNum 32) }}
{{- $baUsername := (randAlphaNum 32) }}
{{- $dbPassword := (randAlphaNum 32) }}
{{- $dbUsername := (randAlphaNum 32) }}

{{- $bSecretName := printf "%s-%s" (include "coms.fullname" .) "basicauth" }}
{{- $bSecret := (lookup "v1" "Secret" .Release.Namespace $bSecretName ) }}
{{- $kSecretName := printf "%s-%s" (include "coms.fullname" .) "keycloak" }}
{{- $kSecret := (lookup "v1" "Secret" .Release.Namespace $kSecretName ) }}
{{- $oSecretName := printf "%s-%s" (include "coms.fullname" .) "objectstorage" }}
{{- $oSecret := (lookup "v1" "Secret" .Release.Namespace $oSecretName ) }}
{{- $pSecretName := printf "%s-%s" (include "coms.fullname" .) "passphrase" }}
{{- $pSecret := (lookup "v1" "Secret" .Release.Namespace $pSecretName ) }}
{{- $baSecretName := printf "%s-%s" (include "coms.fullname" .) "basicauth" }}
{{- $baSecret := (lookup "v1" "Secret" .Release.Namespace $baSecretName ) }}
{{- $dbSecretName := printf "%s-%s" (include "coms.fullname" .) "passphrase" }}
{{- $dbSecret := (lookup "v1" "Secret" .Release.Namespace $dbSecretName ) }}
{{- $kcSecretName := printf "%s-%s" (include "coms.fullname" .) "keycloak" }}
{{- $kcSecret := (lookup "v1" "Secret" .Release.Namespace $kcSecretName ) }}
{{- $osSecretName := printf "%s-%s" (include "coms.fullname" .) "objectstorage" }}
{{- $osSecret := (lookup "v1" "Secret" .Release.Namespace $osSecretName ) }}

{{- if not $bSecret }}
{{- if not $baSecret }}
---
apiVersion: v1
kind: Secret
Expand All @@ -21,14 +21,14 @@ metadata:
annotations:
"helm.sh/resource-policy": keep
{{- end }}
name: {{ $bSecretName }}
name: {{ $baSecretName }}
labels: {{ include "coms.labels" . | nindent 4 }}
type: kubernetes.io/basic-auth
data:
password: {{ .Values.basicAuthSecretOverride.password | default $bPassword | quote }}
username: {{ .Values.basicAuthSecretOverride.username | default $bUsername | quote }}
password: {{ .Values.basicAuthSecretOverride.password | default $baPassword | b64enc | quote }}
username: {{ .Values.basicAuthSecretOverride.username | default $baUsername | b64enc | quote }}
{{- end }}
{{- if not $pSecret }}
{{- if not $dbSecret }}
---
apiVersion: v1
kind: Secret
Expand All @@ -37,14 +37,14 @@ metadata:
annotations:
"helm.sh/resource-policy": keep
{{- end }}
name: {{ $pSecretName }}
name: {{ $dbSecretName }}
labels: {{ include "coms.labels" . | nindent 4 }}
type: kubernetes.io/basic-auth
data:
password: {{ .Values.dbSecretOverride.password | default $pPassword | quote }}
username: {{ .Values.dbSecretOverride.username | default $pUsername | quote }}
password: {{ .Values.dbSecretOverride.password | default $dbPassword | b64enc | quote }}
username: {{ .Values.dbSecretOverride.username | default $dbUsername | b64enc | quote }}
{{- end }}
{{- if and (not $oSecret) (and .Values.objectStorageSecretOverride.password .Values.objectStorageSecretOverride.username) }}
{{- if and (not $kcSecret) (and .Values.keycloakSecretOverride.password .Values.keycloakSecretOverride.username) }}
---
apiVersion: v1
kind: Secret
Expand All @@ -53,14 +53,14 @@ metadata:
annotations:
"helm.sh/resource-policy": keep
{{- end }}
name: {{ $oSecretName }}
name: {{ $kcSecretName }}
labels: {{ include "coms.labels" . | nindent 4 }}
type: kubernetes.io/basic-auth
data:
password: {{ .Values.objectStorageSecretOverride.password | quote }}
username: {{ .Values.objectStorageSecretOverride.username | quote }}
password: {{ .Values.keycloakSecretOverride.password | b64enc | quote }}
username: {{ .Values.keycloakSecretOverride.username | b64enc | quote }}
{{- end }}
{{- if and (not $kSecret) (and .Values.keycloakSecretOverride.password .Values.keycloakSecretOverride.username) }}
{{- if and (not $osSecret) (and .Values.objectStorageSecretOverride.password .Values.objectStorageSecretOverride.username) }}
---
apiVersion: v1
kind: Secret
Expand All @@ -69,10 +69,10 @@ metadata:
annotations:
"helm.sh/resource-policy": keep
{{- end }}
name: {{ $kSecretName }}
name: {{ $osSecretName }}
labels: {{ include "coms.labels" . | nindent 4 }}
type: kubernetes.io/basic-auth
data:
password: {{ .Values.keycloakSecretOverride.password | quote }}
username: {{ .Values.keycloakSecretOverride.username | quote }}
password: {{ .Values.objectStorageSecretOverride.password | b64enc | quote }}
username: {{ .Values.objectStorageSecretOverride.username | b64enc | quote }}
{{- end }}
3 changes: 3 additions & 0 deletions charts/coms/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,10 @@ config:
# BASICAUTH_ENABLED: "true"

# DB_ENABLED: "true"
# DB_HOST: ~
DB_PORT: "5432"
# DB_POOL_MIN: "2"
# DB_POOL_MAX: "10"

# KC_ENABLED: "true"
KC_IDENTITYKEY: ~
Expand Down