Chg: release candidate version fix for helm

[WIFI-2592] Add: Helm README

.github/workflows/ci.yml

@@ -6,6 +6,9 @@ on:
       - '**.md'
     branches:
       - main
+      - 'release/*'
+    tags:
+      - 'v*'
   pull_request:
     branches:
       - main
@@ -26,28 +29,40 @@ jobs:
     - name: Build Docker image
       run: docker build -t wlan-cloud-ucentralgw-ui:${{ github.sha }} .
 
+    - name: Tag Docker image
+      run: |
+        TAGS="${{ github.sha }}"
+
+        if [[ ${GITHUB_REF} == "refs/heads/"* ]]
+        then
+          CURRENT_TAG=$(echo ${GITHUB_REF#refs/heads/} | tr '/' '-')
+          TAGS="$TAGS $CURRENT_TAG"
+        else
+          if [[ ${GITHUB_REF} == "refs/tags/"* ]]
+          then
+            CURRENT_TAG=$(echo ${GITHUB_REF#refs/tags/} | tr '/' '-')
+            TAGS="$TAGS $CURRENT_TAG"
+          else # PR build
+            CURRENT_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
+            TAGS="$TAGS $CURRENT_TAG"
+          fi
+        fi
+
+        echo "Result tags: $TAGS"
+
+        for tag in $TAGS; do
+          docker tag wlan-cloud-ucentralgw-ui:${{ github.sha }} ${{ env.DOCKER_REGISTRY_URL }}/ucentralgw-ui:$tag
+        done
+
     - name: Log into Docker registry
+      if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
       uses: docker/login-action@v1
       with:
         registry: ${{ env.DOCKER_REGISTRY_URL }}
         username: ${{ env.DOCKER_REGISTRY_USERNAME }}
         password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
 
-    - name: Push Docker image
+    - name: Push Docker images
+      if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
       run: |
-        TAGS="${{ github.sha }}"
-
-        if [ ${GITHUB_REF} == "refs/heads/main" ]
-        then
-          TAGS="$TAGS ${GITHUB_REF#refs/heads/}"
-        else # PR build
-          CURRENT_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
-          TAGS="$TAGS $CURRENT_TAG"
-        fi
-
-        echo "Pushing tags $TAGS"
-
-        for tag in $TAGS; do
-          docker tag wlan-cloud-ucentralgw-ui:${{ github.sha }} ${{ env.DOCKER_REGISTRY_URL }}/ucentralgw-ui:$tag
-          docker push ${{ env.DOCKER_REGISTRY_URL }}/ucentralgw-ui:$tag
-        done
+        docker images | grep ${{ env.DOCKER_REGISTRY_URL }}/ucentralgw-ui | awk -F ' ' '{print $1":"$2}' | xargs -I {} docker push {}

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine3.11 AS build
+FROM node:14-alpine3.11 AS build
 
 COPY package.json package-lock.json /
 

README.md

@@ -9,18 +9,29 @@ NOTE: This UI will be evolving as micro services are added to the uCentral progr
 ## Running the solution
 
 ### Development
-Here are the instructions to run the solution on your machine for development purposes. You need to run these in the root folder of the project and also have npm installed on your machine. Please install `npm` for the platform you are using.
+You need to run these commands in the root folder of the project and also have npm installed on your machine.
 ```
 git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
 cd wlan-cloud-ucentralgw-ui
 npm install
 npm start
 ```
+
+Run these commands if you want to run the solution on your machine while also doing development on the [uCentral UI Library](https://github.com/Telecominfraproject/wlan-cloud-ucentral-ui-libs).
+```
+git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
+git clone https://github.com/Telecominfraproject/wlan-cloud-ucentral-ui-libs
+cd wlan-cloud-ucentralgw-ui
+npm link ../wlan-cloud-ucentral-ui-libs // Add sudo at the start of this command if it fails because of permissions
+npm start
+```
+
 ### Production
-Here are the instructions to build the production veresion of the application. You need to run this in the root folder of the project and also have npm installed on your machine.
+You need to run this in the root folder of the project and also have npm installed on your machine.
 ```
 git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
 cd wlan-cloud-ucentralgw-ui
+npm install
 npm run build
 ```
 Once the build is done, you can move the `build` folder on your server.

helm/README.md

@@ -1,6 +1,7 @@
 # ucentralgwui
 
-> Application description placeholder
+This Helm chart helps to deploy uCentralGW-UI to the Kubernetes clusters. It is mainly used in [assembly chart](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart) as uCentralGW-UI requires other services as dependencies that are considered in that Helm chart. This chart is purposed to define deployment logic close to the application code itself and define default values that could be overriden during deployment.
+
 
 ## TL;DR;
 
@@ -14,10 +15,12 @@ This chart bootstraps an ucentralgwui on a [Kubernetes](http://kubernetes.io) cl
 
 ## Installing the Chart
 
+Currently this chart is not assembled in charts archives, so [helm-git](https://github.com/aslafy-z/helm-git) is required for remote the installation
+
 To install the chart with the release name `my-release`:
 
 ```bash
-$ helm install --name my-release stable/ipfs
+$ helm install --name my-release git+https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui@helm?ref=main
 ```
 
 The command deploys ucentralgwui on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
@@ -29,18 +32,36 @@ The command deploys ucentralgwui on the Kubernetes cluster in the default config
 To uninstall/delete the `my-release` deployment:
 
 ```bash
-$ helm delete --purge my-release
+$ helm delete my-release
 ```
 
 The command removes all the Kubernetes components associated with the chart and deletes the release.
 
 ## Configuration
 
-The following table lists the configurable parameters of the Memcached chart and their default values.
+The following table lists the configurable parameters of the chart and their default values. If Default value is not listed in the table, please refer to the [Values](values.yaml) files for details.
+
+| Parameter | Type | Description | Default |
+|-----------|------|-------------|---------|
+| replicaCount | number | Amount of replicas to be deployed | `1` |
+| nameOverride | string | Override to be used for application deployment |  |
+| fullnameOverride | string | Override to be used for application deployment (has priority over nameOverride) |  |
+| images.ucentralgwui.repository | string | Docker image repository |  |
+| images.ucentralgwui.tag | string | Docker image tag | `'master'` |
+| images.ucentralgwui.pullPolicy | string | Docker image pull policy | `'Always'` |
+| services.ucentralgwui.type | string | uCentralGW-UI service type | `'ClusterIP'` |
+| services.ucentralgwui.ports.http.servicePort | number | Websocket endpoint port to be exposed on service | `80` |
+| services.ucentralgwui.ports.http.targetPort | number | Websocket endpoint port to be targeted by service | `80` |
+| services.ucentralgwui.ports.http.protocol | string | Websocket endpoint protocol | `'TCP'` |
+| checks.ucentralgwui.liveness.httpGet.path | string | Liveness check path to be used | `'/'` |
+| checks.ucentralgwui.liveness.httpGet.port | number | Liveness check port to be used (should be pointint to ALB endpoint) | `http` |
+| checks.ucentralgwui.readiness.httpGet.path | string | Readiness check path to be used | `'/'` |
+| checks.ucentralgwui.readiness.httpGet.port | number | Readiness check port to be used | `http` |
+| ingresses.default.enabled | boolean | Defines if uCentralGW-UI should be exposed via Ingress controller | `False` |
+| ingresses.default.hosts | array | List of hosts for exposed uCentralGW-UI |  |
+| ingresses.default.paths | array | List of paths to be exposed for uCentralGW-UI |  |
+| public_env_variables | hash | Defines list of environment variables to be passed to uCentralGW-UI (required for application configuration) | |
 
-| Parameter | Description | Default |
-|-----------|-------------|---------|
-|||
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 
@@ -59,4 +80,3 @@ $ helm install --name my-release -f values.yaml .
 ```
 
 > **Tip**: You can use the default [values.yaml](values.yaml) as a base for customization.
-

helm/templates/deployment.yaml

@@ -35,6 +35,8 @@ spec:
           imagePullPolicy: {{ .Values.images.ucentralgwui.pullPolicy }}
 
           env:
+            - name: KUBERNETES_DEPLOYED
+              value: "{{ now }}"
           {{- range $key, $value := .Values.public_env_variables }}
             - name: {{ $key }}
               value: {{ $value | quote }}

helm/values.yaml

@@ -7,7 +7,7 @@ fullnameOverride: ""
 images:
   ucentralgwui:
     repository: tip-tip-wlan-cloud-ucentral.jfrog.io/ucentralgw-ui
-    tag: main
+    tag: v2.0.0-RC1
     pullPolicy: Always
 
 services: