Skip to content

How to update the Kyverno Package chart📜

Kyverno within Big Bang is a modified version of an upstream chart. kpt is used to handle any automatic updates from upstream. The below details the steps required to update to a new version of the Kyverno package.

  1. Review the upstream changelog for potential breaking changes.
  2. Navigate to the upstream kyverno helm chart repo and find the latest chart version that works with the image update. For example, if updating to 1.9.1 I would look at the Chart.yaml appVersion field and switch through the latest git tags until I find one that matches 1.9.1. For this example that would be v1.9.1.
  3. Check out the existing renovate/ironbank branch created by the renovate-runner, an MR for this branch should be linked in the Renovate issue.
  4. From the top level of the repo run kpt pkg update chart@{GIT TAG} --strategy alpha-git-patch replacing {GIT TAG} with the tag you found in step one. You may run into some merge conflicts, resolve these in the way that makes the most sense. In general, if something is a BB addition you will want to keep it, otherwise go with the upstream change.
  5. Append -bb.0 to the version in chart/Chart.yaml.
  6. Run helm dependency update from the ./chart directory to regenerate dependencies.
  7. Update CHANGELOG.md adding an entry for the new version and noting all changes (at minimum should include Updated Kyverno to x.x.x).
  8. Generate the README.md updates by following the guide in gluon.
  9. Open an MR in “Draft” status ( or the Renovate created MR ) and validate that CI passes. This will perform a number of smoke tests against the package, but it is good to manually deploy to test some things that CI doesn’t. Follow the steps below for manual testing.
  10. Once all manual testing is complete take your MR out of “Draft” status and add the review label.

Testing New Kyverno Version📜

NOTE: For these testing steps it is good to do them on both a clean install and an upgrade. For clean install, point kyverno to your branch. For an upgrade do an install with kyverno pointing to the latest tag, then perform a helm upgrade with kyverno pointing to your branch.

You will want to install with: - Kyverno Kyverno-Policies, and Kyverno-Reporter enabled - Istio enabled - Monitoring enabled

Checking Prometheus for Kyverno dashboards - Login to Prometheus, validate under Status -> Targets that all kyverno controller targets are showing as up - Login to Grafana, then navigate to the Kyverno daskboard ( Dashboards > Browse > Kyverno Metrics ) and validate that the dashboard displays data

📌 NOTE: if using MacOS make sure that you have gnu sed installed and add it to your PATH variable GNU SED Instructions - [ ] Test secret sync in new namespace 

# create secret in kyverno NS
kubectl create secret generic \
  -n kyverno kyverno-bbtest-secret \
  --from-literal=username='username' \
  --from-literal=password='password'

# Create Kyverno Policy
kubectl apply -f https://repo1.dso.mil/big-bang/product/packages/kyverno/-/raw/main/chart/tests/manifests/sync-secrets.yaml

# Wait until the policy shows as ready before proceeding
kubectl get clusterpolicy sync-secrets

# Create a namespace with the correct label (essentially we are dry-running a namespace creation to get the yaml, adding the label, then applying)
kubectl create namespace kyverno-bbtest --dry-run=client -o yaml | sed '/^metadata:/a\ \ labels: {"kubernetes.io/metadata.name": "kyverno-bbtest"}' | kubectl apply -f -

# Check for the secret that should be synced - if it exists this test is successful
kubectl get secrets kyverno-bbtest-secret -n kyverno-bbtest
- [ ] Delete the test resources 
# If above is successful, delete test resources
kubectl delete -f https://repo1.dso.mil/big-bang/product/packages/kyverno/-/raw/main/chart/tests/manifests/sync-secrets.yaml
kubectl delete secret kyverno-bbtest-secret -n kyverno
kubectl delete ns kyverno-bbtest

Modifications made to upstream chart📜

Main📜

chart/Chart.yaml📜

  • Added -bb to chart version
  • Added bigbang.dev/applicationVersions and helm.sh/images to annotations
  • Added gluon to dependencies

chart/values.yaml📜

  • Set upgrade.fromV2 to true

  • Set apiVersionOverride.podDisruptionBudget to policy/v1

  • Set defaultRegistry to registry1.dso.mil

  • Set existingImagePullSecrets to private-registry

  • Set image fields to use ironbank images, as follows: 

    image:
  registry: registry1.dso.mil
  repository: ironbank/{repository_path}
  tag: {tag}
imagePullSecrets:
- name: private-registry
    in the following locations

  • test
  • webhooksCleanup
  • cleanupJobs.admissionReports
  • cleanupJobs.clusterAdmissionReports
  • admissionController.initContainer
  • admissionController.container
  • backgroundController
  • cleanupController
  • reportsController

  • policyReportsCleanup

  • Set podSecurityContext and securityContext, as follows: 

    podSecurityContext:
  runAsUser: {id}
  runAsGroup: {id}
  runAsNonRoot: true
securityContext:
  runAsUser: {id}
  runAsGroup: {id}
    according to the chart below | key | id | | — | – | | test | 65534 | | webhooksCleanup | 1001 | | cleanupJobs.admissionReports | 1000 | | cleanupJobs.clusterAdmissionReports | 1000 | | admissionController | 10001 | | backgroundController | 1000 | | cleanupController | 1000 | | reportsController | 1000 | | policyReportsCleanup | 1001 |

  • Set features.policyExceptions.namespace to kyverno

  • Set admissionController.replicas to 3

  • Set admissionController.container.resources as follows: 

    resources:
limits:
  cpu: 500m
  memory: 512Mi
requests:
  cpu: 500m
  memory: 512Mi

  • Add service accounts rule to backgroundController.rbac.coreClusterRole.extraResources as follows: 

    - apiGroups: 
    - ''
  resources: 
    - serviceaccounts
  verbs: 
    - get
    - list 
    - watch
    - update
    - patch

  • Added Big Bang monitoring, networkPolicies, istio, openshift, and bbtests fields

  • automountServiceAccountToken.enabled added to:

  • admissionController.rbac.serviceAccount
  • admissionController.rbac.deployment
  • backgroundController.rbac.serviceAccount
  • backgroundController.rbac.deployment
  • cleanupJobs.admissionReports
  • cleanupJobs.clusterAdmissionReports
  • cleanupJobs.rbac.serviceAccount
  • cleanupController.deployment.serviceAccount
  • cleanupController.rbac.serviceAccount
  • reportsController.deployment.serviceAccount
  • reportsController.rbac.serviceAccount
  • webhooksCleanup

chart/charts📜

  • Generate gluon dependency

chart/tests/📜

  • Add test files /manifests/sync-secrets.yaml and scripts/secrets.sh

chart/crds/📜

  • Add crd-servicemonitors.yaml from monitoring package

Templates📜

chart/templates/bigbang/network-policy📜

  • Add Big Bang network policy templates

chart/templates/_helpers.tpl📜

  • Add kyverno.test-labels definition for required helm labels

chart/templates/cleanup-controller/role.yaml📜

  • Add rule for core API group on configmaps: 
    - apiGroups:
    - ''
  resources:
    - configmaps
  verbs:
    - get
    - list
    - watch

chart/templates/tests/📜

  • In each of the upstream tests, admission-controller-liveness, admission-controller-metrics, admission-controller-readiness, cleanup-controller-liveness, cleanup-controller-metrics, cleanup-controller-readiness, and reports-controller-metrics:
  • Check whether bbtests is enabled 
    {{- if dig "bbtests" "enabled" false (merge .Values dict) }}
  ...
{{- end }}
  • Add podSecurityContext and imagePullSecrets 
    {{- with .Values.test.podSecurityContext }}
securityContext:
  {{- tpl (toYaml .) $ | nindent 4 }}
{{- end }}
{{- with .Values.test.imagePullSecrets }}
imagePullSecrets: {{ tpl (toYaml .) $ | nindent 8 }}
{{- end }}

  • Replace wget with curl

  • Add Big Bang test files clusterrole, clusterrolebinding, configmap, gluon, serviceaccount, and test

automountServiceAccountToken📜

The following files have been updated to manage the auto-mounting of ServiceAccount tokens and can be disabling/enabling per SA and/or deployment

templates/admission-controller/deployment.yaml
templates/admission-controller/serviceaccount.yaml
templates/background-controller/deployment.yaml
templates/background-controller/serviceaccount.yaml
templates/cleanup-controller/deployment.yaml
templates/cleanup-controller/serviceaccount.yaml
templates/cleanup/cleanup-admission-reports.yaml
templates/cleanup/cleanup-cluster-admission-reports.yaml
templates/cleanup/serviceaccount.yaml
templates/hooks/pre-delete.yaml
templates/reports-controller/deployment.yaml
templates/reports-controller/serviceaccount.yaml
values.yaml
Last update: 2024-01-08 by Bulat Khamitov