Utilisation en ligne de commande

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

Fonctionnement général

L’agent de publication Road2 (gpf-pub-agent-road2) permet la publication de configuration de l’API Entrepôt sur un service Road2.

Commandes et options

Agent de publication Road2 2.0.0 - L’agent de publication Road2 (gpf-pub-agent-road2) permet la publication de configuration de l’API Entrepôt sur un service Road2

gpf-pub-agent-road2 [-h] [-v] [--version] [-w GPF_WORK_DIR]
                    [--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] [--user-agent USER_AGENT]
                    [--rabbit-login RABBIT_USERNAME] [--rabbit-password RABBIT_PASSWORD]
                    [--gs-url-health GEOSERVICE_URL_HEALTHCHECK]
                    [--pg-user GPF_DATABASE_STORAGE_USER]
                    [--pg-pass GPF_DATABASE_STORAGE_PWD]
                    [--road2-graph-data-dir ROAD2-GRAPH-DATA-DIR]
                    [--road2-service-dir ROAD2-SERVICE-DIR] [--s3-url GPF_S3_URL]
                    [--s3-key GPF_S3_KEY] [--s3-secret-key GPF_S3_SECRETKEY]
                    [--s3-region GPF_S3_REGION] [--health-file GPF_HEALTH_FILE]
                    [--gs-url GEOSERVICE_URL] [--road2-db-pool-size ROAD2_DB_POOL_SIZE]
                    [--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]
                    [--checking-sources-to-be-removed-timer CHECKING_SOURCES_TO_BE_REMOVED_TIMER]

gpf-pub-agent-road2 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

• -w GPF_WORK_DIR, --workdir GPF_WORK_DIR, --work-dir-path GPF_WORK_DIR - Input working directory. Must exist. (default: None)

• --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)

• --user-agent USER_AGENT - nom du user_agent à envoyer lors des requètes vers l’API Entrepot (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)

• --gs-url-health GEOSERVICE_URL_HEALTHCHECK, --geoservice-url-healthcheck GEOSERVICE_URL_HEALTHCHECK - Service health check url. (default: http://localhost:8079/admin/1.0.0/health)

• --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)

• --road2-graph-data-dir ROAD2-GRAPH-DATA-DIR, --graph-data-dir ROAD2-GRAPH-DATA-DIR - Endpoint graph data dir (shared by all endpoints). Must exist. (default: None)

• --road2-service-dir ROAD2-SERVICE-DIR, --service-dir ROAD2-SERVICE-DIR - Road2 service data directory. Must exist. (default: None)

• --s3-url GPF_S3_URL - Url du storage S3 (default: http://172.17.0.1:9000)

• --s3-key GPF_S3_KEY - Utilisateur du stockage S3 (default: admin)

• --s3-secret-key GPF_S3_SECRETKEY - Password du stockage S3 (default: minioadmin)

• --s3-region GPF_S3_REGION - Region du stockage S3 (default: eu-west-3)

• --health-file GPF_HEALTH_FILE - chemin vers le fichier de santé de l’agent (default: None)

• --gs-url GEOSERVICE_URL, --geoservice-url GEOSERVICE_URL, --road2-admin-url GEOSERVICE_URL - Road2 administration url. (default: http://localhost:8079)

• --road2-db-pool-size ROAD2_DB_POOL_SIZE - Taille du pool de connection pour le service Road2 (default: None)

• --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)

• --checking-sources-to-be-removed-timer CHECKING_SOURCES_TO_BE_REMOVED_TIMER - Timer du vérificateur de suppression des ressources non utilisées (default: 30)

---

Variables d’environnement

Génériques

Nom de la variable	Argument CLI correspondant	Valeur par défaut
GPF_WORK_DIR	--work-dir-path

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
GEOSERVICE_URL	--geoservice-url	http://localhost:8600/geoserver
GEOSERVER_USER	--geoservice-user	admin
GEOSERVER_PASS	--geoservice-pass	geoserver
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_S3_URL	--s3-url	``
GPF_S3_KEY	--s3-key	admin
GPF_S3_SECRETKEY	--s3-secret-key	minioadmin
GPF_S3_REGION	--s3-region	eu-west-3
ROAD2-GRAPH-DATA-DIR	--road2-graph-data-dir	/graph_data
ROAD2-SERVICE-DIR	--road2-service-dir	/service_dir
GPF_HEALTH_FILE	--health-file	``
ROAD2_DB_POOL_SIZE	--road2-db-pool-size	``
GEOSERVICE_URL_HEALTHCHECK	--geoservice-url-healthcheck	http://localhost:8079/admin/1.0.0/health