Utilisation en ligne de commande¶

Une fois l’outil installé, il est appelable en ligne de commande : gpf-pub-agent-vector-tms.

Fonctionnement général¶

Agent de publication des configurations de type VECTOR-TMS de la Géoplateforme.

Commandes et options¶

GPF PUB AGENT VECTOR TMS 1.2.0 - Agent de publication des configurations de type VECTOR-TMS de la Géoplateforme

gpf-pub-agent-vector-tms [-h] [-v] [--version] [--gs-url GEOSERVICE_URL]
                         [--endpoint-name GPF_ENDPOINT_NAME] [--pod-id GEOSERVICE_POD_NAME]
                         [--url-entrepot GPF_WAREHOUSE_URL] [--exchange-name EXCHANGE_NAME]
                         [--publication-result-topic PUBLICATION_RESULT_TOPIC]
                         [--rabbit-host RABBIT_HOST] [--rabbit-port RABBIT_PORT]
                         [--keycloack-user-id KEYCLOACK_USER_ID]
                         [--rabbit-login RABBIT_USERNAME] [--rabbit-password RABBIT_PASSWORD]
                         [--health-file GPF_HEALTH_FILE]
                         [--gs-url-health GEOSERVICE_URL_HEALTHCHECK]
                         [--pg-user GPF_DATABASE_STORAGE_USER]
                         [--pg-pass GPF_DATABASE_STORAGE_PWD]
                         [--pg-tileserv-pg-host PG_TILESERV_PG_HOST]
                         [--pg-tileserv-pg-port PG_TILESERV_PG_PORT]
                         [--pg-tileserv-pg-db PG_TILESERV_PG_DB]
                         [--pg-tileserv-pg-login PG_TILESERV_PG_LOGIN]
                         [--pg-tileserv-pg-password PG_TILESERV_PG_PASSWORD]
                         [--consistency-checking-timer CONSISTENCY_CHECKING_TIMER]
                         [--consistency-checking-enabled CONSISTENCY_CHECKING_ENABLED]
                         [--mattermost-webhook-scheme MATTERMOST_WEBHOOK_SCHEME]
                         [--mattermost-webhook-host MATTERMOST_WEBHOOK_HOST]
                         [--mattermost-webhook-port MATTERMOST_WEBHOOK_PORT]
                         [--mattermost-webhook-token MATTERMOST_WEBHOOK_TOKEN]
                         [--mattermost-request-timeout MATTERMOST_REQUEST_TIMEOUT]

gpf-pub-agent-vector-tms options¶

-h, --help - show this help message and exit
-v, --verbose - Verbosity level: None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
--version - show program’s version number and exit
--gs-url GEOSERVICE_URL, --geoservice-url GEOSERVICE_URL, --rok4-url GEOSERVICE_URL - ROK4 url. (default: http://localhost:7800/)
--endpoint-name GPF_ENDPOINT_NAME - Endpoint name. (default: endpoint)
--pod-id GEOSERVICE_POD_NAME - POD Id. (default: pod_id)
--url-entrepot GPF_WAREHOUSE_URL - Url de l’entrepot (default: None)
--exchange-name EXCHANGE_NAME - Nom de l’exchange (default: publication-endpoint)
--publication-result-topic PUBLICATION_RESULT_TOPIC - Topic de publication des résultats (default: publication-endpoint-update)
--rabbit-host RABBIT_HOST - Hote du bus rabbitMQ (default: localhost)
--rabbit-port RABBIT_PORT - Port du bus rabbitMQ (default: 5672)
--keycloack-user-id KEYCLOACK_USER_ID - id de l'utilisateur technique qui a le droit d'utiliser les appels en /technical (default: None)
--rabbit-login RABBIT_USERNAME - utilisateur du bus RabbitMQ (default: None)
--rabbit-password RABBIT_PASSWORD - mot de passe pour le bus RabbitMQ (default: None)
--health-file GPF_HEALTH_FILE - chemin vers le fichier de santé de l’agent (default: None)
--gs-url-health GEOSERVICE_URL_HEALTHCHECK, --geoservice-url-healthcheck GEOSERVICE_URL_HEALTHCHECK - Download service health check url. (default: None)
--pg-user GPF_DATABASE_STORAGE_USER, --postgres-user GPF_DATABASE_STORAGE_USER - Postgres user name. (default: postgres)
--pg-pass GPF_DATABASE_STORAGE_PWD, --postgres-pass GPF_DATABASE_STORAGE_PWD - Postgres password. (default: postgres)
--pg-tileserv-pg-host PG_TILESERV_PG_HOST - host de la base de données de pg_tilserv (default: localhost)
--pg-tileserv-pg-port PG_TILESERV_PG_PORT - port de la base de données de pg_tilserv (default: 5444)
--pg-tileserv-pg-db PG_TILESERV_PG_DB - nom de la base de données de pg_tilserv (default: ign)
--pg-tileserv-pg-login PG_TILESERV_PG_LOGIN - login de la base de données de pg_tilserv (default: ign)
--pg-tileserv-pg-password PG_TILESERV_PG_PASSWORD - password de la base de données de pg_tilserv (default: ign)
--consistency-checking-timer CONSISTENCY_CHECKING_TIMER - Timer du vérificateur de cohérence (default: 300)
--consistency-checking-enabled CONSISTENCY_CHECKING_ENABLED - Activation de la vérification de cohérence (1: activé, 0: désactivé) (default: 1)
--mattermost-webhook-scheme MATTERMOST_WEBHOOK_SCHEME - Schéma d’appel du Mattermost webhook (default: http)
--mattermost-webhook-host MATTERMOST_WEBHOOK_HOST - Host du Mattermost webhook (default: mattermost.gpf-tech.ign.fr)
--mattermost-webhook-port MATTERMOST_WEBHOOK_PORT - Port du Mattermost webhook (default: 80)
--mattermost-webhook-token MATTERMOST_WEBHOOK_TOKEN - Token du Mattermost webhook (default: None)
--mattermost-request-timeout MATTERMOST_REQUEST_TIMEOUT - Timeout des requêtes Mattermost (default: 60)

Agent de publication des configurations de type VECTOR-TMS de la Géoplateforme.

Développé par Quy Thy TRUONG
Documentation : https://geoplateforme.pages.gpf-tech.ign.fr/

Variables d’environnement¶

Génériques¶

Nom de la variable	Argument CLI correspondant	Valeur par défaut
`GEOSERVICE_URL`	`--geoservice-url`	`http://localhost:8600/`
`GPF_ENDPOINT_NAME`	`--endpoint-name`	`endpoint`
`GEOSERVICE_POD_NAME`	`--pod-id`	`pod_id`
`GPF_WAREHOUSE_URL`	`--url-entrepot`
`EXCHANGE_NAME`	`--exchange-name`	`publication-{GPF_ENDPOINT_NAME}`
`PUBLICATION_RESULT_TOPIC`	`--publication-result-topic`	`publication-endpoint-update`
`RABBIT_HOST`	`--rabbit-host`	`localhost`
`RABBIT_PORT`	`--rabbit-port`	`5672`
`RABBIT_USERNAME`	`--rabbbit-login`
`RABBIT_PASSWORD`	`--rabbit-password`
`KEYCLOACK_USER_ID`	`--keycloack-user-id`
`GPF_HEALTH_FILE`	`--health-file`
`GEOSERVICE_URL_HEALTHCHECK`	`--geoservice-url-healthcheck`

Spécifiques¶

Nom de la variable	Argument CLI correspondant	Valeur par défaut
`GPF_DATABASE_STORAGE_USER`	`--pg-user`	`postgres`
`GPF_DATABASE_STORAGE_PWD`	`--pg-pass`	`postgres`
`PG_TILESERV_PG_HOST`	`--pg-tileserv-pg-host`	`endpoint`
`PG_TILESERV_PG_PORT`	`--pg-tileserv-pg-port`	`5444`
`PG_TILESERV_PG_DB`	`--pg-tileserv-pg-db`	`ign`
`PG_TILESERV_PG_LOGIN`	`--pg-tileserv-pg-login`	`ign`
`PG_TILESERV_PG_PASSWORD`	`-pg-tileserv-pg-password`	`ign`

TODO: compléter