Ce guide décrit la nouvelle console d'administration AWS Wickr, publiée le 13 mars 2025. Pour obtenir de la documentation sur la version classique de la console d'administration AWS Wickr, consultez le [Guide d'administration classique](https://docs.aws.amazon.com/wickr/latest/adminguide-classic/what-is-wickr.html).
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Conservation des données pour AWS Wickr
La conservation des données AWS Wickr permet de conserver toutes les conversations sur le réseau. Cela inclut les conversations par message direct et les conversations dans des groupes ou des salles entre les membres du réseau (internes) et ceux avec d'autres équipes (externes) avec lesquelles votre réseau est fédéré. La conservation des données n'est disponible que pour les utilisateurs du plan AWS Wickr Premium et les clients professionnels qui optent pour la conservation des données. Pour plus d'informations sur le plan Premium, consultez les tarifs de [Wickr](https://aws.amazon.com/wickr/pricing/)
Lorsqu'un administrateur réseau configure et active la conservation des données pour son réseau, tous les messages et fichiers partagés sur son réseau sont conservés conformément aux politiques de conformité de l'organisation. Ces sorties de fichiers .txt sont accessibles par l'administrateur réseau depuis un emplacement externe (par exemple : stockage local, compartiment Amazon S3 ou tout autre stockage selon le choix de l'utilisateur), d'où elles peuvent être analysées, effacées ou transférées.
**Note**
Wickr n'accède jamais à vos messages et à vos fichiers. Il est donc de votre responsabilité de configurer un système de conservation des données.
**Topics**
+ [
# Afficher les détails relatifs à la conservation des données dans AWS Wickr
](view-data-retention-details.md)
+ [
# Configuration de la conservation des données pour AWS Wickr
](configure-data-retention.md)
+ [
# Obtenez les journaux de conservation des données pour votre réseau Wickr
](getting-data-retention-logs.md)
+ [
# Mesures et événements de conservation des données pour votre réseau Wickr
](metrics-events.md)
# Afficher les détails relatifs à la conservation des données dans AWS Wickr
Suivez la procédure suivante pour consulter les détails de conservation des données pour votre réseau Wickr. Vous pouvez également activer ou désactiver la conservation des données pour votre réseau Wickr.
1. Ouvrez le AWS Management Console pour Wickr à l'adresse [https://console.aws.amazon.com/wickr/](https://console.aws.amazon.com/wickr/).
1. Sur la page **Réseaux**, sélectionnez le nom du réseau pour accéder à ce réseau.
1. Dans le volet de navigation, sélectionnez **Network policies**.
1. La page **des politiques réseau** affiche les étapes de configuration de la conservation des données, ainsi que la possibilité d'activer ou de désactiver la fonctionnalité de conservation des données. Pour plus d'informations sur la configuration de la conservation des données, consultez[Configuration de la conservation des données pour AWS Wickr](configure-data-retention.md).
**Note**
Lorsque la conservation des données est activée, un message indiquant que la **conservation des données est activée** sera visible pour tous les utilisateurs de votre réseau pour les informer de l'existence du réseau activé.
# Configuration de la conservation des données pour AWS Wickr
Pour configurer la conservation des données pour votre réseau AWS Wickr, vous devez déployer l'image Docker du bot de conservation des données dans un conteneur sur un hôte, tel qu'un ordinateur local ou une instance dans Amazon Elastic Compute Cloud (Amazon EC2). Une fois le bot déployé, vous pouvez le configurer pour stocker les données localement ou dans un bucket Amazon Simple Storage Service (Amazon S3). Vous pouvez également configurer le bot de conservation des données pour utiliser d'autres AWS services tels que AWS Secrets Manager (Secrets Manager), Amazon CloudWatch (CloudWatch), Amazon Simple Notification Service (Amazon SNS) et (). AWS Key Management Service AWS KMS Les rubriques suivantes décrivent comment configurer et exécuter le bot de conservation des données pour votre réseau Wickr.
**Topics**
+ [
## Conditions préalables à la configuration de la conservation des données pour AWS Wickr
](#data-retention-prerequisites)
+ [
# Mot de passe pour le bot de conservation des données dans AWS Wickr
](data-retention-password.md)
+ [
# Options de stockage pour le réseau AWS Wickr
](data-retention-storage-options.md)
+ [
# Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr
](data-retention-bot-env-variables.md)
+ [
# Les valeurs de Secrets Manager pour AWS Wickr
](data-retention-aws-secret-values.md)
+ [
# Politique IAM pour utiliser la conservation des données avec les services AWS
](data-retention-aws-services.md)
+ [
# Démarrez le bot de conservation des données pour votre réseau Wickr
](starting-data-retention-bot.md)
+ [
# Arrêtez le bot de conservation des données pour votre réseau Wickr
](stopping-data-retention-bot.md)
## Conditions préalables à la configuration de la conservation des données pour AWS Wickr
Avant de commencer, vous devez obtenir le nom du bot de conservation des données (étiqueté comme nom **d'utilisateur**) et le mot de passe initial auprès de AWS Management Console for Wickr. Vous devez spécifier ces deux valeurs la première fois que vous démarrez le bot de conservation des données. Vous devez également activer la conservation des données dans la console. Pour de plus amples informations, veuillez consulter [Afficher les détails relatifs à la conservation des données dans AWS Wickr](view-data-retention-details.md).
# Mot de passe pour le bot de conservation des données dans AWS Wickr
La première fois que vous démarrez le bot de conservation des données, vous spécifiez le mot de passe initial à l'aide de l'une des options suivantes :
+ Variable d’environnement `WICKRIO_BOT_PASSWORD`. Les variables d'environnement du bot de conservation des données sont décrites dans la [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md) section suivante de ce guide.
+ La valeur du **mot de passe** dans Secrets Manager identifiée par la variable d'`AWS_SECRET_NAME`environnement. Les valeurs de Secrets Manager pour le bot de conservation des données sont décrites dans la [Les valeurs de Secrets Manager pour AWS Wickr](data-retention-aws-secret-values.md) section suivante de ce guide.
+ Entrez le mot de passe lorsque le bot de conservation des données vous le demande. Vous devrez exécuter le bot de conservation des données avec un accès TTY interactif à l'aide de l'`-ti`option.
Un nouveau mot de passe sera généré lorsque vous configurerez le bot de conservation des données pour la première fois. Si vous devez réinstaller le bot de conservation des données, vous devez utiliser le mot de passe généré. Le mot de passe initial n'est pas valide après l'installation initiale du bot de conservation des données.
Le nouveau mot de passe généré sera affiché comme indiqué dans l'exemple suivant.
**Important**
Conservez le mot de passe en lieu sûr. Si vous perdez le mot de passe, vous ne pourrez pas réinstaller le bot de conservation des données. Ne partagez pas ce mot de passe. Il permet de démarrer la conservation des données pour votre réseau Wickr.
```
********************************************************************
**** GENERATED PASSWORD
**** DO NOT LOSE THIS PASSWORD, YOU WILL NEED TO ENTER IT EVERY TIME
**** TO START THE BOT
"HuEXAMPLERAW4lGgEXAMPLEn"
********************************************************************
```
# Options de stockage pour le réseau AWS Wickr
Une fois la conservation des données activée et le bot de conservation des données configuré pour votre réseau Wickr, il capturera tous les messages et fichiers envoyés sur votre réseau. Les messages sont enregistrés dans des fichiers limités à une taille ou à une durée spécifiques qui peuvent être configurées à l'aide d'une variable d'environnement. Pour de plus amples informations, veuillez consulter [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md).
Vous pouvez configurer l'une des options suivantes pour stocker ces données :
+ Stockez tous les messages et fichiers capturés localement. Il s’agit de l’option par défaut. Il est de votre responsabilité de déplacer les fichiers locaux vers un autre système pour un stockage à long terme et de vous assurer que le disque hôte ne manque pas de mémoire ou d'espace.
+ Stockez tous les messages et fichiers capturés dans un compartiment Amazon S3. Le bot de conservation des données enregistre tous les messages et fichiers déchiffrés dans le compartiment Amazon S3 que vous spécifiez. Les messages et fichiers capturés sont supprimés de la machine hôte une fois qu'ils ont été correctement enregistrés dans le compartiment.
+ Stockez tous les messages et fichiers capturés chiffrés dans un compartiment Amazon S3. Le bot de conservation des données chiffre à nouveau tous les messages et fichiers capturés à l'aide d'une clé que vous fournissez et les enregistre dans le compartiment Amazon S3 que vous spécifiez. Les messages et fichiers capturés sont supprimés de la machine hôte une fois qu'ils ont été correctement rechiffrés et enregistrés dans le compartiment. Vous aurez besoin d'un logiciel pour déchiffrer les messages et les fichiers.
Pour plus d'informations sur la création d'un compartiment Amazon S3 à utiliser avec votre bot de conservation des données, consultez la section [Création d'un compartiment](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) dans le *guide de l'utilisateur Amazon S3*
# Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr
Vous pouvez utiliser les variables d'environnement suivantes pour configurer le bot de conservation des données. Vous définissez ces variables d'environnement à l'aide de l'`-e`option lorsque vous exécutez l'image Docker du bot de conservation des données. Pour de plus amples informations, veuillez consulter [Démarrez le bot de conservation des données pour votre réseau Wickr](starting-data-retention-bot.md).
**Note**
Ces variables d'environnement sont facultatives, sauf indication contraire.
Utilisez les variables d'environnement suivantes pour spécifier les informations d'identification du bot de conservation des données :
+ `WICKRIO_BOT_NAME`— Le nom du bot de conservation des données. Cette variable est *obligatoire* lorsque vous exécutez l'image Docker du bot de conservation des données.
+ `WICKRIO_BOT_PASSWORD`— Le mot de passe initial du bot de conservation des données. Pour de plus amples informations, veuillez consulter [Conditions préalables à la configuration de la conservation des données pour AWS Wickr](configure-data-retention.md#data-retention-prerequisites). Cette variable est *obligatoire* si vous ne prévoyez pas de démarrer le bot de conservation des données en demandant un mot de passe ou si vous ne prévoyez pas d'utiliser Secrets Manager pour stocker les informations d'identification du bot de conservation des données.
Utilisez les variables d'environnement suivantes pour configurer les fonctionnalités de streaming de conservation des données par défaut :
+ `WICKRIO_COMP_MESGDEST`— Le nom du chemin d'accès au répertoire dans lequel les messages seront diffusés. La valeur par défaut est `/tmp//compliance/messages`.
+ `WICKRIO_COMP_FILEDEST`— Le nom du chemin d'accès au répertoire dans lequel les fichiers seront diffusés. La valeur par défaut est `/tmp//compliance/attachments`.
+ `WICKRIO_COMP_BASENAME`— Le nom de base des fichiers de messages reçus. La valeur par défaut est `receivedMessages`.
+ `WICKRIO_COMP_FILESIZE`— La taille maximale d'un fichier de messages reçus en kibioctet (KiB). Un nouveau fichier est lancé lorsque la taille maximale est atteinte. La valeur par défaut est`1000000000`, comme dans 1024 GiB.
+ `WICKRIO_COMP_TIMEROTATE`— Durée, en minutes, pendant laquelle le bot de conservation des données insère les messages reçus dans un fichier de messages reçus. Un nouveau fichier est lancé lorsque le délai est atteint. Vous ne pouvez utiliser la taille ou la durée du fichier que pour limiter la taille du fichier des messages reçus. La valeur par défaut est`0`, comme dans aucune limite.
Utilisez la variable d'environnement suivante pour définir la valeur par défaut Région AWS à utiliser.
+ `AWS_DEFAULT_REGION`— La valeur par défaut Région AWS à utiliser pour AWS des services tels que Secrets Manager (non utilisée pour Amazon S3 ou AWS KMS). La `us-east-1` région est utilisée par défaut si cette variable d'environnement n'est pas définie.
Utilisez les variables d'environnement suivantes pour spécifier le secret Secrets Manager à utiliser lorsque vous choisissez d'utiliser Secrets Manager pour stocker les informations d'identification et les informations de AWS service du bot de conservation des données. Pour plus d'informations sur les valeurs que vous pouvez stocker dans Secrets Manager, consultez[Les valeurs de Secrets Manager pour AWS Wickr](data-retention-aws-secret-values.md).
+ `AWS_SECRET_NAME`— Le nom du secret Secrets Manager qui contient les informations d'identification et AWS de service nécessaires au bot de conservation des données.
+ `AWS_SECRET_REGION`— L' Région AWS endroit où se trouve le AWS secret. Si vous utilisez des AWS secrets et que cette valeur n'est pas définie, la `AWS_DEFAULT_REGION` valeur sera utilisée.
**Note**
Vous pouvez stocker toutes les variables d'environnement suivantes sous forme de valeurs dans Secrets Manager. Si vous choisissez d'utiliser Secrets Manager et que vous y stockez ces valeurs, vous n'avez pas besoin de les spécifier en tant que variables d'environnement lorsque vous exécutez l'image Docker du bot de conservation des données. Il vous suffit de spécifier la variable d'`AWS_SECRET_NAME`environnement décrite plus haut dans ce guide. Pour de plus amples informations, veuillez consulter [Les valeurs de Secrets Manager pour AWS Wickr](data-retention-aws-secret-values.md).
Utilisez les variables d'environnement suivantes pour spécifier le compartiment Amazon S3 lorsque vous choisissez de stocker des messages et des fichiers dans un compartiment.
+ `WICKRIO_S3_BUCKET_NAME`— Le nom du compartiment Amazon S3 dans lequel les messages et les fichiers seront stockés.
+ `WICKRIO_S3_REGION`— La AWS région du compartiment Amazon S3 dans laquelle les messages et les fichiers seront stockés.
+ `WICKRIO_S3_FOLDER_NAME`— Le nom du dossier facultatif dans le compartiment Amazon S3 où les messages et les fichiers seront stockés. Ce nom de dossier sera précédé de la clé pour les messages et les fichiers enregistrés dans le compartiment Amazon S3.
Utilisez les variables d'environnement suivantes pour spécifier les AWS KMS détails lorsque vous choisissez d'utiliser le chiffrement côté client pour rechiffrer les fichiers lorsque vous les enregistrez dans un compartiment Amazon S3.
+ `WICKRIO_KMS_MSTRKEY_ARN`— Le nom de ressource Amazon (ARN) de la clé AWS KMS principale utilisée pour rechiffrer les fichiers de messages et les fichiers sur le bot de conservation des données avant qu'ils ne soient enregistrés dans le compartiment Amazon S3.
+ `WICKRIO_KMS_REGION`— La AWS région où se trouve la clé AWS KMS principale.
Utilisez la variable d'environnement suivante pour spécifier les détails d'Amazon SNS lorsque vous choisissez d'envoyer des événements de rétention de données à une rubrique Amazon SNS. Les événements envoyés incluent le démarrage, l'arrêt, ainsi que les conditions d'erreur.
+ `WICKRIO_SNS_TOPIC_ARN`— L'ARN de la rubrique Amazon SNS à laquelle vous souhaitez que les événements de conservation des données soient envoyés.
Utilisez la variable d'environnement suivante pour envoyer les métriques de conservation des données à CloudWatch. Si cela est spécifié, les métriques seront générées toutes les 60 secondes.
+ `WICKRIO_METRICS_TYPE`— Définissez la valeur de cette variable d'environnement `cloudwatch` à laquelle envoyer les métriques CloudWatch.
# Les valeurs de Secrets Manager pour AWS Wickr
Vous pouvez utiliser Secrets Manager pour stocker les informations d'identification du bot de conservation des données et les informations AWS de service. Pour plus d'informations sur la création d'un secret Secrets Manager, voir [Création d'un AWS Secrets Manager secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) dans le *Guide de l'utilisateur de Secrets Manager*.
Le secret Secrets Manager peut avoir les valeurs suivantes :
+ `password`— Le mot de passe du bot de conservation des données.
+ `s3_bucket_name`— Le nom du compartiment Amazon S3 dans lequel les messages et les fichiers seront stockés. Si ce n'est pas le cas, le streaming de fichiers par défaut sera utilisé.
+ `s3_region`— La AWS région du compartiment Amazon S3 dans laquelle les messages et les fichiers seront stockés.
+ `s3_folder_name`— Le nom du dossier facultatif dans le compartiment Amazon S3 où les messages et les fichiers seront stockés. Ce nom de dossier sera précédé de la clé pour les messages et les fichiers enregistrés dans le compartiment Amazon S3.
+ `kms_master_key_arn`— L'ARN de la clé AWS KMS principale utilisée pour rechiffrer les fichiers de messages et les fichiers sur le bot de conservation des données avant leur enregistrement dans le compartiment Amazon S3.
+ `kms_region`— La AWS région où se trouve la clé AWS KMS principale.
+ `sns_topic_arn`— L'ARN de la rubrique Amazon SNS à laquelle vous souhaitez que les événements de conservation des données soient envoyés.
# Politique IAM pour utiliser la conservation des données avec les services AWS
Si vous envisagez d'utiliser d'autres AWS services avec le bot de conservation des données Wickr, vous devez vous assurer que l'hôte dispose du rôle et de la politique Gestion des identités et des accès AWS (IAM) appropriés pour y accéder. Vous pouvez configurer le bot de conservation des données pour utiliser Secrets Manager, Amazon S3 CloudWatch, Amazon SNS et. AWS KMS La politique IAM suivante permet d'accéder à des actions spécifiques pour ces services.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"secretsmanager:GetSecretValue",
"sns:Publish",
"cloudwatch:PutMetricData",
"kms:GenerateDataKey"
],
"Resource": "*"
}
]
}
```
------
Vous pouvez créer une politique IAM plus stricte en identifiant les objets spécifiques pour chaque service auxquels vous souhaitez autoriser les conteneurs de votre hôte à accéder. Supprimez les actions relatives aux AWS services que vous n'avez pas l'intention d'utiliser. Par exemple, si vous avez l'intention de n'utiliser qu'un compartiment Amazon S3, appliquez la politique suivante, qui supprime les `cloudwatch:PutMetricData` actions `secretsmanager:GetSecretValue` `sns:Publish``kms:GenerateDataKey`,, et.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "s3:PutObject",
"Resource": "*"
}
]
}
```
------
Si vous utilisez une instance Amazon Elastic Compute Cloud (Amazon EC2) pour héberger votre bot de conservation des données, créez un rôle IAM en utilisant le cas courant Amazon EC2 et attribuez une politique en utilisant la définition de politique ci-dessus.
# Démarrez le bot de conservation des données pour votre réseau Wickr
Avant d'exécuter le bot de conservation des données, vous devez déterminer comment vous souhaitez le configurer. Si vous envisagez d'exécuter le bot sur un hôte qui :
+ Vous n'aurez pas accès aux AWS services, vos options sont alors limitées. Dans ce cas, vous utiliserez les options de diffusion de messages par défaut. Vous devez décider si vous souhaitez limiter la taille des fichiers de messages capturés à une taille ou à un intervalle de temps spécifiques. Pour de plus amples informations, veuillez consulter [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md).
+ Si vous aurez accès aux AWS services, vous devez créer un secret Secrets Manager pour stocker les informations d'identification du bot et les détails de configuration des AWS services. Une fois les AWS services configurés, vous pouvez démarrer l'image Docker du bot de conservation des données. Pour plus d'informations sur les informations que vous pouvez stocker dans un secret de Secrets Manager, voir [Les valeurs de Secrets Manager pour AWS Wickr](data-retention-aws-secret-values.md)
Les sections suivantes présentent des exemples de commandes permettant d'exécuter l'image Docker du bot de conservation des données. Dans chacun des exemples de commandes, remplacez les valeurs d'exemple suivantes par les vôtres :
+ `compliance_1234567890_bot`avec le nom de votre robot de conservation des données.
+ `password`avec le mot de passe de votre robot de conservation des données.
+ `wickr/data/retention/bot`avec le nom de votre secret Secrets Manager à utiliser avec votre bot de conservation des données.
+ `bucket-name`avec le nom du compartiment Amazon S3 dans lequel les messages et les fichiers seront stockés.
+ `folder-name`avec le nom du dossier dans le compartiment Amazon S3 dans lequel les messages et les fichiers seront stockés.
+ `us-east-1`avec la AWS région de la ressource que vous spécifiez. Par exemple, la région de la clé AWS KMS principale ou la région du compartiment Amazon S3.
+ `arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab`avec l'Amazon Resource Name (ARN) de votre clé AWS KMS principale à utiliser pour rechiffrer les fichiers de messages et les fichiers.
# Démarrez le bot avec une variable d'environnement de mot de passe (aucun AWS service)
La commande Docker suivante démarre le bot de conservation des données. Le mot de passe est spécifié à l'aide de la variable d'`WICKRIO_BOT_PASSWORD`environnement. Le bot commence à utiliser le streaming de fichiers par défaut et les valeurs par défaut définies dans la [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md) section de ce guide.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
wickr/bot-compliance-cloud:latest
```
# Démarrez le bot avec une demande de mot de passe (aucun AWS service)
La commande Docker suivante démarre le bot de conservation des données. Le mot de passe est saisi lorsque le bot de conservation des données vous le demande. Il commencera à utiliser le streaming de fichiers par défaut en utilisant les valeurs par défaut définies dans la [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md) section de ce guide.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
docker attach compliance_1234567890_bot
.
.
.
Enter the password:************
Re-enter the password:************
```
Exécutez le bot à l'aide de l'`-ti`option permettant de recevoir l'invite de mot de passe. Vous devez également exécuter la `docker attach ` commande immédiatement après le démarrage de l'image docker afin de recevoir l'invite de mot de passe. Vous devez exécuter ces deux commandes dans un script. Si vous joignez l'image du docker et que vous ne voyez pas l'invite, appuyez sur **Entrée** pour afficher l'invite.
# Démarrez le bot avec une rotation des fichiers de messages de 15 minutes (aucun AWS service)
La commande Docker suivante démarre le bot de conservation des données à l'aide de variables d'environnement. Il le configure également pour faire pivoter les fichiers de messages reçus à 15 minutes.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_COMP_TIMEROTATE=15 \
wickr/bot-compliance-cloud:latest
```
# Démarrez le bot et spécifiez le mot de passe initial avec Secrets Manager
Vous pouvez utiliser le Secrets Manager pour identifier le mot de passe du bot de conservation des données. Lorsque vous démarrez le bot de conservation des données, vous devez définir une variable d'environnement qui indique le Secrets Manager dans lequel ces informations sont stockées.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/new-3-bot' \
wickr/bot-compliance-cloud:latest
```
Le `wickrpro/compliance/compliance_1234567890_bot` secret contient la valeur secrète suivante, affichée sous forme de texte brut.
```
{
"password":"password"
}
```
# Démarrez le bot et configurez Amazon S3 avec Secrets Manager
Vous pouvez utiliser le Secrets Manager pour héberger les informations d'identification et les informations du compartiment Amazon S3. Lorsque vous démarrez le bot de conservation des données, vous devez définir une variable d'environnement qui indique le Secrets Manager dans lequel ces informations sont stockées.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
Le `wickrpro/compliance/compliance_1234567890_bot` secret contient la valeur secrète suivante, affichée sous forme de texte brut.
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name"
}
```
Les messages et les fichiers reçus par le bot seront placés dans le `bot-compliance` compartiment du dossier nommé`network1234567890`.
# Démarrez le bot et configurez Amazon S3 et AWS KMS avec Secrets Manager
Vous pouvez utiliser le Secrets Manager pour héberger les informations d'identification, le compartiment Amazon S3 et les informations relatives à la clé AWS KMS principale. Lorsque vous démarrez le bot de conservation des données, vous devez définir une variable d'environnement qui indique le Secrets Manager dans lequel ces informations sont stockées.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
Le `wickrpro/compliance/compliance_1234567890_bot` secret contient la valeur secrète suivante, affichée sous forme de texte brut.
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name",
"kms_master_key_arn":"arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab",
"kms_region":"us-east-1"
}
```
Les messages et les fichiers reçus par le bot seront chiffrés à l'aide de la clé KMS identifiée par la valeur ARN, puis placés dans le compartiment « bot-compliance » dans le dossier nommé « network1234567890 ». Assurez-vous de disposer de la configuration de politique IAM appropriée.
# Démarrez le bot et configurez Amazon S3 à l'aide de variables d'environnement
Si vous ne souhaitez pas utiliser Secrets Manager pour héberger les informations d'identification du bot de conservation des données, vous pouvez démarrer l'image Docker du bot de conservation des données avec les variables d'environnement suivantes. Vous devez identifier le nom du bot de conservation des données à l'aide de la variable d'`WICKRIO_BOT_NAME`environnement.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_S3_BUCKET_NAME='bot-compliance' \
-e WICKRIO_S3_FOLDER_NAME='network1234567890' \
-e WICKRIO_S3_REGION='us-east-1' \
wickr/bot-compliance-cloud:latest
```
Vous pouvez utiliser les valeurs d'environnement pour identifier les informations d'identification du bot de conservation des données, les informations sur les compartiments Amazon S3 et les informations de configuration pour le streaming de fichiers par défaut.
# Arrêtez le bot de conservation des données pour votre réseau Wickr
Le logiciel exécuté sur le bot de conservation des données capturera les `SIGTERM` signaux et s'arrêtera harmonieusement. Utilisez la `docker stop ` commande, comme indiqué dans l'exemple suivant, pour envoyer la `SIGTERM` commande à l'image Docker du bot de conservation des données.
```
docker stop compliance_1234567890_bot
```
# Obtenez les journaux de conservation des données pour votre réseau Wickr
Le logiciel exécuté sur l'image Docker du bot de conservation des données sera affiché dans les fichiers journaux du `/tmp//logs` répertoire. Ils tourneront jusqu'à un maximum de 5 fichiers. Vous pouvez obtenir les journaux en exécutant la commande suivante.
```
docker logs
```
Exemple :
```
docker logs compliance_1234567890_bot
```
# Mesures et événements de conservation des données pour votre réseau Wickr
Vous trouverez ci-dessous les métriques Amazon CloudWatch (CloudWatch) et les événements Amazon Simple Notification Service (Amazon SNS) actuellement pris en charge par la version 5.116 du bot de conservation des données AWS Wickr.
**Topics**
+ [
# CloudWatch métriques pour votre réseau Wickr
](cloudwatch-metrics.md)
+ [
# Événements Amazon SNS pour votre réseau Wickr
](sns-events.md)
# CloudWatch métriques pour votre réseau Wickr
Les métriques sont générées par le bot à intervalles d'une minute et transmises au CloudWatch service associé au compte sur lequel l'image Docker du bot de conservation des données est exécutée.
Vous trouverez ci-dessous les mesures existantes prises en charge par le bot de conservation des données.
| Métrique | Description |
| --- | --- |
| Messages\$1Rx | Messages reçus. |
| Messages\$1Rx\$1Failed | Échec du traitement des messages reçus. |
| Messages enregistrés | Messages enregistrés dans le fichier des messages reçus. |
| Messages\$1enregistrés\$1échoués | Impossible d'enregistrer les messages dans le fichier des messages reçus. |
| Fichiers\$1enregistrés | Fichiers reçus. |
| Fichiers\$1enregistrés\$1octets | Nombre d'octets pour les fichiers reçus. |
| Les fichiers enregistrés ont échoué | Échec de l'enregistrement des fichiers. |
| Connexions | Connexions (normalement, ce sera 1 pour chaque intervalle). |
| Échecs de connexion | Échec de connexion (normalement, ce sera 1 pour chaque intervalle). |
| S3\$1Post\$1Errors | Erreurs lors de la publication de fichiers de messages et de fichiers dans le compartiment Amazon S3. |
| Watchdog\$1Failures | Défaillances de Watchdog. |
| Watchdog\$1Warnings | Avertissements de Watchdog. |
Les métriques sont générées pour être consommées par CloudWatch. L'espace de noms utilisé pour les robots est`WickrIO`. Chaque métrique possède un ensemble de dimensions. Vous trouverez ci-dessous la liste des dimensions publiées avec les statistiques ci-dessus.
| Dimension | Value |
| --- | --- |
| Id | Le nom d'utilisateur du bot. |
| Appareil | Description d'un appareil ou d'une instance de bot spécifique. Utile si vous utilisez plusieurs appareils ou instances de bot. |
| Produit (langue française non garantie) | Le produit pour le bot. Peut être `WickrPro_` ou `WickrEnterprise_` avec `Alpha``Beta`, ou `Production` ajouté. |
| BotType | Le type de bot. Labellisé **Conformité** pour les robots de conformité. |
| Réseau | L'ID du réseau associé. |
# Événements Amazon SNS pour votre réseau Wickr
Les événements suivants sont publiés dans la rubrique Amazon SNS définie par la valeur Amazon Resource Name (ARN) identifiée à l'aide de la variable d'`WICKRIO_SNS_TOPIC_ARN`environnement ou de la valeur secrète de `sns_topic_arn` Secrets Manager. Pour plus d’informations, consultez [Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr](data-retention-bot-env-variables.md) et [Les valeurs de Secrets Manager pour AWS Wickr](data-retention-aws-secret-values.md).
Les événements générés par le bot de conservation des données sont envoyés sous forme de chaînes JSON. Les valeurs suivantes sont incluses dans les événements à partir de la version 5.116 du bot de conservation des données.
| Nom | Value |
| --- | --- |
| Bot de conformité | Le nom d'utilisateur du bot de conservation des données. |
| Heure des données | Date et heure auxquelles l'événement s'est produit. |
| device | Description de l'appareil ou de l'instance de bot spécifique. Utile si vous exécutez plusieurs instances de bot. |
| Image Docker | L'image Docker associée au bot. |
| Tag Docker | Le tag ou la version de l'image Docker. |
| message | Le message de l'événement. Pour plus d’informations, consultez [Evénements critiques](#sns-critical-events) et [Événements normaux](#sns-normal-events). |
| notificationType | Cette valeur sera`Bot Event`. |
| severity | La gravité de l'événement. Peut être `normal` ou `critical`. |
Vous devez vous abonner à la rubrique Amazon SNS pour pouvoir recevoir les événements. Si vous vous abonnez à l'aide d'une adresse e-mail, un e-mail contenant des informations similaires à celles de l'exemple suivant vous sera envoyé.
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:39",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "Logged in",
"notificationType": "Bot Event",
"severity": "normal"
}
```
## Evénements critiques
Ces événements provoqueront l'arrêt ou le redémarrage du bot. Le nombre de redémarrages est limité afin d'éviter de provoquer d'autres problèmes.
**Échecs de connexion**
Voici les événements possibles qui peuvent être générés lorsque le bot ne parvient pas à se connecter. Chaque message indiquera la raison de l'échec de connexion.
| Type d’événement | Message d’événement |
| --- | --- |
| échec de connexion | Mauvaises informations d'identification. Vérifiez le mot de passe. |
| échec de connexion | L'utilisateur n'a pas été trouvé. |
| échec de connexion | Le compte ou l'appareil est suspendu. |
| allocation | L'utilisateur a quitté la commande. |
| allocation | Mauvais mot de passe pour le `config.wickr` fichier. |
| allocation | Impossible de lire le `config.wickr` fichier. |
| échec de connexion | Toutes les connexions ont échoué. |
| échec de connexion | Nouvel utilisateur mais la base de données existe déjà. |
**Plus d'événements critiques**
| Type d’événement | Messages d'événements |
| --- | --- |
| Compte suspendu | Wickr IOClient Main : slotAdminUser Suspend : code (%1) : raison : %2 » |
| BotDevice Suspendu | L'appareil est suspendu \$1 |
| WatchDog | Le SwitchBoard système est en panne pendant plus de < *N* > minutes |
| Défaillances S3 | Impossible de placer le fichier < *file-name* ≫ dans le compartiment S3. Erreur : < *AWS-error* > |
| Clé de secours | CLÉ DE SECOURS SOUMISE PAR LE SERVEUR : Il ne s'agit pas d'une clé de secours active reconnue par le client. Veuillez envoyer les journaux à l'ingénierie de bureau. |
## Événements normaux
Vous trouverez ci-dessous les événements qui vous avertissent des événements de fonctionnement normaux. Un trop grand nombre d'événements de ce type au cours d'une période donnée peut être source de préoccupation.
**Appareil ajouté au compte**
Cet événement est généré lorsqu'un nouvel appareil est ajouté au compte du bot de conservation des données. Dans certaines circonstances, cela peut être une indication importante que quelqu'un a créé une instance du bot de conservation des données. Voici le message de cet événement.
```
A device has been added to this account!
```
**Bot connecté**
Cet événement est généré lorsque le bot s'est connecté avec succès. Voici le message de cet événement.
```
Logged in
```
**Arrêt**
Cet événement est généré lorsque le bot s'arrête. Si l'utilisateur ne l'a pas explicitement initié, cela peut être le signe d'un problème. Voici le message de cet événement.
```
Shutting down
```
**Mises à jour disponibles**
Cet événement est généré lorsque le bot de conservation des données est démarré et il indique qu'une version plus récente de l'image Docker associée est disponible. Cet événement est généré au démarrage du bot, et sur une base quotidienne. Cet événement inclut le champ du `versions` tableau qui identifie les nouvelles versions disponibles. Voici un exemple de ce à quoi ressemble cet événement.
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:55",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "There are updates available",
"notificationType": "Bot Event",
"severity": "normal",
"versions": [
"5.116.10.01"
]
}
```