Add file-based configurations to services (onosproject#51)

* Add support for values-based configuration of services * Ensure configuration files generated in configmaps are parseable * Generalize values file formats for services to hide implementation details and simplify configuration * Default consensus database name to empty string * Fix incorrect key in service configurations
woojoong88 · Mar 23, 2020 · 5cc88e8 · 5cc88e8
1 parent 1129c56
commit 5cc88e8
Show file tree

Hide file tree

Showing 15 changed files with 172 additions and 82 deletions.
diff --git a/onos-config/templates/configmap.yaml b/onos-config/templates/configmap.yaml
@@ -9,4 +9,17 @@ metadata:
     heritage: "{{ .Release.Service }}"
 data:
   onos.yaml: |-
-{{ toYaml .Values.config | indent 4 }}
+    atomix:
+      controller: {{ .Values.store.controller }}
+      namespace: {{ .Release.Namespace }}
+      scope: {{ template "onos-config.fullname" . }}
+      databases:
+        {{- if .Values.store.consensus.database }}
+        consensus: {{ .Values.store.database }}
+        {{- else }}
+        consensus: {{ template "onos-config.fullname" . }}-consensus
+        {{- end }}
+{{- if .Values.logging }}
+    logging:
+{{ toYaml .Values.logging | indent 6 }}
+{{- end}}
diff --git a/onos-config/templates/consensus.yaml b/onos-config/templates/consensus.yaml
@@ -0,0 +1,23 @@
+{{- if .Values.store.consensus.enabled }}
+apiVersion: cloud.atomix.io/v1beta1
+kind: Database
+metadata:
+  {{- if .Values.store.database }}
+  name: {{ .Values.store.database }}
+  {{- else }}
+  name: {{ template "onos-config.fullname" . }}-consensus
+  {{- end }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
+    release: "{{ .Release.Name }}"
+    heritage: "{{ .Release.Service }}"
+spec:
+  clusters: {{ .Values.store.consensus.clusters }}
+  template:
+    spec:
+      partitions: {{ .Values.store.consensus.partitions }}
+      backend:
+        image: {{ .Values.store.consensus.backend.image }}
+        replicas: {{ .Values.store.consensus.backend.replicas }}
+{{- end }}
diff --git a/onos-config/templates/database.yaml b/onos-config/templates/database.yaml
diff --git a/onos-config/templates/deployment.yaml b/onos-config/templates/deployment.yaml
@@ -39,6 +39,8 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           env:
+            # *_NAMESPACE and *_NAME environment variables are recognized by onos-lib-go utilities.
+            # These variables should always be defined.
             - name: POD_NAMESPACE
               valueFrom:
                 fieldRef:
@@ -47,16 +49,28 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.name
+            - name: SERVICE_NAMESPACE
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.namespace
+            - name: SERVICE_NAME
+              value: {{ template "onos-config.fullname" . }}
             - name: NODE_NAME
               valueFrom:
                 fieldRef:
                   fieldPath: spec.nodeName
+            # Note: Atomix environment variables remain for backwards compatibility.
+            # TODO: Remove Atomix environment variables once images have be updated to use new configuration file format
             - name: ATOMIX_CONTROLLER
               value: {{ .Values.store.controller | quote }}
             - name: ATOMIX_APP
               value: {{ include "onos-config.fullname" . }}
             - name: ATOMIX_RAFT
-              value: {{ .Values.store.raftgroup }}
+              {{- if .Values.store.consensus.database }}
+              value: {{ .Values.store.consensus.database }}
+              {{- else }}
+              value: {{ template "onos-config.fullname" . }}-consensus
+              {{- end }}
             - name: ATOMIX_NAMESPACE
               value: {{ .Release.Namespace }}
           args:

diff --git a/onos-config/values.yaml b/onos-config/values.yaml
@@ -34,10 +34,10 @@ plugins:
 # topoEndpoint: onos-topo-classic:5150
 
 store:
-  enabled: true
-  raftgroup: onos-config-raft
-  controller: atomix-controller.kube-system.svc.cluster.local:5679
-  raft:
+  controller: "atomix-controller.kube-system.svc.cluster.local:5679"
+  consensus:
+    enabled: true
+    database: ""
     partitions: 1
     clusters: 1
     backend:

diff --git a/onos-ric/templates/configmap.yaml b/onos-ric/templates/configmap.yaml
@@ -9,4 +9,17 @@ metadata:
     heritage: "{{ .Release.Service }}"
 data:
   onos.yaml: |-
-{{ toYaml .Values.config | indent 4 }}
+    atomix:
+      controller: {{ .Values.store.controller }}
+      namespace: {{ .Release.Namespace }}
+      scope: {{ template "onos-ric.fullname" . }}
+      databases:
+        {{- if .Values.store.consensus.database }}
+        consensus: {{ .Values.store.database }}
+        {{- else }}
+        consensus: {{ template "onos-ric.fullname" . }}-consensus
+        {{- end }}
+{{- if .Values.logging }}
+    logging:
+{{ toYaml .Values.logging | indent 6 }}
+{{- end}}
diff --git a/onos-ric/templates/consensus.yaml b/onos-ric/templates/consensus.yaml
@@ -0,0 +1,23 @@
+{{- if .Values.store.consensus.enabled }}
+apiVersion: cloud.atomix.io/v1beta1
+kind: Database
+metadata:
+  {{- if .Values.store.database }}
+  name: {{ .Values.store.database }}
+  {{- else }}
+  name: {{ template "onos-ric.fullname" . }}-consensus
+  {{- end }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
+    release: "{{ .Release.Name }}"
+    heritage: "{{ .Release.Service }}"
+spec:
+  clusters: {{ .Values.store.consensus.clusters }}
+  template:
+    spec:
+      partitions: {{ .Values.store.consensus.partitions }}
+      backend:
+        image: {{ .Values.store.consensus.backend.image }}
+        replicas: {{ .Values.store.consensus.backend.replicas }}
+{{- end }}
diff --git a/onos-ric/templates/database.yaml b/onos-ric/templates/database.yaml
diff --git a/onos-ric/templates/deployment.yaml b/onos-ric/templates/deployment.yaml
@@ -59,6 +59,8 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           env:
+            # *_NAMESPACE and *_NAME environment variables are recognized by onos-lib-go utilities.
+            # These variables should always be defined.
             - name: POD_NAMESPACE
               valueFrom:
                 fieldRef:
@@ -67,16 +69,28 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.name
+            - name: SERVICE_NAMESPACE
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.namespace
+            - name: SERVICE_NAME
+              value: {{ template "onos-ric.fullname" . }}
             - name: NODE_NAME
               valueFrom:
                 fieldRef:
                   fieldPath: spec.nodeName
+            # Note: Atomix environment variables remain for backwards compatibility.
+            # TODO: Remove Atomix environment variables once images have be updated to use new configuration file format
             - name: ATOMIX_CONTROLLER
               value: {{ .Values.store.controller | quote }}
             - name: ATOMIX_APP
               value: {{ include "onos-ric.fullname" . }}
             - name: ATOMIX_RAFT
-              value: {{ .Values.store.raftgroup }}
+              {{- if .Values.store.consensus.database }}
+              value: {{ .Values.store.consensus.database }}
+              {{- else }}
+              value: {{ template "onos-ric.fullname" . }}-consensus
+              {{- end }}
             - name: ATOMIX_NAMESPACE
               value: {{ .Release.Namespace }}
           args:

diff --git a/onos-ric/values.yaml b/onos-ric/values.yaml
@@ -18,10 +18,10 @@ fullnameOverride: "onos-ric"
 debug: false
 
 store:
-  enabled: true
-  raftgroup: onos-ric-raft
-  controller: atomix-controller.kube-system.svc.cluster.local:5679
-  raft:
+  controller: "atomix-controller.kube-system.svc.cluster.local:5679"
+  consensus:
+    enabled: true
+    database: ""
     partitions: 1
     clusters: 1
     backend:
@@ -49,4 +49,4 @@ tolerations: []
 
 affinity: {}
 
-config: {}
+logging: {}
diff --git a/onos-topo/templates/configmap.yaml b/onos-topo/templates/configmap.yaml
@@ -9,4 +9,17 @@ metadata:
     heritage: "{{ .Release.Service }}"
 data:
   onos.yaml: |-
-{{ toYaml .Values.config | indent 4 }}
+    atomix:
+      controller: {{ .Values.store.controller }}
+      namespace: {{ .Release.Namespace }}
+      scope: {{ template "onos-topo.fullname" . }}
+      databases:
+        {{- if .Values.store.consensus.database }}
+        consensus: {{ .Values.store.database }}
+        {{- else }}
+        consensus: {{ template "onos-topo.fullname" . }}-consensus
+        {{- end }}
+{{- if .Values.logging }}
+    logging:
+{{ toYaml .Values.logging | indent 6 }}
+{{- end}}
diff --git a/onos-topo/templates/consensus.yaml b/onos-topo/templates/consensus.yaml
@@ -0,0 +1,23 @@
+{{- if .Values.store.consensus.enabled }}
+apiVersion: cloud.atomix.io/v1beta1
+kind: Database
+metadata:
+  {{- if .Values.store.database }}
+  name: {{ .Values.store.database }}
+  {{- else }}
+  name: {{ template "onos-topo.fullname" . }}-consensus
+  {{- end }}
+  namespace: {{ .Release.Namespace }}
+  labels:
+    chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
+    release: "{{ .Release.Name }}"
+    heritage: "{{ .Release.Service }}"
+spec:
+  clusters: {{ .Values.store.consensus.clusters }}
+  template:
+    spec:
+      partitions: {{ .Values.store.consensus.partitions }}
+      backend:
+        image: {{ .Values.store.consensus.backend.image }}
+        replicas: {{ .Values.store.consensus.backend.replicas }}
+{{- end }}
diff --git a/onos-topo/templates/database.yaml b/onos-topo/templates/database.yaml
diff --git a/onos-topo/templates/deployment.yaml b/onos-topo/templates/deployment.yaml
@@ -36,6 +36,8 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           env:
+            # *_NAMESPACE and *_NAME environment variables are recognized by onos-lib-go utilities.
+            # These variables should always be defined.
             - name: POD_NAMESPACE
               valueFrom:
                 fieldRef:
@@ -44,18 +46,30 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.name
+            - name: SERVICE_NAMESPACE
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.namespace
+            - name: SERVICE_NAME
+              value: {{ template "onos-topo.fullname" . }}
             - name: NODE_NAME
               valueFrom:
                 fieldRef:
                   fieldPath: spec.nodeName
+            # Note: Atomix environment variables remain for backwards compatibility.
+            # TODO: Remove Atomix environment variables once images have be updated to use new configuration file format
             - name: ATOMIX_CONTROLLER
               value: {{ .Values.store.controller | quote }}
+            - name: ATOMIX_NAMESPACE
+              value: {{ .Release.Namespace }}
             - name: ATOMIX_APP
               value: {{ include "onos-topo.fullname" . }}
             - name: ATOMIX_RAFT
-              value: {{ .Values.store.raftgroup }}
-            - name: ATOMIX_NAMESPACE
-              value: {{ .Release.Namespace }}
+              {{- if .Values.store.consensus.database }}
+              value: {{ .Values.store.consensus.database }}
+              {{- else }}
+              value: {{ template "onos-topo.fullname" . }}-consensus
+              {{- end }}
           args:
             - "-caPath=/etc/onos/certs/tls.cacrt"
             - "-keyPath=/etc/onos/certs/tls.key"

diff --git a/onos-topo/values.yaml b/onos-topo/values.yaml
@@ -17,10 +17,10 @@ fullnameOverride: "onos-topo"
 debug: false
 
 store:
-  enabled: true
-  raftgroup: onos-topo-raft
-  controller: atomix-controller.kube-system.svc.cluster.local:5679
-  raft:
+  controller: "atomix-controller.kube-system.svc.cluster.local:5679"
+  consensus:
+    enabled: true
+    database: ""
     partitions: 1
     clusters: 1
     backend:
@@ -41,4 +41,4 @@ tolerations: []
 
 affinity: {}
 
-config: {}
+logging: {}