Kubernetes - How to define ConfigMap built using a file in a yaml?

54,835

Solution 1

Your config.json file should be inside your mychart/ directory, not inside mychart/templates

Chart Template Guide

configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  config.json: |-
{{ .Files.Get "config.json" | indent 4}}

config.json

{
    "val": "key"
}

helm install --dry-run --debug mychart

[debug] Created tunnel using local port: '52091'     
                                                     
[debug] SERVER: "127.0.0.1:52091"                    
                                                     
...           
                                                     
NAME:   dining-saola                                 
REVISION: 1                                          
RELEASED: Fri Nov 23 15:06:17 2018                   
CHART: mychart-0.1.0                                 
USER-SUPPLIED VALUES:                                
{}                                                   
                                                     
...
                                                     
---                                                  
# Source: mychart/templates/configmap.yaml           
apiVersion: v1                                       
kind: ConfigMap                                      
metadata:                                            
  name: dining-saola-configmap                       
data:                                                
  config.json: |-                                    
    {                                                
        "val": "key"                                 
    }     

EDIT:

But I want it the values in the config.json file to be taken from values.yaml. Is that possible?

configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  config.json: |-
    {
{{- range $key, $val := .Values.json }}
{{ $key | quote | indent 6}}: {{ $val | quote }}
{{- end}}
    }

values.yaml

json:
  key1: val1
  key2: val2
  key3: val3

helm install --dry-run --debug mychart

# Source: mychart/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mangy-hare-configmap
data:
  config.json: |-
    {
      "key1": "val1"
      "key2": "val2"
      "key3": "val3"
    }

Solution 2

Here is an example of a ConfigMap that is attached to a Deployment:

ConfigMap:

---
apiVersion: v1
kind: ConfigMap
metadata:
  name: jksconfig
data:
  config.json: |-
{{ .Files.Get "config.json" | indent 4 }}

Deployment:

---
apiVersion: apps/v1beta2
kind: Deployment
metadata:
  name: jksapp
  labels:
    app: jksapp
spec:
  selector:
    matchLabels:
      app: jksapp
  template:
    metadata:
      labels:
        app: jksapp
      containers:
        - name: jksapp
          image: jksapp:1.0.0
          ports:
            - containerPort: 8080
          volumeMounts:
            - name: config #The name(key) value must match pod volumes name(key) value 
              mountPath: /path/to/config.json
      volumes:
        - name: config
          configMap:
            name: jksconfig

Solution 3

Soln 01:

  • insert your config.json file content into a template
  • then use this template into your data against config.json
  • then run $ helm install command

finally,

{{define "config"}}
{
    "a": "A",
    "b": {
        "b1": 1
    }
}
{{end}}

apiVersion: v1
kind: ConfigMap
metadata:
  name: jksconfig
  labels:
    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
    app: "my-app"
    heritage: "{{ .Release.Service }}"
    release: "{{ .Release.Name }}"
data:
  config.json: {{ (include "config" .) | trim | quote }}
Share:
54,835
Chillax
Author by

Chillax

Updated on January 27, 2022

Comments

  • Chillax
    Chillax over 2 years

    At present I am creating a configmap from the file config.json by executing:

    kubectl create configmap jksconfig --from-file=config.json
    

    I would want the ConfigMap to be created as part of the deployment and tried to do this:

    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: jksconfig
    data:
      config.json: |-
        {{ .Files.Get "config.json" | indent 4 }}
    

    But doesn't seem to work. What should be going into configmap.yaml so that the same configmap is created?

    ---UPDATE---

    when I do a helm install dry run:

    # Source: mychartv2/templates/jks-configmap.yaml
    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: jksconfig
    data:
      config.json: |
    

    Note: I am using minikube as my kubernetes cluster

  • Chillax
    Chillax over 5 years
    I was able to use the ConfigMap in my deployment. All I want is to know how to get the values from a config.json file ( I am creating it manually now) Also if I pasted the file contents instead of {{ .Files.Get "config.json" | indent 4 }} - that works too
  • Urosh T.
    Urosh T. over 5 years
    You use as you would any file on a path. You paste your file content bellow the line config.json: |-.
  • Chillax
    Chillax over 5 years
    I was looking for a way to import the data from the file config.json rather than having to paste the contents in the yaml file
  • Chillax
    Chillax over 5 years
    This did work for one of my use cases. So marking as accepted answer. But I want it the values in the config.json file to be taken from values.yaml. Is that possible?
  • edbighead
    edbighead over 5 years
    Are you trying to get the values from values.yaml file inside your json configmap?
  • edbighead
    edbighead over 5 years
    If so, i've added one more example to my answer.
  • Daniel Lerps
    Daniel Lerps almost 3 years
    @edbighead The generated config.json is missing the separating , between the properties...
  • Anubhav Singh
    Anubhav Singh over 2 years
    @edbighead Can we replace config.json with config.yaml having nested maps? If yes how?
  • alo42
    alo42 over 2 years
    This is great. Only guy who really gets it. Thank you.