Skip to main content

Simulating KOBIL Shift deployment

Scope: How to simulate a KOBIL Shift deployment - templating all manifests

As KOBIL Shift is an Operator Deployment and the KOBIL Shift Chart is a meta-Chart for KOBIL Shift services subcharts, there is no way to do a native "manifest templating" (i.e. by using helm template command).  Please request the current script from KOBIL Project-Team matching to the targeted KOBIL Shift release.

This simulation allows to create all manifest-files for all SHIFT resources named in charts under item "kind". It covers all the configurations in metaconfig file "values.yaml" - also covering the full qualified image-names. This will allow the retrieval the full qualified image-names for a targeted KOBIL Shift release and metaconfiguration file "values.yaml" - which could be used then for subsequent image-scans.

Requirements: Ensure to have full "helm" and "yq" tool setup on your shell environment to run the script.  Ensure to have KOBIL Chart repository access credentials available to register the KOBIL Chart repository (see: KOBIL Repository Access) for having the KOBIL Chart repository available for helm runtime. How to run the script: Make use of the KOBIL Shift metaconfiguration file "values.yaml" which is compost for the targeted KOBIL Shift deployment Use additional "overriding" configuration files - if used in your production environment (i.e. pipeline setup) Make use of the targeted KOBIL Shift Chart release  Run the script - find sample below

Running the "shift-operator-simulator" script:

./shift-operator-simulator.sh 

Simulates KOBIL Shift operator locally.

Generate the helm values used by KOBIL Shift operator when deploying subcharts.
Templates the subcharts using the extracted values. Lists the docker images used by the subcharts.

Usage:
  shift-operator-simulator.sh <helm-repo> <chart> <version> <values-file_1> <values-file_2> ... <values-file_n>

Parameters:
  <helm-repo>      Helm chart repository previously added using 'helm repo add', e.g. 'kobil'.
  <chart>          Helm chart name to process, e.g. 'shift'.
  <version>        Helm chart version to process.
  <values-file>    Name of yaml file containing custom helm values to consider when generating the
                   subcharts helm values, e.g. 'custom-values.yaml'. Multiple files can be specified.

Sample execution:

shift-operator-simulator.sh  kobil shift 0.164.0 ./values_shift_01640.yaml 

Updating repo 'kobil'
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "kobil" chart repository
Update Complete. ⎈Happy Helming!⎈

Templating main chart...

  Chart: shift
  Version: 0.164.0
  Template folder: shift-0.164.0/templated/shift
  Values: ./values_shift_01640.yaml

Templating subcharts...

  Alias: astca
  Chart: astca
  Version: 6.3.0
  Template folder: shift-0.164.0/templated/astca/astca
  Chart folder: shift-0.164.0/charts/astca
  Values: shift-0.164.0/values/astca_astca_6.3.0_values.yaml
  ....

Once the script run is completed an extraction and templating directory remains in the local directory named "chart-name"-"version". I.e. for above sample this will be "shift-0.164.0".

Please contact KOBIL Project-Team for a copy of Shift-Operator simulation script.