Paramètres¶
Cette page vous informe sur chaque section de la page Paramètres et sur le fichier de configuration.
Pour ouvrir la page, appuyez sur ⚙ Paramètres dans la barre supérieure. La page a ces sections, de haut en bas :
- Identifiants
- Sources de jeux de données
- Versions des jeux de données et données locales (avec Visualisations de carte à l'intérieur)
- Mémoire
Le sélecteur de langue n'est pas sur la page Paramètres. Il est dans la barre supérieure. Consultez Langue.
Identifiants¶
La section Identifiants a une carte pour chaque identifiant :
| Titre de la carte | Identifiant | Champs de la carte |
|---|---|---|
| AWS (jeux de données S3) | Une paire de clés AWS. Toutes les sources de données S3 utilisent cette paire de clés. | ID de clé d'accès, Clé d'accès secrète |
| Planet | La clé du fond de carte Planet | Nom d'utilisateur, Clé API |
| Google Maps | La clé du fond de carte Google Maps | Clé API |
| Copernicus (CDSE) | L'ID d'instance du fond de carte Copernicus (CDSE) | ID d'instance |
Chaque carte a une ligne Utilisé depuis : qui vous indique d'où vient l'identifiant utilisé. Les valeurs possibles sont Environnement, Secret Docker, Gestionnaire d'identification, Coffre chiffré et Non défini.
Une carte avec un champ secret (Clé d'accès secrète ou Clé API) affiche aussi Enregistré ou Non enregistré. Le champ secret est toujours vide, aussi après l'enregistrement. L'application ne renvoie jamais un secret enregistré au navigateur.
Les champs ID de clé d'accès, Nom d'utilisateur et ID d'instance ne sont pas des secrets. Ces champs affichent la valeur que le coffre chiffré contient.
Où obtenir chaque valeur¶
- AWS (jeux de données S3) : obtenez un ID de clé d'accès et une clé d'accès secrète pour un compte AWS que vous contrôlez. Ce compte AWS paie toutes les lectures de jeux de données. Consultez Sources de jeux de données.
- Planet : obtenez la clé API et le nom d'utilisateur depuis votre compte Planet.
- Google Maps : obtenez une clé API pour les tuiles de carte Google Maps depuis votre compte Google.
- Copernicus (CDSE) : obtenez l'ID d'instance depuis votre tableau de bord Copernicus Data Space. L'ID d'instance a 8 à 64 caractères : uniquement des lettres, des chiffres et des traits d'union.
Ajouter ou modifier une clé AWS¶
- Dans la carte AWS (jeux de données S3), saisissez l'ID de la clé dans ID de clé d'accès.
- Saisissez le secret dans Clé d'accès secrète.
- Appuyez sur Vérifier les identifiants.
- Assurez-vous que la ligne de résultat commence par "La clé" et indique "est valide".
- Appuyez sur Enregistrer.
REMARQUE : Vérifier les identifiants est gratuit. Ce bouton demande uniquement à AWS STS si la paire de clés est valide. Il ne lit pas de bucket.
REMARQUE : Vous ne pouvez pas appuyer sur Enregistrer tant que la paire de clés n'a pas réussi Vérifier les identifiants. Si vous modifiez un champ après la vérification, vous devez faire la vérification à nouveau. L'application affiche "Vérifiez d'abord les identifiants. Une paire de clés qui a échoué à la vérification n'est jamais enregistrée."
Pour vérifier la clé AWS utilisée maintenant, laissez Clé d'accès secrète vide et ne modifiez pas ID de clé d'accès. Ensuite, appuyez sur Vérifier les identifiants. Si vous saisissez une seule des deux valeurs, l'application affiche "Saisissez à la fois l'ID de clé d'accès et la clé d'accès secrète, ou aucun des deux."
Résultats de Vérifier les identifiants¶
| Résultat | Ce qu'il vous indique | Action |
|---|---|---|
| "La clé ... est valide : ..." | AWS a accepté la paire de clés. La ligne affiche une partie de la clé, l'identité AWS et les 4 derniers chiffres du compte AWS. | Appuyez sur Enregistrer si vous avez saisi une nouvelle paire. |
| "AWS a rejeté cet identifiant ..." | L'ID de la clé ou le secret est incorrect, ou la clé n'est pas active. | Saisissez à nouveau les deux valeurs, puis appuyez sur Vérifier les identifiants. |
| "Aucun identifiant AWS n'est saisi ni enregistré." | Aucune paire de clés n'est saisie ou enregistrée. | Saisissez l'ID de la clé et le secret. |
| "Un identifiant enregistré existe mais n'a pas pu être lu ..." | L'application ne peut pas déchiffrer la clé enregistrée avec la clé maîtresse active. | Saisissez à nouveau l'ID de la clé et le secret, puis enregistrez. |
| "AWS STS est injoignable ..." | Un problème de réseau ou de point de terminaison. Le résultat ne vous informe pas sur l'identifiant. | Faites la vérification à nouveau. |
| "AWS STS n'a pas répondu à temps." | La vérification s'est arrêtée après le délai. Le résultat ne vous informe pas sur l'identifiant. | Faites la vérification à nouveau. |
| "AWS a répondu ..." | AWS a envoyé un autre code d'erreur. La ligne affiche le code. | Examinez le code. |
Ajouter ou modifier une clé de fond de carte¶
- Dans la carte Planet, Google Maps ou Copernicus (CDSE), saisissez la valeur. Pour Planet, saisissez le Nom d'utilisateur et la Clé API.
- Appuyez sur Tester la connexion.
- Assurez-vous que le résultat commence par "Connexion réussie."
- Appuyez sur Enregistrer.
REMARQUE : Tester la connexion envoie les valeurs saisies au fournisseur, mais ne les enregistre pas. Vous ne pouvez pas appuyer sur Enregistrer tant qu'un test des mêmes valeurs n'a pas réussi. L'application affiche "Testez d'abord la connexion. Une connexion en échec n'est jamais enregistrée."
Pour tester la clé utilisée maintenant, laissez la carte vide. Ensuite, appuyez sur Tester la connexion. Le résultat est un de ces messages :
-
La source que l'application a testée. Un exemple est "Identifiant en service testé (Environnement) ; rien n'a été saisi sur cette carte."
-
Si la carte n'a pas de valeur enregistrée : "Rien à tester : cette carte est vide et rien n'est enregistré pour elle."
Résultats de Tester la connexion pour un fond de carte¶
Un test réussi commence par "Connexion réussie." Un test en échec commence par "Échec de la connexion :". La raison suit.
| Résultat | Ce qu'il vous indique |
|---|---|
| ok : "Le fournisseur a accepté cet identifiant." | La clé est correcte. |
| non autorisé : "Le fournisseur a refusé cet identifiant. ..." | La valeur est incorrecte, ou elle n'a plus la permission. |
| injoignable : "Le fournisseur n'a pas pu être joint ..." | Un problème de réseau ou de point de terminaison. Il ne vous informe pas sur l'identifiant. |
| délai expiré : "Le fournisseur n'a pas répondu dans le délai autorisé. ..." | Le fournisseur était trop lent, ou l'application ne peut pas l'atteindre. Il ne vous informe pas sur l'identifiant. |
| mal configuré : "Le fournisseur est mal configuré sur le serveur ..." | La configuration du serveur pour ce fournisseur a un problème. L'application n'a pas testé l'identifiant. |
| non configuré : "Aucun identifiant n'est disponible pour le test." | Aucun identifiant n'a été trouvé. |
Où l'application garde les identifiants¶
L'application cherche chaque identifiant à 4 endroits, dans cet ordre. Elle utilise le premier qu'elle trouve :
- Environnement : les variables d'environnement. Les noms sont
AWS_ACCESS_KEY_IDetAWS_SECRET_ACCESS_KEY(et unAWS_SESSION_TOKENfacultatif),PLANET_API_KEY(au formatuser:key),GOOGLE_MAPS_API_KEYetCDSE_INSTANCE_ID. - Secret Docker : un fichier avec le même nom dans le dossier des secrets Docker. Le dossier par défaut est
/run/secrets. - Gestionnaire d'identification : le Gestionnaire d'identification Windows (Windows Credential Manager). Les clés de configuration
security.credential_manager_namesetsecurity.credential_manager_pairsdonnent les noms cibles. - Coffre chiffré : les identifiants que vous enregistrez sur la page Paramètres.
Le coffre chiffré garde un fichier pour chaque identifiant (<name>.enc.json) dans le dossier que security.secret_store_dir donne. La valeur par défaut est ./data/secrets.d, relative au dossier du fichier de configuration. Dans l'image Docker, ce dossier est /data/data/secrets.d.
Une clé maîtresse chiffre le coffre. Pour voir d'où vient la clé maîtresse, ouvrez Détails dans la section Identifiants. Si la clé maîtresse est un fichier dans la même arborescence de dossiers que les identifiants enregistrés, l'application affiche un avertissement. Toute personne qui peut lire ce dossier peut alors déchiffrer les identifiants.
AVERTISSEMENT : Si la clé maîtresse est un fichier à côté des données, donnez la clé avec LUC_ANALYTICS_SECRET_KEY (une variable d'environnement ou un secret Docker). Une personne qui peut lire le fichier de la clé peut lire vos identifiants enregistrés.
Supprimer un identifiant enregistré¶
REMARQUE : Cette procédure supprime l'identifiant uniquement du coffre chiffré. Elle ne supprime pas une variable d'environnement, un secret Docker ou une valeur du Gestionnaire d'identification Windows. Vous devez les supprimer à leur source.
- Dans la section Identifiants, ouvrez Détails.
- Trouvez la ligne de l'identifiant. La colonne Coffre chiffré affiche Enregistré, ou Enregistré, non utilisé (une source au-dessus est prioritaire).
- Appuyez sur Supprimer l'enregistrement.
- Lisez le message, puis appuyez sur OK.
- Assurez-vous que l'application affiche "Identifiant enregistré supprimé."
ATTENTION : Vous ne pouvez pas annuler une suppression. Pour utiliser l'identifiant à nouveau, saisissez-le et enregistrez-le à nouveau.
Sources de jeux de données¶
La section Sources de jeux de données indique à l'application où lire chacun des 6 jeux de données : Surface des pixels, Forêts naturelles SBTN, Couvert forestier mondial JRC 2020, Alertes de perturbation, Causes de la perte de couvert arboré et Année de perte de couvert arboré.
Confidentialité et coût de la lecture du bucket du WRI¶
La section commence par l'avis Confidentialité et coût de la lecture du bucket du WRI. L'avis vous indique ces faits :
-
Le WRI est la source des jeux de données. L'avis a un lien vers la page WRI Data Explorer.
-
Quand l'application lit un jeu de données depuis le bucket S3 du WRI, le WRI enregistre la requête dans ses journaux de stockage. Les journaux montrent les parties du jeu de données que l'application a demandées. Donc, les journaux peuvent montrer les zones que vous analysez. L'application n'envoie jamais les formes de vos emplacements.
-
Le bucket du WRI utilise le paiement par le demandeur. Chaque requête et chaque octet que l'application transfère sont facturés à votre compte AWS. Cela inclut chaque téléchargement.
AVERTISSEMENT : Toutes les lectures de données depuis le bucket du WRI sont facturées à votre compte AWS. L'application donne un coût d'environ $0.09 pour chaque GB vers un ordinateur en dehors d'AWS, plus de petits frais pour chaque lecture. Ce sont les prix publics d'AWS et ils peuvent changer.
Pour éviter ces lectures, téléchargez une copie de chaque jeu de données sur cet ordinateur. Après le téléchargement, les analyses ne lisent rien depuis le WRI.
Cartes des jeux de données¶
Chaque jeu de données a une carte. La carte affiche une ligne Utilisé :, un mot d'état et un bouton Modifier. La ligne Utilisé : vous indique ce que le jeu de données lit maintenant, par exemple "Utilisé : WRI en ligne, la plus récente — facturé à chaque analyse". Le mot d'état est À jour, Version plus récente disponible, Non vérifié ou Téléchargement….
Appuyez sur Voir les versions pour aller aux versions de ce jeu de données dans Versions des jeux de données et données locales.
Modifier la source d'un jeu de données¶
Quand vous appuyez sur Modifier, une boîte de dialogue s'ouvre. La première étape demande "D'où doit venir jeu de données ?". Vous pouvez sélectionner un de 3 choix :
| Choix | Ce qu'il fait |
|---|---|
| WRI en ligne, toujours la plus récente | Chaque analyse lit le jeu de données depuis le bucket du WRI. Chaque analyse est facturée à votre compte AWS. |
| Télécharger une copie sur cet ordinateur | L'application télécharge une copie. Vous payez une fois pour le transfert. Ensuite, les analyses lisent la copie sans coût. |
| Un dossier que j'ai déjà (avancé) | L'application lit un dossier zarr qui est déjà sur cet ordinateur. Elle n'écrit jamais dans ce dossier. |
L'application affiche Recommandé à côté du choix qui correspond à la fréquence de modification du jeu de données. L'application ne modifie pas la source elle-même.
Si aucune clé AWS n'a réussi la vérification, la boîte de dialogue ajoute l'étape Ajoutez votre clé AWS. Saisissez l'ID de clé d'accès et la Clé d'accès secrète, puis appuyez sur Vérifier cette clé. Vous ne pouvez pas appuyer sur Suivant tant que la clé n'a pas réussi la vérification.
Rien ne change tant que vous n'appuyez pas sur le dernier bouton de la boîte de dialogue. Pour arrêter, appuyez sur Annuler, sur × ou sur la touche Échap.
Télécharger une copie sur cet ordinateur¶
AVERTISSEMENT : Un téléchargement est facturé à votre compte AWS pour le transfert des données. Assurez-vous d'accepter le coût avant d'appuyer sur Lancer le téléchargement.
- Sur la carte du jeu de données, appuyez sur Modifier.
- Sélectionnez Télécharger une copie sur cet ordinateur.
- Appuyez sur Suivant.
- Si la boîte de dialogue demande "Quelle version de jeu de données ?", sélectionnez La plus récente (à télécharger) ou une copie qui est déjà sur cet ordinateur.
- Appuyez sur Suivant.
- Si la boîte de dialogue demande une clé AWS, saisissez la clé et appuyez sur Vérifier cette clé. Ensuite, appuyez sur Suivant.
- Dans Dossier de destination, saisissez un dossier ou appuyez sur Parcourir… pour sélectionner un dossier. Consultez Explorateur de dossiers.
- Assurez-vous que la boîte de dialogue n'affiche pas "Espace libre insuffisant pour ce jeu de données."
- Appuyez sur Suivant.
- Cochez la case Je comprends que ce téléchargement est facturé à mon compte AWS.
- Appuyez sur Lancer le téléchargement.
Si vous sélectionnez une copie qui est déjà sur cet ordinateur, la boîte de dialogue demande "Utiliser la copie du date ?". Appuyez sur Utiliser cette copie. Cette action ne fait pas de requête et ne coûte rien.
Tant que le téléchargement n'est pas terminé, les analyses continuent à lire le jeu de données depuis WRI en ligne. Quand le téléchargement est terminé, le jeu de données lit la copie locale.
Pendant un téléchargement, la carte affiche Mettre en pause, Reprendre et Arrêter. Mettre en pause garde les fichiers qui sont arrivés. Arrêter vous demande d'abord une confirmation. Si vous appuyez sur Arrêter et supprimer, l'application supprime la copie partielle, et le téléchargement suivant recommence sans fichiers. Appuyez sur Continuer le téléchargement pour continuer.
Explorateur de dossiers¶
Les champs Dossier de destination et Dossier ont une zone de texte et un bouton Parcourir…. Vous pouvez saisir un chemin de dossier complet dans la zone de texte.
- Appuyez sur Parcourir…. L'explorateur affiche les Racines de téléchargement approuvées.
- Sélectionnez un dossier pour l'ouvrir.
- Pour remonter d'un niveau, appuyez sur Remonter.
- Quand l'explorateur affiche le bon dossier, appuyez sur Utiliser ce dossier.
- Pour fermer l'explorateur sans modification, appuyez sur Fermer l'explorateur.
L'explorateur affiche uniquement des dossiers. Il n'affiche jamais de fichiers ni de dossiers en dehors d'une racine approuvée.
Les téléchargements vont uniquement dans les dossiers de datasets.download_roots du fichier de configuration. Dans l'image Docker, la racine de téléchargement par défaut est /data/datasets. Si aucune racine de téléchargement n'est configurée, l'explorateur affiche "Aucune racine de téléchargement n'est configurée sur ce serveur (datasets.download_roots) : rien ne peut être parcouru ni téléchargé."
Pour Un dossier que j'ai déjà (avancé), l'explorateur affiche aussi les dossiers de datasets.browse_roots avec l'étiquette "(lecture seule)". Vous pouvez aussi saisir un dossier en dehors des racines. L'application lit alors le dossier, mais n'écrit jamais dans ce dossier.
Sur un serveur dans WSL, l'application lit un chemin Windows comme D:\data sous la forme /mnt/d/data. Si ce lecteur n'est pas monté, l'application affiche "Ce lecteur n'est pas disponible sur ce serveur (il n'est pas monté)."
L'en-tête de Sources de jeux de données¶
-
Rechercher des mises à jour $ lit le manifeste du WRI et vous indique combien de jeux de données ont une version plus récente. C'est une requête sur le bucket du WRI. Donc, ce sont de petits frais sur votre compte AWS.
-
Tout mettre à jour télécharge la version plus récente de chaque jeu de données qui lit une copie locale. Avant le début du téléchargement, vous devez cocher la case Je comprends que ces téléchargements sont facturés à mon compte AWS.
-
Enregistrer cette configuration garde les choix actuels des jeux de données. Revenir à cette configuration remet une configuration enregistrée.
Avancé¶
Le panneau Avancé en bas de la section est pour les choix que la boîte de dialogue ne peut pas faire. Pour chaque jeu de données, il affiche Type de source, Emplacement, Paiement par le demandeur, Utiliser le chemin du manifeste $, Tester la connexion et Enregistrer la source.
ATTENTION : Utilisez le panneau Avancé uniquement si vous connaissez l'emplacement S3 du jeu de données. Un emplacement incorrect donne des résultats incorrects ou aucun résultat.
Paiement par le demandeur doit être activé pour le bucket du WRI. S'il est désactivé, l'application ne fait pas de requête facturée.
Tester la connexion dans le panneau Avancé ouvre le magasin du jeu de données. Cette action est facturée à votre compte AWS. Un résultat réussi commence par "Connexion réussie." Un résultat en échec commence par "Échec de la connexion :". Les raisons sont :
| Résultat | Ce qu'il vous indique |
|---|---|
| "Connexion réussie. ..." | Le jeu de données s'est ouvert et l'application peut le lire. |
| Paiement par le demandeur désactivé | L'identifiant est correct, mais Paiement par le demandeur est désactivé. Activez Paiement par le demandeur. |
| AWS a rejeté l'identifiant | La clé a été révoquée, est incorrecte ou n'a pas la permission. |
| Aucun identifiant AWS | Aucune clé AWS n'est disponible. Ajoutez une clé, puis enregistrez et testez à nouveau. |
| L'identifiant enregistré ne peut pas être lu | L'application ne peut pas déchiffrer la clé enregistrée. Saisissez à nouveau la clé et enregistrez. |
| Injoignable | Un problème de réseau ou de point de terminaison. Ce n'est pas un problème d'identifiant. |
| Pas un magasin Zarr | L'emplacement est correct, mais il n'a pas de magasin Zarr lisible. |
| Délai expiré | Le jeu de données n'a pas répondu dans le délai. |
| Emplacement introuvable | Il n'y a rien à cet emplacement. Appuyez sur Utiliser le chemin du manifeste $. |
| Région différente | Le bucket est dans une autre région. Modifiez datasets.upstream.region dans config.yaml. |
| AccessDenied | La clé est valide, mais ne peut pas lire ce bucket. Appuyez sur Vérifier les identifiants. |
| Autre erreur AWS | AWS a envoyé un autre code d'erreur. La ligne affiche le code. |
Versions des jeux de données et données locales¶
Cette section affiche chaque version datée de chaque jeu de données, l'endroit où l'application la garde et l'espace disque qu'elle utilise.
L'application garde 3 types de copie :
- Enregistrée automatiquement : l'application fait ces copies quand vous exécutez des listes. Elles comptent pour la Limite d'espace.
- Téléchargement complet : une copie que vous avez téléchargée dans Sources de jeux de données. L'application ne la supprime jamais.
- Votre propre copie : une copie dans un dossier que vous avez sélectionné. L'application ne la supprime jamais.
Pour modifier la limite d'espace, saisissez une valeur de 1 à 10000 dans Limite du cache automatique (Go), puis appuyez sur Enregistrer la limite. La valeur par défaut est 50 GB.
AVERTISSEMENT : Si la nouvelle limite est inférieure à l'espace utilisé, l'application supprime immédiatement les couches enregistrées plus anciennes. Si une exécution ultérieure a besoin d'une couche supprimée, l'application la télécharge à nouveau, et ce téléchargement est facturé à votre compte AWS.
Pour supprimer des copies, sélectionnez-les dans Versions par jeu de données, puis appuyez sur Supprimer la sélection. Lisez la liste dans la boîte de dialogue, puis appuyez sur Supprimer.
Visualisations de carte affiche l'espace disque que les données cartographiques stockées utilisent. Saisissez une valeur dans Limite (Go), puis appuyez sur Enregistrer la limite. L'application garde les cartes jusqu'à ce que vous les effaciez. Pour effacer les données cartographiques, utilisez Effacer pour les listes sélectionnées… ou Effacement complet de toutes les données cartographiques….
Mémoire¶
La section Mémoire règle la quantité de mémoire que l'application peut utiliser. Elle a 4 parties :
- 1. Environnement : Limite de mémoire de l'hôte / VM (Go). L'application trouve cette valeur quand elle fonctionne dans un conteneur. Pour régler une valeur plus basse, appuyez sur Remplacer. Pour revenir, appuyez sur Utiliser la valeur détectée.
- 2. Cette application : Réservé au système d'exploitation (Go) et Mémoire allouée à l'application (Go). La réserve par défaut est la plus grande des deux valeurs 3 GB et 10% de la limite de l'hôte. L'application affiche aussi un minimum recommandé. Tant que l'application n'a pas mesuré de valeur, le minimum est 2.0 GB.
- 3. Répartition de l'allocation : un tableau des parts. Vous ne pouvez pas modifier les parts sur cette page. Elles sont réglées dans
config.yaml(analysis.memory_shares) et s'appliquent après un redémarrage. - 4. Détail du rendu : Maximum de cellules en résolution native. C'est le nombre maximal de cellules qu'une vue en résolution native peut renvoyer.
Pour modifier les valeurs de mémoire :
- Saisissez les nouvelles valeurs.
- Assurez-vous que la section n'affiche pas d'erreur.
- Appuyez sur Appliquer.
Les valeurs s'appliquent immédiatement. Vous n'avez pas besoin de redémarrer l'application.
ATTENTION : Si Mémoire allouée à l'application (Go) est inférieure au minimum recommandé, une analyse peut échouer. L'application affiche un avertissement, mais elle vous permet d'appliquer la valeur.
Langue¶
Le sélecteur de langue est dans la barre supérieure, à droite de ⚙ Paramètres. Il a ces langues : English (en), Español (es), Français (fr), Bahasa Indonesia (id) et Português (pt).
- Appuyez sur le sélecteur de langue.
- Sélectionnez une langue.
L'application change de langue immédiatement. Le navigateur garde votre sélection pour la visite suivante.
REMARQUE : Ce guide de l'utilisateur est aussi disponible dans les autres langues de l'application : English, Español, Bahasa Indonesia et Português. Utilisez le guide dans la langue que vous sélectionnez, pour que les étiquettes du guide soient les mêmes que les étiquettes de votre écran.
Le fichier de configuration¶
Le fichier de configuration contient les paramètres que la page Paramètres ne peut pas modifier. Dans l'image Docker, le fichier est /data/config.yaml. La variable d'environnement LUC_ANALYTICS_CONFIG peut donner un autre chemin.
Quand le conteneur démarre pour la première fois, il crée /data/config.yaml à partir de config.example.yaml. Il active les téléversements et règle la racine de téléchargement sur /data/datasets. Le fichier active aussi le fournisseur Copernicus. Consultez Le fond de carte Sentinel-2. Le conteneur ne modifie jamais un fichier de configuration qui existe.
config.example.yaml donne chaque clé avec sa valeur par défaut. Dans l'image Docker, /data/config.yaml est une copie complète de ce fichier, et l'application lit uniquement /data/config.yaml. Si vous supprimez une clé de ce fichier, l'application utilise la valeur par défaut du code du programme. Cette valeur peut être différente de la valeur de config.example.yaml. Par exemple, la valeur par défaut de maps.cdse_enabled dans le programme est false.
REMARQUE : Si vous démarrez l'application sans Docker, avec un fichier qui a le nom config.yaml, l'application lit d'abord config.example.yaml. Les valeurs de config.yaml remplacent ensuite les valeurs de config.example.yaml. Nous recommandons que ce config.yaml contienne uniquement les clés que vous modifiez.
Ces clés ont une relation avec la page Paramètres :
| Clé | Ce qu'elle contrôle |
|---|---|
datasets.download_roots |
Les dossiers dans lesquels les téléchargements peuvent aller. Une liste vide arrête tous les téléchargements. |
datasets.browse_roots |
D'autres dossiers que l'explorateur de dossiers affiche. L'application lit uniquement ces dossiers. |
datasets.upstream.region, datasets.upstream.regions |
La région AWS des sources S3. Le bucket du WRI est dans us-east-1. |
datasets.upstream.cadence |
La fréquence de modification de chaque jeu de données. Cette clé règle le choix Recommandé. |
datasets.cost_model |
Les prix que l'application utilise pour calculer le coût des lectures S3. |
datasets.zarr_store.max_gb |
La limite du cache automatique (live ; valeur par défaut 50). |
viz.grid_store_max_gb |
La limite des visualisations de carte (live ; valeur par défaut 2.0). |
analysis.memory_budget_gb |
La mémoire allouée à l'application (live ; valeur par défaut 1.5). |
analysis.memory_shares |
Les parts de l'allocation de mémoire. |
analysis.zoom_adaptive.max_cells_ceiling |
Maximum de cellules en résolution native (live ; valeur par défaut 200000). |
security.* |
La clé maîtresse, le dossier du magasin de secrets, le dossier des secrets Docker et les noms du Gestionnaire d'identification. |
maps.* |
Les fournisseurs de fonds de carte, par exemple maps.cdse_enabled. |
ingest.upload_enabled |
Les téléversements activés ou désactivés. |
Une clé avec le mot "live" dans le tableau peut aussi changer sur la page Paramètres. La page enregistre la valeur dans le fichier de surcharge d'exécution (runtime.overlay_path, valeur par défaut ./data/runtime-overlay.yaml). Dans l'image Docker, ce fichier est /data/data/runtime-overlay.yaml. Une valeur du fichier de surcharge d'exécution a la priorité sur la même clé de config.yaml. Toutes les autres clés s'appliquent uniquement après un redémarrage.
Modifier le fichier de configuration dans Docker¶
Le fichier /data/config.yaml est dans le volume Docker, pas sur votre ordinateur. Pour le modifier, copiez-le hors du conteneur, modifiez la copie, puis copiez-la à nouveau dans le conteneur. Ces étapes utilisent le nom de conteneur luc-analytics de Installer et démarrer l'application.
AVERTISSEMENT : N'écrivez pas d'identifiants dans config.yaml. L'application ne lit pas les identifiants depuis le fichier de configuration. Utilisez la section Identifiants, les variables d'environnement, les secrets Docker ou le Gestionnaire d'identification Windows.
ATTENTION : Ne modifiez pas à la main le fichier de surcharge d'exécution. S'il contient une clé qui n'est pas autorisée, l'application ignore le fichier complet.
- Ouvrez un terminal dans un dossier de votre ordinateur.
- Copiez le fichier hors du conteneur :
docker cp luc-analytics:/data/config.yaml config.yaml
- Faites une deuxième copie de
config.yamlavec le nomconfig.yaml.bak. Gardez-la pour la remettre en place si la modification échoue. - Ouvrez
config.yamldans un éditeur de texte. - Trouvez la clé dans
config.example.yamlet copiez son nom exactement. Pour lireconfig.example.yaml, saisissezdocker exec luc-analytics cat /app/config.example.yaml. - Modifiez la valeur. Gardez l'indentation de la structure YAML.
- Enregistrez le fichier.
- Copiez le fichier à nouveau dans le conteneur :
docker cp config.yaml luc-analytics:/data/config.yaml
- Redémarrez le conteneur :
docker restart luc-analytics
- Saisissez
docker logs luc-analyticset lisez le journal. Si un nom de clé est incorrect, le journal affiche un avertissement avec le nom complet de la clé.
REMARQUE : docker cp fait de l'utilisateur root le propriétaire du fichier copié. L'application fonctionne avec l'utilisateur 10001, et elle lit uniquement /data/config.yaml. Donc, vous n'avez pas besoin de changer le propriétaire du fichier.
ATTENTION : Une clé inconnue sous security arrête le chargement de la configuration. Si l'application ne démarre pas après une modification, copiez config.yaml.bak à nouveau dans le conteneur avec docker cp, puis redémarrez le conteneur.