From 0eb8391138ff83a0164acd548b4adc9b4da35447 Mon Sep 17 00:00:00 2001 From: Alvaro Vega Date: Fri, 29 Sep 2023 12:52:22 +0200 Subject: [PATCH] remove AUTH vars --- bin/perseo | 5 --- docs/admin/configuration.md | 89 ++++++++++++++++++------------------- 2 files changed, 43 insertions(+), 51 deletions(-) diff --git a/bin/perseo b/bin/perseo index 0d6f79bb..8b7e1a8b 100755 --- a/bin/perseo +++ b/bin/perseo @@ -102,11 +102,6 @@ function loadConfiguration() { 'PERSEO_NOTICES_PATH', 'PERSEO_RULES_PATH', 'PERSEO_CAST_TYPES', - 'PERSEO_AUTHENTICATION_HOST', - 'PERSEO_AUTHENTICATION_PORT', - 'PERSEO_AUTHENTICATION_USER', - 'PERSEO_AUTHENTICATION_PASSWORD', - 'PERSEO_AUTHENTICATION_SERVICE', 'PERSEO_MAX_RULES_BY_CORR', 'PERSEO_CHECK_NON_SIGNAL_BY_API' ]; diff --git a/docs/admin/configuration.md b/docs/admin/configuration.md index 547c67d2..4d19ca5c 100644 --- a/docs/admin/configuration.md +++ b/docs/admin/configuration.md @@ -10,52 +10,48 @@ There are two ways of configuring Perseo CEP: The following table shows the environment variables available for Perseo configuration: -| Environment variable | Description | -| :--------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| PERSEO_ENDPOINT_HOST | Host where the CEP will listen. | -| PERSEO_ENDPOINT_PORT | Port where the CEP will listen. | -| PERSEO_MONGO_ENDPOINT | Endpoint (`host[:port]`) list for Mongo DB. | -| PERSEO_MONGO_REPLICASET | ReplicaSet name for Mongo DB. | -| PERSEO_MONGO_AUTH_SOURCE | The database name associated with the user's credentials for Mongo DB. [More info here](https://docs.mongodb.com/manual/reference/connection-string/#mongodb-urioption-urioptionauthSource). | -| PERSEO_MONGO_USER | User for Mongo DB. | -| PERSEO_MONGO_PASSWORD | Password for Mongo DB. | -| PERSEO_IS_MASTER | true if this one is the master or false it is the slave | -| PERSEO_SLAVE_DELAY | Slave's delay to try to execute an action (milliseconds). | -| PERSEO_CORE_URL | Full URL where Perseo Core is listening (e.g: `http://63.34.124.1:8080`). | -| PERSEO_NEXT_URL | Full URL where Perseo Core replicated node is listening. Same format as above. | -| PERSEO_ORION_URL | Full URL of the Orion Context Broker (e.g: `http://64.124.28.15:1026`). | -| PERSEO_PEP_URL | Full URL of the Pep (Context Broker) (e.g: `http://64.124.28.15:10026`). This URL will be used instead of PERSEO_ORION_URL when updateAction rule has set a non empty value for service and subservice. | -| PERSEO_LOG_LEVEL | Log level. | -| PERSEO_SMTP_HOST | Host of the SMTP server | -| PERSEO_SMTP_PORT | Port of the SMTP server | -| PERSEO_SMTP_SECURE | `true` if SSL should be used with the SMTP server | -| PERSEO_SMTP_AUTH_USER | Authentication data, the username | -| PERSEO_SMTP_AUTH_PASS | Authentication data, the password for the user | -| PERSEO_SMTP_TLS_REJECTUNAUTHORIZED | Reject if unauthorized security is found (i.e. selfsigned certificates). Default is false. | -| PERSEO_SMS_URL | URL for sending SMSs (SMPP Adapter) | -| PERSEO_SMS_API_KEY | API KEY for sending SMSs, if necessary. Only for the SMPP Adapter simulator | -| PERSEO_SMS_API_SECRET | API SECRET for sending SMSs, if necessary. Only for the SMPP Adapter simulator | -| PERSEO_SMS_FROM | Field `from` for the outgoing SMSs. Required by the SMPP Adapter | -| PERSEO_SMPP_HOST | Host of the SMPP server | -| PERSEO_SMPP_PORT | Port of the SMPP server | -| PERSEO_SMPP_SYSTEMID | SystemID for the user of the SMPP server | -| PERSEO_SMPP_PASSWORD | Password for the user of the SMPP server | -| PERSEO_SMPP_FROM | Number from SMS are sending by SMPP server | -| PERSEO_SMPP_ENABLED | SMPP is default method for SMS instead of use SMS gateway | -| PERSEO_NOTICES_PATH | Path for incoming notices, default value '/notices' | -| PERSEO_RULES_PATH | Path for incoming rules, default value '/rules' | -| PERSEO_AUTHENTICATION_HOST | Host of the authentication endpoint | -| PERSEO_AUTHENTICATION_PORT | Port of the authentication endpoint | -| PERSEO_AUTHENTICATION_USER | User to perform authentication | -| PERSEO_AUTHENTICATION_PASSWORD | Password for the user to perform authentication | -| PERSEO_AUTHENTICATION_SERVICE | Keystone User Service to perform authentication | -| PERSEO_CAST_TYPE | Maximum number of rule executions triggered by the same notification (with the same correlator) until refuse execute a rule. Default is 20. See [loop detection tips](https://github.com/telefonicaid/perseo-fe/blob/master/docs/architecture/architecture.md#loop-detection) | -| PERSEO_MAX_RULES_BY_CORR | If true, enable attribute value casting based in NGSI-v2 attribute types if true. If false (default), the JSON native type for the attribute value is used. | -| PERSEO_CHECK_NON_SIGNAL_BY_API | If false, the entities will be directly find using MongoDB, if true they will be fing using NGSIv2 API(*) - -(*)Although the idea is that now Perseo works always using NGSIv2 API to check times for non signal rules, this setting has been introduced to ease a potential rollback if some problem is found with this new approach. Thus, I has to be considered a kind of temporal debugging settings, to be removed when we get confident with the new functionality, thus you should use it with care. - +| Environment variable | Description | +| :--------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PERSEO_ENDPOINT_HOST | Host where the CEP will listen. | +| PERSEO_ENDPOINT_PORT | Port where the CEP will listen. | +| PERSEO_MONGO_ENDPOINT | Endpoint (`host[:port]`) list for Mongo DB. | +| PERSEO_MONGO_REPLICASET | ReplicaSet name for Mongo DB. | +| PERSEO_MONGO_AUTH_SOURCE | The database name associated with the user's credentials for Mongo DB. [More info here](https://docs.mongodb.com/manual/reference/connection-string/#mongodb-urioption-urioptionauthSource). | +| PERSEO_MONGO_USER | User for Mongo DB. | +| PERSEO_MONGO_PASSWORD | Password for Mongo DB. | +| PERSEO_IS_MASTER | true if this one is the master or false it is the slave | +| PERSEO_SLAVE_DELAY | Slave's delay to try to execute an action (milliseconds). | +| PERSEO_CORE_URL | Full URL where Perseo Core is listening (e.g: `http://63.34.124.1:8080`). | +| PERSEO_NEXT_URL | Full URL where Perseo Core replicated node is listening. Same format as above. | +| PERSEO_ORION_URL | Full URL of the Orion Context Broker (e.g: `http://64.124.28.15:1026`). | +| PERSEO_PEP_URL | Full URL of the Pep (Context Broker) (e.g: `http://64.124.28.15:10026`). This URL will be used instead of PERSEO_ORION_URL when updateAction rule has set a non empty value for service and subservice. | +| PERSEO_LOG_LEVEL | Log level. | +| PERSEO_SMTP_HOST | Host of the SMTP server | +| PERSEO_SMTP_PORT | Port of the SMTP server | +| PERSEO_SMTP_SECURE | `true` if SSL should be used with the SMTP server | +| PERSEO_SMTP_AUTH_USER | Authentication data, the username | +| PERSEO_SMTP_AUTH_PASS | Authentication data, the password for the user | +| PERSEO_SMTP_TLS_REJECTUNAUTHORIZED | Reject if unauthorized security is found (i.e. selfsigned certificates). Default is false. | +| PERSEO_SMS_URL | URL for sending SMSs (SMPP Adapter) | +| PERSEO_SMS_API_KEY | API KEY for sending SMSs, if necessary. Only for the SMPP Adapter simulator | +| PERSEO_SMS_API_SECRET | API SECRET for sending SMSs, if necessary. Only for the SMPP Adapter simulator | +| PERSEO_SMS_FROM | Field `from` for the outgoing SMSs. Required by the SMPP Adapter | +| PERSEO_SMPP_HOST | Host of the SMPP server | +| PERSEO_SMPP_PORT | Port of the SMPP server | +| PERSEO_SMPP_SYSTEMID | SystemID for the user of the SMPP server | +| PERSEO_SMPP_PASSWORD | Password for the user of the SMPP server | +| PERSEO_SMPP_FROM | Number from SMS are sending by SMPP server | +| PERSEO_SMPP_ENABLED | SMPP is default method for SMS instead of use SMS gateway | +| PERSEO_NOTICES_PATH | Path for incoming notices, default value '/notices' | +| PERSEO_RULES_PATH | Path for incoming rules, default value '/rules' | +| PERSEO_CAST_TYPE | Maximum number of rule executions triggered by the same notification (with the same correlator) until refuse execute a rule. Default is 20. See [loop detection tips](https://github.com/telefonicaid/perseo-fe/blob/master/docs/architecture/architecture.md#loop-detection) | +| PERSEO_MAX_RULES_BY_CORR | If true, enable attribute value casting based in NGSI-v2 attribute types if true. If false (default), the JSON native type for the attribute value is used. | +| PERSEO_CHECK_NON_SIGNAL_BY_API | If false, the entities will be directly find using MongoDB, if true they will be fing using NGSIv2 API(\*) | +(\*)Although the idea is that now Perseo works always using NGSIv2 API to check times for non signal rules, this setting +has been introduced to ease a potential rollback if some problem is found with this new approach. Thus, I has to be +considered a kind of temporal debugging settings, to be removed when we get confident with the new functionality, thus +you should use it with care. ### Basic Configuration @@ -93,7 +89,8 @@ In order to have perseo running, there are several basic pieces of information t [database aspects](admin.md#database-aspects) documentation for mode detail). - `config.checkDB.bufferMaxEntries`: Number of operations buffered up before giving up on getting a working connection (see [database aspects](admin.md#database-aspects) documentation for mode detail). -- `config.maxRulesByCorr`: Maximum number of rule executions triggered by the same notification (with the same correlator) until refuse execute a rule. Defualt is 20 +- `config.maxRulesByCorr`: Maximum number of rule executions triggered by the same notification (with the same + correlator) until refuse execute a rule. Defualt is 20 - `config.nonSignalByAPI`: Flag value, determine the use of the NGSIv2 API or MongoDB. By default is false. Options for HA: