shadwell/k8s-sidecar

Source is https://github.com/holmesb/k8s-sidecar

Intro

This docker image is intended to run inside a kubernetes cluster to collect config maps with a specified label and store the included files in a local folder. It can also send a html request to a specified URL after a configmap change. The changes versus kiwigrid/k8s-sidecar are specific to Jenkins. This image reloads the Jenkins Configuration as Code settings whenever designated JCasC configmaps change.

Logging & Security

In addition to comprehensive logging, the python script writes to a status file: /app/reload_successful.txt. This contains a single boolean value: "true" if reload was successful otherwise "false". This can be used to determine reload status externally. For example in a CI\CD pipeline that deploys and configures Jenkins from code, this allows deployment to a "staging" Jenkins first, and then only proceed to make changes to the "production" Jenkins if "staging" is successfully configured.

Operational logs can be obtained by command kubectl logs <jenkins-pod> -c jenkins-sc-config

For security, this container runs by default as a non-root user with minimal permissions: jenkins

Configuration Environment Variables

• label

  • description: Label that should be used for filtering
  • required: yes if jenkinsReloadConfigEnabled is true
  • type: string

• folder

  • description: Folder where the files should be placed
  • required: yes
  • type: string

• namespace

  • description: If specified, the sidecar will search for config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be
  • used. It's also possible to specify ALL to search in all namespaces.
  • required: no type: string

• req_url

  • description: URL to which send a request after a configmap got reloaded
  • required: no
  • type: URI

• req_method

  • description: Request method GET(default) or POST
  • required: false
  • type: string

• req_payload

  • description: If you use POST you can also provide json payload
  • required: false
  • type: json