VOL-2341 Chart for voltha-kafka-dump tool
Change-Id: I558b92fd70d4f2a3a7dc8d5d1f37bbcfd6fb43c5
diff --git a/tools/xossh/Chart.yaml b/tools/xossh/Chart.yaml
new file mode 100644
index 0000000..0a5cd70
--- /dev/null
+++ b/tools/xossh/Chart.yaml
@@ -0,0 +1,22 @@
+---
+# Copyright 2018-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: xossh
+description: A Helm chart for xossh, the XOS command line shell
+icon: https://guide.opencord.org/logos/xos.svg
+version: 3.0.1
+
+# Runs the xosproject/xos-client container
+appVersion: 3.2.3
diff --git a/tools/xossh/README.md b/tools/xossh/README.md
new file mode 100644
index 0000000..e36e1ab
--- /dev/null
+++ b/tools/xossh/README.md
@@ -0,0 +1,15 @@
+To use xossh, execute the following from your `helm-charts` directory:
+
+```
+# start the xossh container
+helm install tools/xossh -n xossh
+
+# wait a few seconds for the container to start, then run the following
+tools/xossh/xossh-attach.sh
+```
+
+To deploy a development version of `xossh` tagged with the `candidate` tag, you can do:
+
+```
+helm install tools/xossh/ -n xossh -f examples/xossh-candidate.yaml
+```
diff --git a/tools/xossh/templates/_helpers.tpl b/tools/xossh/templates/_helpers.tpl
new file mode 100644
index 0000000..524d996
--- /dev/null
+++ b/tools/xossh/templates/_helpers.tpl
@@ -0,0 +1,47 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Copyright 2018-present Open Networking Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "xossh.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "xossh.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "xossh.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
diff --git a/tools/xossh/templates/configmap.yaml b/tools/xossh/templates/configmap.yaml
new file mode 100644
index 0000000..2d98f49
--- /dev/null
+++ b/tools/xossh/templates/configmap.yaml
@@ -0,0 +1,23 @@
+---
+
+# Copyright 2018-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+ name: xossh
+data:
+ xosshConfig: |
+{{ toYaml .Values.xosshConfig | indent 4 }}
diff --git a/tools/xossh/templates/deployment.yaml b/tools/xossh/templates/deployment.yaml
new file mode 100644
index 0000000..e39375d
--- /dev/null
+++ b/tools/xossh/templates/deployment.yaml
@@ -0,0 +1,85 @@
+---
+
+# Copyright 2018-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apps/v1beta2
+kind: Deployment
+metadata:
+ name: {{ template "xossh.fullname" . }}
+ labels:
+ app: {{ template "xossh.name" . }}
+ chart: {{ template "xossh.chart" . }}
+ release: {{ .Release.Name }}
+ heritage: {{ .Release.Service }}
+spec:
+ replicas: {{ .Values.replicaCount }}
+ selector:
+ matchLabels:
+ app: {{ template "xossh.name" . }}
+ release: {{ .Release.Name }}
+ template:
+ metadata:
+ labels:
+ app: {{ template "xossh.name" . }}
+ release: {{ .Release.Name }}
+ spec:
+ containers:
+ - name: {{ .Chart.Name }}
+ args:
+ - "/usr/bin/xossh"
+ - "-u"
+ - "{{ .Values.xosshConfig.accessor.username }}"
+ - "-p"
+ - "{{ .Values.xosshConfig.accessor.password }}"
+ - "-S"
+ - "{{ .Values.xosshConfig.accessor.endpoint }}"
+ stdin: true
+ tty: true
+ image: {{ .Values.global.registry }}{{ .Values.image.repository }}:{{ tpl .Values.image.tag . }}
+ imagePullPolicy: {{ .Values.image.pullPolicy }}
+ resources:
+{{ toYaml .Values.resources | indent 12 }}
+ volumeMounts:
+ - name: certchain-volume
+ mountPath: /usr/local/share/ca-certificates/local_certs.crt
+ subPath: config/ca_cert_chain.pem
+ - name: xossh-config
+ mountPath: /opt/xos/config.yml
+ subPath: config.yml
+ volumes:
+ - name: certchain-volume
+ configMap:
+ name: ca-certificates
+ items:
+ - key: chain
+ path: config/ca_cert_chain.pem
+ - name: xossh-config
+ configMap:
+ name: xossh
+ items:
+ - key: xosshConfig
+ path: config.yml
+ {{- with .Values.nodeSelector }}
+ nodeSelector:
+{{ toYaml . | indent 8 }}
+ {{- end }}
+ {{- with .Values.affinity }}
+ affinity:
+{{ toYaml . | indent 8 }}
+ {{- end }}
+ {{- with .Values.tolerations }}
+ tolerations:
+{{ toYaml . | indent 8 }}
+ {{- end }}
diff --git a/tools/xossh/values.yaml b/tools/xossh/values.yaml
new file mode 100644
index 0000000..aeccd83
--- /dev/null
+++ b/tools/xossh/values.yaml
@@ -0,0 +1,62 @@
+---
+# Copyright 2018-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Default values for xossh
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+nameOverride: ""
+fullnameOverride: ""
+
+image:
+ repository: 'xosproject/xos-client'
+ tag: '{{ .Chart.AppVersion }}'
+ pullPolicy: 'Always'
+
+global:
+ registry: ''
+
+resources: {}
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
+
+xosshConfig:
+ name: xossh
+ accessor:
+ username: admin@opencord.org
+ password: letmein
+ endpoint: xos-core:50051
+ logging:
+ version: 1
+ handlers:
+ console:
+ class: logging.StreamHandler
+ file:
+ class: logging.handlers.RotatingFileHandler
+ filename: /var/log/xos.log
+ maxBytes: 10485760
+ backupCount: 5
+ loggers:
+ '':
+ handlers:
+ - console
+ - file
+ level: DEBUG
diff --git a/tools/xossh/xossh-attach.sh b/tools/xossh/xossh-attach.sh
new file mode 100755
index 0000000..aeb93f0
--- /dev/null
+++ b/tools/xossh/xossh-attach.sh
@@ -0,0 +1,18 @@
+#! /bin/bash
+
+# Copyright 2018-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+XOSSH_POD=`kubectl get pods | grep -i xossh | cut -f 1 -d " "`
+kubectl attach $XOSSH_POD -i -c xossh