Kubernetes ConfigMaps: Nuances à connaître

Contexte: De rsync à ... Kubernetes

ConfigMaps simples

apiVersion: v1
kind: ConfigMap
metadata:
  name: app
data:
  config.json: |
    {
      "welcome": {{ pluck .Values.global.env .Values.welcome | quote }},
      "name": {{ pluck .Values.global.env .Values.name | quote }}
    }

$ cat .helm/values.yaml 
welcome:
  production: "Hello"
  test: "Hey"
name:
  production: "Bob"
  test: "Mike"

data:
  config.json: |
    {{ pluck .Values.global.env .Values.data | first | toJson | indent 4 }}

data:
  production:
    welcome: "Hello"
    name: "Bob"

Quand il y a beaucoup de configurations

data:
  config.json: |
    {
      "welcome": {{ pluck .Values.global.env .Values.welcome | first | quote }},
      "name": {{ pluck .Values.global.env .Values.name | first | quote }}
    }
  database.yml: |
    host: 127.0.0.1
    db: app
    user: app
    password: app

        volumeMounts:
        - name: app-conf
          mountPath: /app/configfiles/config.json
          subPath: config.json
        - name: app-conf
          mountPath: /app/configfiles/database.yml
          subPath: database.yml

        volumeMounts:
        - name: app-conf
          mountPath: /app/configfiles

Réponse au changement de ConfigMap

1. : ConfigMap, subPath.
   : .
2. : ConfigMap, pod.
   : pod .
3. : ConfigMap Deployment -.
   : , ConfigMap’, Deployment, pod , — .
4. : ConfigMap, .
   : pod’ / pod’.

Scénario 1

Scénario 2

Scénario 3

kind: Deployment
spec:
  template:
    metadata:
      annotations:
        checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
[...]

Scénario 4

• Un tel fichier de configuration mis à jour à l'intérieur du conteneur est mis à jour avec un certain retard. Cela est dû au fait que le fichier n'est pas monté exactement, mais l'objet Kubernetes.
• Le fichier à l'intérieur est un lien symbolique. Exemple avec subPath:
  
  

  $ kubectl -n production exec go-conf-example-6b4cb86569-22vqv -- ls -lha /app/configfiles 
  total 20K    
  drwxr-xr-x    1 root     root        4.0K Mar  3 19:34 .
  drwxr-xr-x    1 app      app         4.0K Mar  3 19:34 ..
  -rw-r--r--    1 root     root          42 Mar  3 19:34 config.json
  -rw-r--r--    1 root     root          47 Mar  3 19:34 database.yml

  
  Et que se passera-t-il sans une subPathfois monté par le répertoire?
  
  

  $ kubectl -n production exec go-conf-example-67c768c6fc-ccpwl -- ls -lha /app/configfiles 
  total 12K    
  drwxrwxrwx    3 root     root        4.0K Mar  3 19:40 .
  drwxr-xr-x    1 app      app         4.0K Mar  3 19:34 ..
  drwxr-xr-x    2 root     root        4.0K Mar  3 19:40 ..2020_03_03_16_40_36.675612011
  lrwxrwxrwx    1 root     root          31 Mar  3 19:40 ..data -> ..2020_03_03_16_40_36.675612011
  lrwxrwxrwx    1 root     root          18 Mar  3 19:40 config.json -> ..data/config.json
  lrwxrwxrwx    1 root     root          19 Mar  3 19:40 database.yml -> ..data/database.yml

  
  Mettez à jour la configuration (via deploy ou kubectl edit), attendez 2 minutes (temps de mise en cache apiserver) - et le tour est joué:
  
  

  $ kubectl -n production exec go-conf-example-67c768c6fc-ccpwl -- ls -lha --color /app/configfiles 
  total 12K    
  drwxrwxrwx    3 root     root        4.0K Mar  3 19:44 .
  drwxr-xr-x    1 app      app         4.0K Mar  3 19:34 ..
  drwxr-xr-x    2 root     root        4.0K Mar  3 19:44 ..2020_03_03_16_44_38.763148336
  lrwxrwxrwx    1 root     root          31 Mar  3 19:44 ..data -> ..2020_03_03_16_44_38.763148336
  lrwxrwxrwx    1 root     root          18 Mar  3 19:40 config.json -> ..data/config.json
  lrwxrwxrwx    1 root     root          19 Mar  3 19:40 database.yml -> ..data/database.yml

  
  Notez l'horodatage modifié dans le répertoire créé par Kubernetes.

Suivi des modifications

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"

	"github.com/fsnotify/fsnotify"
)

// Config fo our application
type Config struct {
	Welcome string `json:"welcome"`
	Name    string `json:"name"`
}

var (
	globalConfig *Config
)

// LoadConfig - load our config!
func LoadConfig(path string) (*Config, error) {
	configFile, err := os.Open(path)

	if err != nil {
		return nil, fmt.Errorf("Unable to read configuration file %s", path)
	}

	config := new(Config)

	decoder := json.NewDecoder(configFile)
	err = decoder.Decode(&config)
	if err != nil {
		return nil, fmt.Errorf("Unable to parse configuration file %s", path)
	}

	return config, nil
}

// ConfigWatcher - watches config.json for changes
func ConfigWatcher() {
	watcher, err := fsnotify.NewWatcher()
	if err != nil {
		log.Fatal(err)
	}
	defer watcher.Close()

	done := make(chan bool)
	go func() {
		for {
			select {
			case event, ok := <-watcher.Events:
				if !ok {
					return
				}
				log.Println("event:", event)
				if event.Op&fsnotify.Write == fsnotify.Write {
					log.Println("modified file:", event.Name)
				}
				globalConfig, _ = LoadConfig("./configfiles/config.json")
				log.Println("config:", globalConfig)
			case err, ok := <-watcher.Errors:
				if !ok {
					return
				}
				log.Println("error:", err)
			}
		}
	}()

	err = watcher.Add("./configfiles/config.json")
	if err != nil {
		log.Fatal(err)
	}
	<-done
}

func main() {
	log.Println("Start")
	globalConfig, _ = LoadConfig("./configfiles/config.json")
	go ConfigWatcher()
	for {
		log.Println("config:", globalConfig)
		time.Sleep(30 * time.Second)
	}
}

$ cat configfiles/config.json 
{
  "welcome": "Hello",
  "name": "Alice"
}

2020/03/03 22:18:22 config: &{Hello Alice}
2020/03/03 22:18:52 config: &{Hello Alice}

helm install -n habr-configmap --namespace habr-configmap ./habr-configmap --set 'name.production=Alice' --set 'global.env=production'

-  production: "Alice"
+  production: "Bob"

helm upgrade habr-configmap ./habr-configmap --set 'name.production=Bob' --set 'global.env=production'

• Les applications v1 et v2 ne redémarrent pas, car pour eux, aucun changement n'est intervenu dans le déploiement - ils accueillent toujours Alice.
• L'application v3 a redémarré, relu la configuration et salué Bob.
• L'application v4 n'a pas redémarré. Comme ConfigMap est monté en tant que répertoire, des changements dans la configuration ont été remarqués et la configuration a été modifiée à la volée, sans redémarrer le pod. Oui, l'application a remarqué des changements dans notre exemple simple - voir le message d'événement de fsnotify :
  
  

  2020/03/03 22:19:15 event: "configfiles/config.json": CHMOD
  2020/03/03 22:19:15 config: &{Hello Bob}
  2020/03/03 22:19:22 config: &{Hello Bob}

Prime! Solutions tierces

• jimmidyson / configmap-reload - Envoie une requête HTTP si le fichier a changé. Le développeur prévoit également d'enseigner à SIGHUP d'envoyer, mais le manque de validations à partir d'octobre 2019 laisse ces plans en question;
• stakater / Reloader - surveille ConfigMap / Secrets et effectue une mise à niveau progressive (comme son auteur l'appelle) sur les ressources qui leur sont associées.

Conclusion

PS

• « Fichiers locaux lors du portage d'une application vers Kubernetes »;
• « Kubernetes Helm: »;
• «SSL- Let's Encrypt cert-manager Kubernetes».