Add workflow for check spelling

.github/workflows/codespell.yaml

@@ -0,0 +1,17 @@
+name: Codespell
+
+on: pull_request
+
+jobs:
+  codespell:
+    name: Codespell
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Codespell
+        uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_list: test
+          check_filenames: true
+          check_hidden: false

README.md

@@ -39,7 +39,7 @@ You can deploy the FM either locally with all services running on a single node,
 * [TLS in Frinx Machine](#tls-in-frinx-machine) 
 </br></br>
 ## Installation
-Run the install script, this will check and download the neccessary prerequisities.
+Run the install script, this will check and download the necessary prerequisites.
 
 ```sh
 $ ./install.sh                   # pull images, set secrets, skip the installation of dependencies
@@ -81,7 +81,7 @@ map_count should be around 1 per 128 KB of system memory. For example: vm.max_ma
 #Temporary configuration:
 sysctl -w vm.max_map_count=262144
 
-#Permament configuration:
+#Permanent configuration:
 echo "vm.max_map_count=262144" >> /etc/sysctl.conf
 sysctl -p
 
@@ -93,7 +93,7 @@ cat /proc/sys/vm/max_map_count
 
 ### Enable Azure AD authorization
 
-Frinx Machine supports authentification and authorization via Azure AD.
+Frinx Machine supports authentication and authorization via Azure AD.
 For details about configuration visit [Azure AD configuration](docs/azure_ad.md).
 
 For configuration use `azure_ad.sh` script.
@@ -241,7 +241,7 @@ $ docker node ls
 ### Generate configuration files for multi-node deployment
 
 Frinx Machine supports Uniconfig deployment in multi-zone mode (multiple uniconfig zones).
-Before the Frinx Machine is start, is necessary to generate unique configuration files per each zone separatelly.
+Before the Frinx Machine is start, is necessary to generate unique configuration files per each zone separately.
 For generating these files use `generate_uc_compose.sh`.  
 
 You need to define:
@@ -255,9 +255,9 @@ You need to define:
     *   node role : manager/worker1/worker2 ...
     *   node label : node with label zone=<NODE_LABEL> 
 
-Script is checking input placement values based on Readiness status. Files are not generated bu default, when
+Script is checking input placement values based on Readiness status. Files are not generated by default, when
 nodes are not ready. This generation of composefiles can be forced with flag --force. 
-Default folder path is `./composefiles/uniconfig`, but can be differend (outside from FM repo folder).
+Default folder path is `./composefiles/uniconfig`, but can be different (outside from FM repo folder).
 
 ```sh
 # Check all nodes in cluster (from manager node)
@@ -291,7 +291,7 @@ docker node update <NODE_HOSTNAME> --label-add db=<UNIQUE_ZONE_LABEL>
 $ ./generate_uc_compose.sh -s <service_name> -f <path_to_folder> -i <instances> --role <Role> --force
 ```
 
-For enhanced FM architecture deployment is recomended to use label base placement, where nodes are splited to zone groups by node label zone=<UNIQUE_ZONE_LABEL>. In each group must be only one node with label db=<UNIQUE_ZONE_LABEL>. 
+For enhanced FM architecture deployment is recommended to use label base placement, where nodes are splited to zone groups by node label zone=<UNIQUE_ZONE_LABEL>. In each group must be only one node with label db=<UNIQUE_ZONE_LABEL>. 
 
 To see diagram visit [Frinx Machine Architecture](docs/fm_architecture.md).
 
@@ -308,7 +308,7 @@ mkdir -p /opt/frinx/<SERVICE_NAME>/uniconfig-controller/cache/
 # set correct permissions
 chmod -R 777 /opt/frinx/<SERVICE_NAME>/uniconfig-controller/cache/
 
-# if older FM was started on this node, remove docker persistant volumes
+# if older FM was started on this node, remove docker persistent volumes
 docker volume prune --filter label=fm
 ```
 </br>
@@ -320,7 +320,7 @@ docker volume prune --filter label=fm
 $ ./startup.sh --multinode 
 # For different composefiles path
 $ ./startup.sh --multinode 'path/to/your/folder'
-# Can be aslo combined with another options 
+# Can be also combined with another options 
 $ ./startup.sh --multinode 'path/to/your/folder' --uniconfig --dev
 $ ./startup.sh --multinode 'path/to/your/folder' --workflow-manager --dev
 ```
@@ -417,7 +417,7 @@ curl -XPUT -H "Content-Type: application/json" http://localhost:9200/_all/_setti
 </br>
 
 ### List of deployed uniconfig services
-KrakenD provice API, which return list of deployed uniconfig services:
+KrakenD provide API, which return list of deployed uniconfig services:
 
 ```sh
 $ curl -X GET 127.0.0.1/static/list/uniconfig

azure_ad.sh

@@ -35,7 +35,7 @@ Azure AD environment configuration
                             - e.g. 79A4Q~RL5pELYji-KU58UfSeGoRVGco8f20~K
 
       -r|--redirect_url    Single-page application redirect URI
-                            - IP which is accesed
+                            - IP which is accessed
                             - e.g. localhost, 10.15.0.7, yourdomain.com
 
       -k|--keep_config     Save configuration file to ${authSecretsTmpFile}
@@ -200,7 +200,7 @@ function configure {
             set -x;;
 
         *) 
-            echo -e "${ERROR} Unknow option: ${1}. See help!"
+            echo -e "${ERROR} Unknown option: ${1}. See help!"
             exit 1;;
     esac
     shift

build/README

@@ -1,6 +1,6 @@
 This folder is empty by default.
 
-To download modules, use pullmodules.sh in root directory and modify/build them as neccessary.
+To download modules, use pullmodules.sh in root directory and modify/build them as necessary.
 All files in the folder except for this README are ignored by git as specified in .gitignore.
 
 NOTE: uniconfig-ui and uniconfig modules are not pulled as they are stored on Frinx private gerrit repository.

collectlogs.sh

@@ -8,7 +8,7 @@ function example {
 
 function usage {
   echo -e "usage: $scriptName [OPTIONS]\n"
-  echo -e "Collect and archive all logs neccessary for troubleshooting."
+  echo -e "Collect and archive all logs necessary for troubleshooting."
   echo -e ""
 }
 
@@ -37,7 +37,7 @@ function argumentsCheck {
       ;;
 
       *)
-      echo -e "Uknown argument, see --help for more info \nExiting... \n"
+      echo -e "Unknown argument, see --help for more info \nExiting... \n"
       exit
       ;;
     esac

docs/azure_ad.md

@@ -1,6 +1,6 @@
 # Frinx Machine with Azure AD 
 
-Frinx Machine supports authentification and authorization via Azure AD. The following sections describe how to set up Azure AD for Frinx Machine.
+Frinx Machine supports authentication and authorization via Azure AD. The following sections describe how to set up Azure AD for Frinx Machine.
 ## Client configuration
 Register the application in your Azure AD and configure the following settings.
 
@@ -18,7 +18,7 @@ Set platform redirect URIs on the Authentication page. The table below shows exa
 | Local Postman         | Web                     | https://oauth.pstmn.io/v1/callback                      |
 | Cloud Postman         | Web                     | https://getpostman.com/oauth2/callback                  |
 
-**Frontent login URI** is passed to the installation script `azure_ad.sh` via `--redirect_url` flag.
+**Frontend login URI** is passed to the installation script `azure_ad.sh` via `--redirect_url` flag.
 
 <br>
 

generate-workflow-dependency-tree.py

@@ -73,7 +73,7 @@ def main():
         task_name = task["name"]
         tasks.append(task_name)
 
-    print("Copy text bellow to http://www.webgraphviz.com/")
+    print("Copy text below to http://www.webgraphviz.com/")
     print("digraph dependencies {")
     print("ratio = fill")
     print("node [style=filled]")

generate_uc_compose.sh

@@ -310,7 +310,7 @@ function generateUcCompose {
     # swarm config paths
     sed -i 's|${UC_CONFIG_PATH}|'"/${__CONFIG_PATH}/${__UNICONFIG_SERVICE_SUFIX}|g" "${__COMPOSE_PATH}"
 
-    # swarm persistant volume paths
+    # swarm persistent volume paths
     sed -i "s/uniconfig-postgresql_data/${__SERVICE_NAME}-postgresql_data/g" "${__COMPOSE_PATH}"
 
     # swarm uniconfig-controller replicas

startup.sh

@@ -172,7 +172,7 @@ function argumentsCheck {
             set -x;;
 
         *) 
-            echo -e "${ERROR} Unknow option: ${1}. See help!"
+            echo -e "${ERROR} Unknown option: ${1}. See help!"
             exit 1;;
     esac
     shift
@@ -292,7 +292,7 @@ function startContainers {
       ;;
 
       *)
-        echo -e "${ERROR} Unknow option: ${startupType}. See help!"
+        echo -e "${ERROR} Unknown option: ${startupType}. See help!"
         exit 1
       ;;
   esac
@@ -418,9 +418,9 @@ function setNodeIdLocalDeploy {
 
 function validateAzureAD {
   if [[ ${AUTH_ENABLED} == "false" ]]; then
-    echo -e "${WARNING} For Autorization is used Frinx Fake Token"
+    echo -e "${WARNING} For Authorization is used Frinx Fake Token"
   elif [[ ${AUTH_ENABLED} == "true" ]]; then
-    echo -e "${WARNING} For Autorization is used Azure Active Directory"
+    echo -e "${WARNING} For Authorization is used Azure Active Directory"
   fi
 }
 

teardown.sh

@@ -13,7 +13,7 @@ OPTIONS:
     -s|--stack-name     set FM stack name (default fm)
     -f|--frinx          delete FM Uniconfig/Workflow-Manager volumes
     -m|--monitoring     delete FM monitoring volumes
-    -v|--volumes        delete all FM persistant volumes (FM, Monitoring)
+    -v|--volumes        delete all FM persistent volumes (FM, Monitoring)
     -c|--cache          delete content of ./config/uniconfig/frinx/uniconfig/cache folder
     -a|--all            delete all volumes and files (except secrets)
 
@@ -153,7 +153,7 @@ do
             set -x;;
 
         *) 
-            echo "Unknow option: ${1}"
+            echo "Unknown option: ${1}"
             show_help
             exit 1;;
     esac