DEVELOPMENT MAINTENANCE

Steps for KPT update

1. Navigate to the upstream chart repo and folder here and find the tag that corresponds with the new chart version for this update
2. Checkout the renovate/ironbank branch
3. From the root of the repo run kpt pkg update chart@<tag> --strategy alpha-git-patch, where tag is found in step 1, checkout the chart/Kptfile ref for tag naming
4. Modify the version in Chart.yaml and append -bb.0 to the chart version from upstream. Update dependencies to latest BB gluon library version using: helm dependency update ./chart
5. Update CHANGELOG.md adding an entry for the new version and noting all changes (at minimum should include Updated <chart or dependency> to x.x.x).
6. Generate the README.md updates by following the guide in gluon.
7. Push up your changes, add upgrade notices if applicable, validate that CI passes. If there are any failures, follow the information in the pipeline to make the necessary updates. Add the debug label to the MR for more detailed information. Reach out to the CODEOWNERS if needed.
8. Perform the steps below for manual testing

Modifications made to upstream

List of changes per file to be aware of for how Big Bang differs from upstream

/chart/Chart.yaml

• Added bigbang.dev/applicationVersions annotation with the promtail version
• Modified Version to include -bb.x suffix

/chart/ci/netpol-values.yaml

• Network Policies added to establish allowed communication in/out of namespace
• Extra ports added
• tcp-syslog 1514
• http-push 3500
• grpc-push 3600

chart/values.yaml

• Add common values for Big Bang packages for domain, networkpolicies and Istio
• Update image registry/repository/tag as required by update
• Add image pull secret for private-registry
• Set resource requests/limits
• Be wary of changes to relabel_configs: section, these may cause field action already set errors
• Append to containerSecurityContext

    runAsUser: 0
    privileged: false
    seLinuxOptions:
      type: spc_t
  

chart/Kptfile

• Tracks current upstream chart

Manual Testing

NOTE: For these testing steps it is good to do them on both a clean install and an upgrade. For clean install, point promtail to your branch. For an upgrade do an install with promtail pointing to the latest tag, then perform a helm upgrade with promtail pointing to your branch. - You will want to install with Istio, Monitoring, Loki and Promtail enabled.

overrides/promtail.yaml

monitoring:
  enabled: true
promtail:
  enabled: true
  git:
    tag: null
    branch: "renovate/ironbank"
  values:
    istio:
      enabled: true
      hardened:
        enabled: true
        # enabled: false
      prometheus:
        enabled: true
        # namespaces: [] # this will break prometheus scraping
    serviceMonitor:
      enabled: true
loki:
  enabled: true
  strategy: scalable
grafana:
  enabled: true

addons:
  minioOperator:
    enabled: true

Current testing is done manually. Deployment of Big Bang with Istio, Monitoring, Loki and Promtail enabled. Point the promtail git values at the feature branch. Deploy and ensure all resources reconcile and are healthy.

Once healthy - navigate in browser to grafana.bigbang.dev, login with default credentials and navigate Configuration -> Data sources -> Loki and click on Save & test and ensure Data source connected and labels found.

When in doubt with any testing or upgrade steps, reach out to the CODEOWNERS for assistance.

---

Last update: 2024-02-14 by Blane Staskiewicz