Utilisation en ligne de commande#

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

Fonctionnement général#

Agent de publication pour service de téléchargement.

Commandes et options#

gpf-pub-agent-download 1.10.1-beta - Agent de publication pour service de téléchargement

gpf-pub-agent-download [-h] [-v] [--version] [--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]
                       [--s3-url GPF_S3_URL] [--s3-key GPF_S3_KEY]
                       [--s3-secret-key GPF_S3_SECRETKEY] [--s3-region GPF_S3_REGION]
                       [--gs-url GEOSERVICE_URL] [--gs-url-health GEOSERVICE_URL_HEALTHCHECK]
                       [--health-file GPF_HEALTH_FILE]
                       [--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-download 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

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

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

  • --gs-url GEOSERVICE_URL, --geoservice-url GEOSERVICE_URL - Download service url. (default: http://localhost:8079)

  • --gs-url-health GEOSERVICE_URL_HEALTHCHECK, --geoservice-url-healthcheck GEOSERVICE_URL_HEALTHCHECK - Download service health check url. (default: http://localhost:8079/health)

  • --health-file GPF_HEALTH_FILE - chemin vers le fichier de santé de l’agent (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)

Variables d’environnement#

Génériques#

Nom de la variable

Argument CLI correspondant

Valeur par défaut

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

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

GEOSERVICE_URL

--geoservice-url

http://localhost:8079

GEOSERVICE_URL_HEALTHCHECK

--geoservice-url-healthcheck

http://localhost:8079/health

GPF_HEALTH_FILE

--health-file

``