Merge pull request #31 from media-streaming-mesh/Logging_Params

Logging params
media-streaming-mesh · Jun 16, 2023 · a3715df · a3715df
2 parents a0f2eed + faac7ac
commit a3715df
Show file tree

Hide file tree

Showing 18 changed files with 178 additions and 109 deletions.
diff --git a/deployments/camera/Chart.yaml b/deployments/camera/Chart.yaml
@@ -1,4 +1,4 @@
 apiVersion: v2
 name: camera
 description: A Helm chart to deploy a camera on MSM
-version: 0.2.3
+version: 0.2.4
diff --git a/deployments/camera/README.md b/deployments/camera/README.md
@@ -1,6 +1,6 @@
 # camera
 
-![version: 0.2.3](https://img.shields.io/badge/version-0.2.3-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-camera-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/camera)
+![version: 0.2.4](https://img.shields.io/badge/version-0.2.4-informational?style=flat-square)    [![artifact hub](https://img.shields.io/badge/artifact%20hub-camera-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/camera)
 
 A Helm chart to deploy a camera on MSM
 
@@ -15,46 +15,46 @@ helm install --generate-name --wait msm/camera
 
 Before deploying the camera app on the node, ensure that you have the following prerequisites:
 
-- You will need to have access to a Kubernetes cluster<br>
-- [Helm](https://helm.sh) must be installed to use these charts<br>
+* You will need to have access to a Kubernetes cluster<br>
+* [Helm](https://helm.sh) must be installed to use these charts<br>
 
 ## Manual Install
 
-To get started, clone the msm-deployments repository and navigate to the `camera` directory.
+To get started, clone the msm-deployments repository and navigate to the ```camera``` directory.
 
 ```sh
 git clone https://github.com/media-streaming-mesh/msm-deployments.git
 cd msm-deployments/deployments/camera
 ```
 
-Before installing the camera app onto the node, make sure to change the value `kubernetesDistro` under `values.yaml` file as per your needs. <br>
+Before installing the camera  app onto the node, make sure to change the value ```kubernetesDistro``` under ```values.yaml``` file as per your needs. <br>
 e.g. <br>
-`kubernetesDistro: "K8S"`
+```kubernetesDistro: "K8S"```
 
-`helm install <YOUR_APP_NAME> ./ --values ./values.yaml`
+```helm install <YOUR_APP_NAME> ./ --values ./values.yaml```
 
 ## Usage
-
 Verify everything is in Running state on your Kubernetes Cluster
 
-`kubectl get pods -A`
+```kubectl get pods -A```
 
 or
 
-`kubectl get all`
+```kubectl get all```
 
 ## Values
 
-| Key              | Type   | Default                                        | Description |
-| ---------------- | ------ | ---------------------------------------------- | ----------- |
-| cpUrl            | string | `"http://msm-cp:9000"`                         |             |
-| rtspServer.name  | string | `"ciscolabs/rtsp-server"`                      |             |
-| rtspServer.tag   | string | `"latest"`                                     |             |
-| rtspClient.name  | string | `"ciscolabs/rtsp-client"`                      |             |
-| rtspClient.tag   | string | `"latest"`                                     |             |
-| stubImage.name   | string | `"ghcr.io/media-streaming-mesh/msm-rtsp-stub"` |             |
-| stubImage.tag    | string | `"latest"`                                     |             |
-| camera.rtspPort  | int    | `554`                                          |             |
-| camera.hlsPort   | int    | `8888`                                         |             |
-| config.appName   | string | `""`                                           |             |
-| config.cameraUrl | string | `""`                                           |             |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| cpUrl | string | `"http://msm-cp:9000"` |  |
+| rtspServer.name | string | `"ciscolabs/rtsp-server"` |  |
+| rtspServer.tag | string | `"latest"` |  |
+| rtspClient.name | string | `"ciscolabs/rtsp-client"` |  |
+| rtspClient.tag | string | `"latest"` |  |
+| stubImage.name | string | `"ghcr.io/media-streaming-mesh/msm-rtsp-stub"` |  |
+| stubImage.tag | string | `"latest"` |  |
+| camera.rtspPort | int | `554` |  |
+| camera.hlsPort | int | `8888` |  |
+| config.appName | string | `""` |  |
+| config.cameraUrl | string | `""` |  |
+| config.logLevel | string | `""` |  |
diff --git a/deployments/camera/gbear/appmetadata.yaml b/deployments/camera/gbear/appmetadata.yaml
@@ -34,3 +34,8 @@ configuration:
     value: Your Camera URL e.g rtsp://admin:password@CAMERA_IP:RTSP_PORT/CAMERA_STREAM_NAME
     key: config.cameraUrl
     type: String
+  - name: logLevel
+    title: Log Level
+    value: DEBUG
+    key: config.logLevel
+    type: String
diff --git a/deployments/camera/templates/deployment.yaml b/deployments/camera/templates/deployment.yaml
@@ -29,7 +29,7 @@ spec:
           imagePullPolicy: IfNotPresent
           env:
             - name: MSM_LOG_LVL
-              value: "DEBUG"
+              value: {{ .Values.config.logLevel }}
             - name: MSM_CONTROL_PLANE
               value: {{ .Values.cpUrl }}
             - name: MSM_NODE_NAME

diff --git a/deployments/camera/values.yaml b/deployments/camera/values.yaml
@@ -19,3 +19,4 @@ camera:
 config:
   appName: ""
   cameraUrl: ""
+  logLevel: ""
diff --git a/deployments/etcd/Chart.yaml b/deployments/etcd/Chart.yaml
@@ -2,4 +2,4 @@ apiVersion: v2
 name: etcd
 description: A Helm chart to deploy etcd for MSM
 type: application
-version: 0.0.4
+version: 0.0.5
diff --git a/deployments/etcd/README.md b/deployments/etcd/README.md
@@ -1,56 +1,51 @@
 # etcd
 
-![version: 0.0.3](https://img.shields.io/badge/version-0.0.3-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-etcd-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/etcd)
+![version: 0.0.5](https://img.shields.io/badge/version-0.0.5-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square)   [![artifact hub](https://img.shields.io/badge/artifact%20hub-etcd-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/etcd)
 
 A Helm chart to deploy etcd for MSM
 
-[//]: # (## TL;DR;)
+## TL;DR;
 
-[//]: # ()
-[//]: # (```bash)
-
-[//]: # (helm repo add msm https://charts.mediastreamingmesh.dev)
-
-[//]: # (helm install --generate-name --wait msm/etcd)
-
-[//]: # (```)
+```bash
+helm repo add msm https://charts.mediastreamingmesh.dev
+helm install --generate-name --wait msm/etcd
+```
 
 ## Prerequisites
 
 Before deploying the etcd app on the node, ensure that you have the following prerequisites:
 
-- You will need to have access to a Kubernetes cluster<br>
-- [Helm](https://helm.sh) must be installed to use these charts<br>
+* You will need to have access to a Kubernetes cluster<br>
+* [Helm](https://helm.sh) must be installed to use these charts<br>
 
 ## Manual Install
 
-To get started, clone the msm-deployments repository and navigate to the `etcd` directory.
+To get started, clone the msm-deployments repository and navigate to the ```etcd``` directory.
 
 ```sh
 git clone https://github.com/media-streaming-mesh/msm-deployments.git
 cd msm-deployments/deployments/etcd
 ```
 
-Before installing the etcd app onto the node, make sure to change the value `kubernetesDistro` under `values.yaml` file as per your needs. <br>
+Before installing the etcd  app onto the node, make sure to change the value ```kubernetesDistro``` under ```values.yaml``` file as per your needs. <br>
 e.g. <br>
-`kubernetesDistro: "K8S"`
+```kubernetesDistro: "K8S"```
 
-`helm install <YOUR_APP_NAME> ./ --values ./values.yaml`
+```helm install <YOUR_APP_NAME> ./ --values ./values.yaml```
 
 ## Usage
-
 Verify everything is in Running state on your Kubernetes Cluster
 
-`kubectl get pods -A`
+```kubectl get pods -A```
 
 or
 
-`kubectl get all`
+```kubectl get all```
 
 ## Values
 
-| Key              | Type   | Default                 | Description |
-| ---------------- | ------ | ----------------------- | ----------- |
-| kubernetesDistro | string | `"K3S"`                 |             |
-| etcdImage.name   | string | `"quay.io/coreos/etcd"` |             |
-| etcdImage.tag    | string | `"latest"`              |             |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| kubernetesDistro | string | `"K3S"` |  |
+| etcdImage.name | string | `"quay.io/coreos/etcd"` |  |
+| etcdImage.tag | string | `"latest"` |  |
diff --git a/deployments/ingress/Chart.yaml b/deployments/ingress/Chart.yaml
@@ -1,4 +1,4 @@
 apiVersion: v2
 name: ingress
 description: A Helm chart to deploy an ingress for MSM
-version: 0.1.7
+version: 0.1.8
diff --git a/deployments/ingress/README.md b/deployments/ingress/README.md
@@ -1,6 +1,6 @@
 # ingress
 
-![version: 0.1.7](https://img.shields.io/badge/version-0.1.7-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-ingress-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/ingress)
+![version: 0.1.8](https://img.shields.io/badge/version-0.1.8-informational?style=flat-square)    [![artifact hub](https://img.shields.io/badge/artifact%20hub-ingress-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/ingress)
 
 A Helm chart to deploy an ingress for MSM
 
@@ -15,39 +15,38 @@ helm install --generate-name --wait msm/ingress
 
 Before deploying the ingress app on the node, ensure that you have the following prerequisites:
 
-- You will need to have access to a Kubernetes cluster<br>
-- [Helm](https://helm.sh) must be installed to use these charts<br>
+* You will need to have access to a Kubernetes cluster<br>
+* [Helm](https://helm.sh) must be installed to use these charts<br>
 
 ## Manual Install
 
-To get started, clone the msm-deployments repository and navigate to the `ingress` directory.
+To get started, clone the msm-deployments repository and navigate to the ```ingress``` directory.
 
 ```sh
 git clone https://github.com/media-streaming-mesh/msm-deployments.git
 cd msm-deployments/deployments/ingress
 ```
 
-Before installing the ingress app onto the node, make sure to change the value `kubernetesDistro` under `values.yaml` file as per your needs. <br>
+Before installing the ingress  app onto the node, make sure to change the value ```kubernetesDistro``` under ```values.yaml``` file as per your needs. <br>
 e.g. <br>
-`kubernetesDistro: "K8S"`
+```kubernetesDistro: "K8S"```
 
-`helm install <YOUR_APP_NAME> ./ --values ./values.yaml`
+```helm install <YOUR_APP_NAME> ./ --values ./values.yaml```
 
 ## Usage
-
 Verify everything is in Running state on your Kubernetes Cluster
 
-`kubectl get pods -A`
+```kubectl get pods -A```
 
 or
 
-`kubectl get all`
+```kubectl get all```
 
 ## Values
 
-| Key                  | Type   | Default                                                                                                              | Description |
-| -------------------- | ------ | -------------------------------------------------------------------------------------------------------------------- | ----------- |
-| controllerImage.name | string | `"registry.k8s.io/ingress-nginx/controller"`                                                                         |             |
-| controllerImage.tag  | string | `"v1.7.0@sha256:7612338342a1e7b8090bef78f2a04fffcadd548ccaabe8a47bf7758ff549a5f7"`                                   |             |
-| certgenImage.name    | string | `"registry.k8s.io/ingress-nginx/kube-webhook-certgen"`                                                               |             |
-| certgenImage.tag     | string | `"v20230312-helm-chart-4.5.2-28-g66a760794@sha256:01d181618f270f2a96c04006f33b2699ad3ccb02da48d0f89b22abce084b292f"` |             |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| controllerImage.name | string | `"registry.k8s.io/ingress-nginx/controller"` |  |
+| controllerImage.tag | string | `"v1.7.0@sha256:7612338342a1e7b8090bef78f2a04fffcadd548ccaabe8a47bf7758ff549a5f7"` |  |
+| certgenImage.name | string | `"registry.k8s.io/ingress-nginx/kube-webhook-certgen"` |  |
+| certgenImage.tag | string | `"v20230312-helm-chart-4.5.2-28-g66a760794@sha256:01d181618f270f2a96c04006f33b2699ad3ccb02da48d0f89b22abce084b292f"` |  |
diff --git a/deployments/msm/Chart.yaml b/deployments/msm/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.15
+version: 0.1.16
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/deployments/msm/README.md b/deployments/msm/README.md
@@ -1,6 +1,6 @@
 # msm
 
-![version: 0.1.13](https://img.shields.io/badge/version-0.1.13-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![app version: 1.16.0](https://img.shields.io/badge/app%20version-1.16.0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-msm-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/msm)
+![version: 0.1.16](https://img.shields.io/badge/version-0.1.16-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![app version: 1.16.0](https://img.shields.io/badge/app%20version-1.16.0-informational?style=flat-square)  [![artifact hub](https://img.shields.io/badge/artifact%20hub-msm-informational?style=flat-square)](https://artifacthub.io/packages/helm/media-streaming-mesh/msm)
 
 A Helm chart for MSM Deployment
 
@@ -15,49 +15,52 @@ helm install --generate-name --wait msm/msm
 
 Before deploying the msm app on the node, ensure that you have the following prerequisites:
 
-- You will need to have access to a Kubernetes cluster<br>
-- [Helm](https://helm.sh) must be installed to use these charts<br>
+* You will need to have access to a Kubernetes cluster<br>
+* [Helm](https://helm.sh) must be installed to use these charts<br>
 
 ## Manual Install
 
-To get started, clone the msm-deployments repository and navigate to the `msm` directory.
+To get started, clone the msm-deployments repository and navigate to the ```msm``` directory.
 
 ```sh
 git clone https://github.com/media-streaming-mesh/msm-deployments.git
 cd msm-deployments/deployments/msm
 ```
 
-Before installing the msm app onto the node, make sure to change the value `kubernetesDistro` under `values.yaml` file as per your needs. <br>
+Before installing the msm  app onto the node, make sure to change the value ```kubernetesDistro``` under ```values.yaml``` file as per your needs. <br>
 e.g. <br>
-`kubernetesDistro: "K8S"`
+```kubernetesDistro: "K8S"```
 
-`helm install <YOUR_APP_NAME> ./ --values ./values.yaml`
+```helm install <YOUR_APP_NAME> ./ --values ./values.yaml```
 
 ## Usage
-
 Verify everything is in Running state on your Kubernetes Cluster
 
-`kubectl get pods -A`
+```kubectl get pods -A```
 
 or
 
-`kubectl get all`
+```kubectl get all```
 
 ## Values
 
-| Key                         | Type   | Default                                                | Description |
-| --------------------------- | ------ | ------------------------------------------------------ | ----------- |
-| kubernetesDistro            | string | `"K3S"`                                                |             |
-| cpUrl                       | string | `"http://msm-cp:9000"`                                 |             |
-| cniImage.name               | string | `"ghcr.io/media-streaming-mesh/msm-cni"`               |             |
-| cniImage.tag                | string | `"latest"`                                             |             |
-| proxyImage.name             | string | `"ghcr.io/media-streaming-mesh/msm-dp"`                |             |
-| proxyImage.tag              | string | `"latest"`                                             |             |
-| stubImage.name              | string | `"ghcr.io/media-streaming-mesh/msm-rtsp-stub"`         |             |
-| stubImage.tag               | string | `"latest"`                                             |             |
-| webhookImage.name           | string | `"ghcr.io/media-streaming-mesh/msm-admission-webhook"` |             |
-| webhookImage.tag            | string | `"latest"`                                             |             |
-| controlPlaneImage.name      | string | `"ghcr.io/media-streaming-mesh/msm-cp"`                |             |
-| controlPlaneImage.tag       | string | `"latest"`                                             |             |
-| networkControllerImage.name | string | `"ghcr.io/media-streaming-mesh/msm-nc"`                |             |
-| networkControllerImage.tag  | string | `"latest"`                                             |             |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| kubernetesDistro | string | `"K3S"` |  |
+| cpUrl | string | `"http://msm-cp:9000"` |  |
+| cniImage.name | string | `"ghcr.io/media-streaming-mesh/msm-cni"` |  |
+| cniImage.tag | string | `"latest"` |  |
+| proxyImage.name | string | `"ghcr.io/media-streaming-mesh/msm-dp"` |  |
+| proxyImage.tag | string | `"latest"` |  |
+| stubImage.name | string | `"ghcr.io/media-streaming-mesh/msm-rtsp-stub"` |  |
+| stubImage.tag | string | `"latest"` |  |
+| webhookImage.name | string | `"ghcr.io/media-streaming-mesh/msm-admission-webhook"` |  |
+| webhookImage.tag | string | `"latest"` |  |
+| controlPlaneImage.name | string | `"ghcr.io/media-streaming-mesh/msm-cp"` |  |
+| controlPlaneImage.tag | string | `"latest"` |  |
+| networkControllerImage.name | string | `"ghcr.io/media-streaming-mesh/msm-nc"` |  |
+| networkControllerImage.tag | string | `"latest"` |  |
+| config.rtpPort | int | `8050` |  |
+| config.gRPCPort | int | `9000` |  |
+| config.logLevel | string | `""` |  |
+| config.logFormat | string | `""` |  |
diff --git a/deployments/msm/gbear/appmetadata.yaml b/deployments/msm/gbear/appmetadata.yaml
@@ -66,3 +66,15 @@ icon: https://www.mediastreamingmesh.io/assets/shared/logos/logo-dark-horizontal
 #    key: config.gRPCPort
 #    type: NodePort
 #    description: Please enter the gRPC Port. Leaving it blank will set it on a Default Port 9000
+
+configuration:
+  - name: logLevel
+    title: Log Level
+    value: DEBUG
+    key: config.logLevel
+    type: String
+  - name: logFormat
+    title: Log Format
+    value: JSON
+    key: config.logFormat
+    type: String