Skip to content

Commit

Permalink
Merge branch 'master' into task/doc-rework-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
mapedraza authored Aug 5, 2024
2 parents 546c7ba + 46ac1d8 commit 319a250
Show file tree
Hide file tree
Showing 127 changed files with 9,776 additions and 4,880 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
runs-on: ubuntu-latest
services:
mongodb:
image: mongo:4.2
image: mongo:6.0
ports:
- 27017:27017
strategy:
Expand All @@ -72,7 +72,7 @@ jobs:
needs: unit-test
services:
mongodb:
image: mongo:4.2
image: mongo:6.0
ports:
- 27017:27017
steps:
Expand Down
6 changes: 5 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ version: 2
mkdocs:
configuration: mkdocs.yml

build:
os: ubuntu-22.04
tools:
python: "3.8"

python:
version: 3.8
install:
- requirements: doc/requirements.txt
4 changes: 3 additions & 1 deletion CHANGES_NEXT_RELEASE
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Upgrade mongodb dev dep from 4.17.0 to 4.17.1
- Fix: service header to use uppercase in case of update and delete (#1528)
- Fix: Allow to send to CB batch update for multimeasures for NGSI-LD (#1623)
- Add: new JEXL transformations for including into an array keys that have a certain value: valuePicker and valuePickerMulti
3 changes: 2 additions & 1 deletion config.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ var config = {
subservice: '/gardens',
providerUrl: 'http://192.168.56.1:4041',
deviceRegistrationDuration: 'P1M',
defaultType: 'Thing'
defaultType: 'Thing',
expressLimit: '1Mb'
};

module.exports = config;
35 changes: 16 additions & 19 deletions doc/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@
- [providerUrl](#providerurl)
- [iotaVersion](#iotaversion)
- [dieOnUnexpectedError](#dieonunexpectederror)
- [singleConfigurationMode](#singleconfigurationmode)
- [timestamp](#timestamp)
- [defaultResource](#defaultresource)
- [defaultKey](#defaultkey)
- [componentName](#componentname)
- [pollingExpiration](#pollingexpiration)
- [pollingDaemonFrequency](#pollingdaemonfrequency)
- [autocast](#autocast)
- [multiCore](#multicore)
- [fallbackTenant](#fallbacktenant)
- [fallbackPath](#fallbackpath)
Expand Down Expand Up @@ -262,13 +260,13 @@ the `mongob` section (as described bellow). E.g.:

It configures the MongoDB driver for those repositories with 'mongodb' type. If the `host` parameter is a list of
comma-separated IPs, they will be considered to be part of a Replica Set. In that case, the optional property
`replicaSet` should contain the Replica Set name. If the database requires authentication, username (`username`),
password (`password`) and authSource (`authSource`) can be set. If the database requires TLS/SSL connection but any
validation of the certificate chain is not mandatory, all you need is to set the ssl (`ssl`) option as `true` to connect
the database. If you need to add more complex option(s) such as `retryWrites=true` or `w=majority` when connection
database, extraArgs (`extraArgs`) can be used to perform it. For The MongoBD driver will retry the connection at startup
time `retries` times, waiting `retryTime` seconds between attempts, if those attributes are present (default values are
5 and 5 respectively). E.g.:
`replicaSet` should contain the Replica Set name. If the database requires authentication, username (`user`), password
(`password`) and authSource (`authSource`) can be set. If the database requires TLS/SSL connection but any validation of
the certificate chain is not mandatory, all you need is to set the ssl (`ssl`) option as `true` to connect the database.
If you need to add more complex option(s) such as `retryWrites=true` or `w=majority` when connection database, extraArgs
(`extraArgs`) can be used to perform it. For The MongoBD driver will retry the connection at startup time `retries`
times, waiting `retryTime` seconds between attempts, if those attributes are present (default values are 5 and 5
respectively). E.g.:

```javascript
{
Expand Down Expand Up @@ -348,10 +346,6 @@ IoTA).

if this flag is activated, the IoTAgent will not capture global exception, thus dying upon any unexpected error.

#### `singleConfigurationMode`

enables the Single Configuration mode for backwards compatibility (see description in the Overview). Default to false.

#### `timestamp`

if this flag is activated:
Expand Down Expand Up @@ -383,10 +377,6 @@ amount of time without being collected by the device, the expiration daemon will
time between collection of expired commands in milliseconds. This attribute is optional (if this parameter doesn't exist
the polling daemon won't be started).

#### `autocast`

When enabled, the IoT Agents will try to cast attribute's values considering the JSON native type (only for NGSI v2).

#### `multiCore`

When enabled, the IoT Agents runs in multi-thread environment to take advantage of multi-core systems. It allows two
Expand Down Expand Up @@ -431,6 +421,14 @@ characters (such as semi-colons) which are
specification. When provisioning devices, it is necessary that the developer provides valid `objectId`-`name` mappings
whenever relaxed mode is used, to prevent the consumption of forbidden characters.

#### `expressLimit`

IotAgents, as all Express applications that use the body-parser middleware, have a default limit to the request body
size that the application will handle. This default limit for ioiotagnets are 1Mb. So, if your IotAgent receives a
request with a body that exceeds this limit, the application will throw a “Error: Request entity too large”.

The 1Mb default can be changed setting the `expressLimit` configuration parameter (or equivalente `IOTA_EXPRESS_LIMIT` environment variable).

### Configuration using environment variables

Some of the configuration parameters can be overriden with environment variables, to ease the use of those parameters
Expand Down Expand Up @@ -483,17 +481,16 @@ overrides.
| IOTA_MONGO_RETRY_TIME | `mongodb.retryTime` |
| IOTA_MONGO_SSL | `mongodb.ssl` |
| IOTA_MONGO_EXTRAARGS | `mongodb.extraArgs` |
| IOTA_SINGLE_MODE | `singleConfigurationMode` |
| IOTA_POLLING_EXPIRATION | `pollingExpiration` |
| IOTA_POLLING_DAEMON_FREQ | `pollingDaemonFrequency` |
| IOTA_AUTOCAST | `autocast` |
| IOTA_MULTI_CORE | `multiCore` |
| IOTA_JSON_LD_CONTEXT | `jsonLdContext` |
| IOTA_FALLBACK_TENANT | `fallbackTenant` |
| IOTA_FALLBACK_PATH | `fallbackPath` |
| IOTA_EXPLICIT_ATTRS | `explicitAttrs` |
| IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION | `defaultEntityNameConjunction` |
| IOTA_RELAX_TEMPLATE_VALIDATION | `relaxTemplateValidation` |
| IOTA_EXPRESS_LIMIT | `expressLimit` |

Note:

Expand Down
Loading

0 comments on commit 319a250

Please sign in to comment.