K8s Cron Template ·

The aks-cron-chart-blueprint chart is the best way to release your microservice into PagoPA K8s environment. It contains all the required components to get started, and it has several architectural aspects already configured.

Some of the key benefits of this chart are:

• Highly secure environment thanks to Secret Store CSI Provider;
• Ingress HTTPS connection;
• Improved scalability and reliability thanks to Keda;
• Simpified way to setup secrets and configMaps

Architecture

To see the entire architecture please see this page architecture

Changelog

see CHANGELOG to see the new features and the breking changes

Pre requisites

• helm & kubernetes

Static analysis

Install:

• https://github.com/norwoodj/helm-docs

Installation

This is the official and recommended method to adopt this chart.

Quick start

Create a helm folder inside your cron service project in which install the Helm chart:

mkdir helm && cd helm

Add Helm repo:

helm repo add pagopa-cron https://pagopa.github.io/aks-cron-chart-blueprint

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages.

Add a very basic configuration in Chart.yaml:

cat <<EOF > Chart.yaml
apiVersion: v2
name: my-microservice
description: My microservice description
type: application
version: 1.0.0
appVersion: 1.0.0
dependencies:
- name: cron-chart
  version: 1.19.0
  repository: "https://pagopa.github.io/aks-cron-chart-blueprint"
EOF

Install the dependency:

helm dep build

Create a values-<env>.yaml for each environment:

touch values-dev.yaml values-uat.yaml values-prod.yaml

Override all values that you need, and form the root of your project install the chart:

helm upgrade -i -n <namespace name> -f <file with values> <name of the helm chart> <chart folder>

helm upgrade -i -n mynamespace -f helm/values-dev.yaml mymicroservice helm

Upgrading

Change version of the dependency and run the update:

cd helm && helm dep update .

Template/App mandatory resources and configuration

To work as expect this template must request:

App:

• has liveness and readiness endpoints
• you know which are the probes for your application, because are mandatory

Azure:

• TLS certificate are present into the kv (for ingress)
• Managed POD identity are created

K8s:

• Reloader of other tools that allow to restar the pod in case of some of the config map or secret are changed

Final Result

Here you can find a result of the template final result

Examples

In the example folder, you can find a working examples.

Progessive-delivery

Use spring-boot-app-color to test canary deployment

Azure function App

It is an elementary version of an Azure Function App written in NodeJS.

It has three functions:

• ready that responds to the readiness probe;
• live that responds to the liveness probe;
• secrets that return a USER and a PASS taken respectively from a K8s ConfigMap and an Azure Key Vault.

To try it locally use either the Azure Functions Core Tools or Docker.

You can also find a generic pipeline.

SpringBoot (Java) web app colors

https://github.com/pagopa/devops-java-springboot-color

there are two folders called:

• spring-boot-app-bar
• spring-boot-app-foo

This are only a helm chart that install a simple web application written in java springboot.

This can be usefull to check how works aks with two applications

Static Application Security Testing

We strongly suggest performing SAST on your microservice Helm chart. You could look at this GitHub Action.

Yaml chart configuration properties (values.yaml)

see README/Cron Chart configuration to understand how to use the values.

Yaml: how to load values from externals config maps and use as ENV variable

Is possibile to load inside the deployment the values of an external config map, into ENV variables.

To do so, you can use this example snippet code:

envConfigMapExternals:
  progressive-delivery-mock-one:
    PLAYER_INITIAL_LIVES_ENV: player_initial_lives
    UI_PROPERTIES_FILE_NAME_ENV: ui_properties_file_name

envConfigMapExternals:
  <config map name>:
    <ENV variable name>: <key name inside the config map>

Advanced

For more information, visit the complete documentation.

Development

Clone the repository and run the setup script:

git clone git@github.com:pagopa/aks-cron-chart-blueprint.git
cd aks-cron-chart-blueprint.git
sh /bin/setup

Warning

Setup script installs a version manager tool that may introduce compatibility issues in your environment. To prevent any potential problems, you can install these dependencies manually or with your favourite tool:

• NodeJS 14.17.3
• Helm 3.8.0

Publish

The branch gh-pages contains the GitHub page content and all released charts. To update the page content, use bin/publish.

Known issues and limitations

• None.

Breaking changes

v1.3.0

fileConfig Now change fileMode

  fileConfig:
    create: false
    fileMode: 420
    files: {}