ADD COMET_FORMAL_MODE option in config.sh

lets-fiware · May 28, 2024 · 37e547d · 37e547d
1 parent 16c2d83
commit 37e547d
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 14 deletions.
diff --git a/.config.sh b/.config.sh
@@ -131,6 +131,11 @@ IMAGE_ELASTICSEARCH_DB=elasticsearch:7.6.2
 # Set a sub-domain name of Comet
 COMET=
 
+# Set comet mode when Cygnus is enabled (Default: true)
+#   false: minimal mode (STH-Comet only)
+#   true:  formal mode (Cygnus + STH-Comet)
+COMET_FORMAL_MODE=
+
 # Expose port (none, local, all) Default: none
 COMET_EXPOSE_PORT=
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## FIWARE Big Bang v0.37.0-next
 
+-   ADD COMET_FORMAL_MODE option in config.sh (#377)
 -   Fix NODE_RED_INSTANCE_NUMBER value checking (#375)
 -   Update Cygnus to 3.8.0 (#372)
 -   Update IoT Agent for JSON to 3.4.0 (#371)

diff --git a/config.sh b/config.sh
@@ -131,6 +131,11 @@ IMAGE_ELASTICSEARCH_DB=elasticsearch:7.6.2
 # Set a sub-domain name of Comet
 COMET=
 
+# Set comet mode when Cygnus is enabled (Default: true)
+#   false: minimal mode (STH-Comet only)
+#   true:  formal mode (Cygnus + STH-Comet)
+COMET_FORMAL_MODE=
+
 # Expose port (none, local, all) Default: none
 COMET_EXPOSE_PORT=
 

diff --git a/docs/en/installation/comet.md b/docs/en/installation/comet.md
@@ -17,12 +17,13 @@
 
 You can specify configurations by editing the `config.sh` file.
 
-| Variable name        | Description                                                      | Default value |
-| -------------------- | ---------------------------------------------------------------- | ------------- |
-| COMET                | A sub-domain name of Comet                                       | (empty)       |
-| CYGNUS               | A sub-domain name of Cygnus                                      | (empty)       |
-| COMET\_EXPOSE\_PORT  | Expose port for Comet. (none, local, all)                        | none          |
-| COMET\_LOGOPS\_LEVEL | Set logging level for Comet. (DEBUG, INFO, WARN, ERROR or FATAL) | INFO          |
+| Variable name        | Description                                                                                                         | Default value |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------- |
+| COMET                | A sub-domain name of Comet                                                                                          | (empty)       |
+| CYGNUS               | A sub-domain name of Cygnus                                                                                         | (empty)       |
+| COMET\_FORMAL\_MODE  | Set comet mode when Cygnus is enabled. false: minimal mode (STH-Comet only), true: formal mode (Cygnus + STH-Comet) | (true)        |
+| COMET\_EXPOSE\_PORT  | Expose port for Comet. (none, local, all)                                                                           | none          |
+| COMET\_LOGOPS\_LEVEL | Set logging level for Comet. (DEBUG, INFO, WARN, ERROR or FATAL)                                                    | INFO          |
 
 ## How to setup
 
@@ -46,6 +47,9 @@ COMET=comet
 CYGNUS=cygnus
 ```
 
+When set a sub-domain name for Comet and Cygnus to `COMET=` and `CYGNUS=` and set `COMET\_FORMAL\_MODE` to `false`,
+Comet runs in the minimal mode.
+
 ## Related information
 
 -   [STH-Comet - GitHub](https://github.com/telefonicaid/fiware-sth-comet)

diff --git a/docs/ja/installation/comet.md b/docs/ja/installation/comet.md
@@ -19,12 +19,13 @@
 
 `config.sh` ファイルを編集して構成を指定できます。
 
-| 変数名               | 説明                                                                    | 既定値 |
-| -------------------- | ----------------------------------------------------------------------- | ------ |
-| COMET                | Comet のサブドメイン名                                                  | (なし) |
-| CYGNUS               | Cygnus のサブドメイン名                                                 | (なし) |
-| COMET\_EXPOSE\_PORT  | Comet のポート 8666 を公開。(none, local または all)                    | none   |
-| COMET\_LOGOPS\_LEVEL | Comet のロギング・レベルを設定。(DEBUG, INFO, WARN, ERROR または FATAL) | INFO   |
+| 変数名               | 説明                                                                                                                              | 既定値 |
+| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------ |
+| COMET                | Comet のサブドメイン名                                                                                                            | (なし) |
+| CYGNUS               | Cygnus のサブドメイン名                                                                                                           | (なし) |
+| COMET\_FORMAL\_MODE  | Cygnus が有効な場合に Comet の動作モードを設定。false: 最小モード (STH-Comet のみ)、true: フォーマル・モード (Cygnus + STH-Comet) | (true) |
+| COMET\_EXPOSE\_PORT  | Comet のポート 8666 を公開。(none, local または all)                                                                              | none   |
+| COMET\_LOGOPS\_LEVEL | Comet のロギング・レベルを設定。(DEBUG, INFO, WARN, ERROR または FATAL)                                                           | INFO   |
 
 <a name="how-to-setup"></a>
 
@@ -55,6 +56,9 @@ COMET=comet
 CYGNUS=cygnus
 ```
 
+Comet と Cygnus のサブドメイン名を `COMET=` と `CYGNUS=` に設定し、`COMET\_FORMAL\_MODE` に `false` に設定すると、
+Comet は最小モードで実行されます。
+
 <a name="related-information"></a>
 
 ## 関連情報

diff --git a/lets-fiware.sh b/lets-fiware.sh
@@ -436,7 +436,9 @@ set_and_check_values() {
     exit "${ERR_CODE}"
   fi
 
-  if [ "${COMET}" != "" ] && [ "${CYGNUS}" != "" ]; then
+  COMET_FORMAL_MODE=${COMET_FORMAL_MODE:-true}
+
+  if [ "${COMET}" != "" ] && [ "${CYGNUS}" != "" ] && $COMET_FORMAL_MODE; then
     CYGNUS_MONGO=true
   fi
 

diff --git a/tests/script/coverage.sh b/tests/script/coverage.sh
@@ -178,7 +178,7 @@ setup() {
   sudo tar zxvf ngsi-${ngsi_go_version}-linux-amd64.tar.gz -C /usr/local/bin
   rm -f ngsi-${ngsi_go_version}-linux-amd64.tar.gz
 
-  KCOV="/usr/local/bin/kcov --exclude-path=tests,.git,setup,coverage,.github,.vscode,examples,docs,.mock,maintenance"
+  KCOV="/usr/local/bin/kcov --exclude-path=tests,.git,setup,coverage,.github,.vscode,examples,docs,.mock,maintenance --exclude-pattern=.md"
 
   SAVE_PATH=${PATH}