Créer une sauvegarde ArcGIS Enterprise

Vous pouvez exporter les composants de votre déploiement ArcGIS Enterprise dans un fichier de sauvegarde qui peut ensuite servir à restaurer votre déploiement en cas de défaillance matérielle ou de perte de données. Le fichier comprend les éléments et paramètres de votre portail, les couches Web hébergées, les paramètres des serveurs fédérés et d’hébergement et, si vous utilisez ArcGIS Data Store, les données des couches d’entités hébergées et les caches des couches de scènes hébergées. La taille du fichier de sauvegarde et sa durée de création dépendent du nombre d’éléments présents dans votre portail, du nombre et du type de couches Web hébergées dont vous disposez, du nombre de serveurs fédérés que vous possédez et du nombre de machines ArcGIS Server présentes dans vos serveurs d’hébergement et fédérés. Lorsque vous sauvegardez un déploiement qui ne contient aucun service ou donnée, la taille du fichier généré est d'environ 400 Mo. Votre fichier aura toujours une taille supérieure à celle-ci.

Utilisez l'utilitaire webgisdr avec l'option d'exportation et un fichier de propriétés pour créer une sauvegarde de ArcGIS Enterprise. L’utilitaire se trouve dans le répertoire des outils Portal for ArcGIS. Les critères suivants doivent être remplis pour recourir à cet utilitaire :

• Le répertoire partagé que vous indiquez doit être d'une taille suffisante pour contenir le fichier exporté. Effectuez une exportation test de votre déploiement ArcGIS Enterprise pour avoir une idée de la taille du fichier, choisir le nombre de fichiers que vous voulez conserver dans le répertoire partagé et dimensionner le répertoire en fonction.
• Le compte qui a permis d’installer chaque composant logiciel dans ArcGIS Enterprise doit posséder des privilèges en lecture et en écriture sur le répertoire partagé.
• La sauvegarde de chaque composant est placée dans un répertoire temporaire sur la machine de chaque composant avant d'être déplacée vers le répertoire partagé spécifié. Par conséquent, les répertoires suivants doivent être d'une taille assez conséquente pour contenir la sauvegarde de chaque composant :
  • Portal for ArcGIS : <Portal_content_directory>/temp
  • ArcGIS Server : /<ArcGIS_Server_installation_directory>/temp
  • ArcGIS Data Store : <ArcGIS_Data_Store_directory>/temp
• Vous devez activer la récupération ponctuelle pour le répertoire de données relationnelles ArcGIS Data Store de votre déploiement ArcGIS Enterprise si vous prévoyez de créer des sauvegardes incrémentielles (BACKUP_RESTORE_MODE = incremental).

Procédez comme suit pour créer une sauvegarde de votre déploiement ArcGIS Enterprise :

1. Effectuez une copie du fichier de propriétés du modèle. Vous pouvez enregistrer la copie dans le même répertoire que le modèle ou dans un nouveau répertoire.

   Le fichier de propriétés du modèle (webgisdr.properties) est installé dans /arcgis/portal/tools/webgisdr par défaut.

   Dans cet exemple, la copie du fichier de propriétés se nomme mywebgis.properties et est enregistrée dans /home/ags/arcgis/portal/propfiles.

2. Ouvrez la copie du fichier de propriétés et modifiez-la pour inclure des informations propres à votre site.

   • PORTAL_ADMIN_URL = <URL du répertoire d’administration du portail>

     Spécifiez l’URL du répertoire d’administration Portal for ArcGIS. Utilisez le format https://portalhostname.domain.com:7443/arcgis, où portalhostname.domain.com est le nom complet de la machine où Portal for ArcGIS est installé.

   • PORTAL_ADMIN_USERNAME = <nom d’utilisateur de l’administrateur du portail>

     Spécifiez le nom d'utilisateur d'un membre du portail auquel le rôle Administrateur défini par Esri a été attribué.

   • PORTAL_ADMIN_PASSWORD = <mot de passe de l’administrateur du portail>

     Spécifiez le mot de passe du compte d'administrateur du portail.

   • PORTAL_ADMIN_PASSWORD_ENCRYPTED = <true | false>

     Définissez cette option sur false la première fois que vous renseignez le fichier avec votre mot de passe d’administrateur. Lors de l’enregistrement du fichier, votre mot de passe est chiffré et PORTAL_ADMIN_PASSWORD_ENCRYPTED est défini sur true pour indiquer que le mot de passe est chiffré. Si vous devez modifier le mot de passe ultérieurement, définissez PORTAL_ADMIN_PASSWORD_ENCRYPTED = false, indiquez votre nouveau mot de passe d’administrateur et enregistrez le fichier.

   • BACKUP_RESTORE_MODE = <full | incremental>

     Si vous créez uniquement des sauvegardes complètes, vous pouvez définir cette propriété sur full. Pour réduire la taille des sauvegardes, vous pouvez toutefois créer deux fichiers de propriétés différents : un avec BACKUP_RESTORE_MODE = full, que vous pouvez utiliser occasionnellement pour produire des sauvegardes complètes, et un avec BACKUP_RESTORE_MODE = incremental pour générer des sauvegardes incrémentielles entre les sauvegardes complètes. Chaque sauvegarde incrémentielle contient toutes les modifications depuis la dernière sauvegarde complète.

   • SHARED_LOCATION = <emplacement des fichiers de sauvegarde>

     Indiquez un emplacement partagé dans lequel créer une copie temporaire des fichiers de sauvegarde pour ArcGIS Server, Portal for ArcGIS et ArcGIS Data Store. Le compte qui a installé ArcGIS Server, Portal for ArcGIS et ArcGIS Data Store et le compte qui exécute l’utilitaire webgisdr doivent disposer d’un accès en lecture et en écriture sur cet emplacement. Vérifiez que l’emplacement est d’une taille suffisante pour contenir les fichiers de sauvegarde de chaque composant. Même si les fichiers sont compressés, ils peuvent être assez volumineux selon la quantité et le type de données dont vous disposez. Si vous possédez des couches de scènes hébergées et des caches et définissez INCLUDE_SCENE_TILE_CACHES sur true, le fichier de sauvegarde ArcGIS Data Store peut être particulièrement volumineux.

     Héritage :

     Dans Portal for ArcGIS 10.4, cette propriété était SHARED_FOLDER.

   • INCLUDE_SCENE_TILE_CACHES = <true | false>

     Si vous publiez des couches de scènes hébergées sur votre portail et que vous souhaitez inclure les données des caches de scènes dans la sauvegarde, définissez INCLUDE_SCENE_TILE_CACHES sur true. Gardez à l’esprit que, si ce paramètre est défini sur true, toutes les données des caches de scènes sont intégrées dans la sauvegarde, pas seulement les nouvelles données de cache créées depuis votre dernière sauvegarde. Si vous savez qu’aucun nouveau cache de scènes n’a été créé depuis votre dernière sauvegarde ou si vous ne publiez pas de scènes dans votre portail, vous pouvez définir INCLUDE_SCENE_TILE_CACHES sur false.

   • BACKUP_STORE_PROVIDER = {FileSystem | AmazonS3 | AzureBlob}

     Indiquez si vous voulez enregistrer le fichier de sauvegarde webgissite sur le système de fichiers ou sur le stockage cloud.

     Si vous souhaitez stocker votre sauvegarde ArcGIS Enterprise dans un emplacement de partage de fichiers sur site, spécifiez FileSystem. L’utilitaire webgisdr stockera vos fichiers de sauvegarde dans le partage de fichiers que vous indiquez pour BACKUP_LOCATION.

     Pour stocker vos sauvegardes ArcGIS Enterprise dans un paquet Amazon Simple Storage Service (S3), créez un paquet S3 dédié spécifiquement au stockage des fichiers de sauvegarde générés par l'utilitaire webgisdr et mettez à jour les propriétés S3 avec les informations requises pour accéder à votre paquet.

     Si vous voulez stocker vos sauvegardes ArcGIS Enterprise dans un stockage blob Azure, créez un conteneur spécifique pour le stockage des fichiers de sauvegarde générés par l'utilitaire webgisdr, et mettez à jour les propriétés Azure avec les informations requises pour accéder à votre conteneur.

   • BACKUP_LOCATION = <emplacement du fichier de sauvegarde sur site>

     Indiquez l’emplacement pour le fichier de sauvegarde webgissite.

     Les fichiers de sauvegarde sont initialement stockés dans SHARED_LOCATION mais sont ensuite copiés dans BACKUP_LOCATION. Vérifiez que l'emplacement est d'une taille suffisante pour contenir le fichier de sauvegarde. Même si le fichier est compressé, il peut être assez volumineux selon la quantité et le type de données dont vous disposez. Le compte qui exécute l’utilitaire webgisdr doit disposer d’un accès en lecture et en écriture sur BACKUP_LOCATION.

     Si vous définissez BACKUP_LOCATION sur un dossier, l’outil de récupération d’urgence importe le fichier de sauvegarde le plus récent disponible dans ce dossier. Si vous définissez BACKUP_LOCATION sur un fichier de sauvegarde spécifique dans le dossier, ce fichier est importé par l’outil de récupération d’urgence.

   • Si vous définissez BACKUP_STORE_PROVIDER sur AmazonS3, fournissez les informations correspondant aux propriétés suivantes :
     • S3_ACCESSKEY= <La clé d’accès pour votre compte AWS>

       Vous devez uniquement configurer cette clé si vous définissez S3_CREDENTIAL_TYPE=accessKey. L'utilisateur IAM représenté par cette clé d'accès doit disposer d'un accès en lecture et en écriture sur le paquet S3 que vous spécifiez avec la propriété S3_BUCKET.

     • S3_SECRETKEY= <La clé d’accès pour votre compte AWS>

       Spécifiez la clé secrète associée à la clé d'accès pour votre compte AWS. Elle est uniquement utilisée si vous définissez S3_CREDENTIAL_TYPE sur accessKey.

     • S3_ENCRYPTED = false

       Laissez cette propriété définie sur false. Si la propriété S3_CREDENTIAL_TYPE est définie sur accessKey lorsque vous exécutez l'utilitaire webgisdr, ce dernier chiffre la clé d'accès et la clé secrète et définit S3_ENCRYPTED sur la valeur de la clé d'accès chiffrée.

     • S3_BUCKET= <nom du paquet S3>

       C'est le nom du paquet Amazon S3 dans lequel vous voulez stocker votre fichier de sauvegarde ArcGIS Enterprise.

     • S3_CREDENTIAL_TYPE = <IAMRole | accessKey>

       Définissez la propriété S3_CREDENTIAL_TYPE sur IAMRole si vous pensez accéder à S3_BUCKET à l'aide d'un rôle IAM AWS. Définissez la propriété sur accessKey si vous pensez accéder à S3_BUCKET à l'aide d'un utilisateur IAM AWS via une clé d'accès. Le rôle ou utilisateur IAM doit disposer d'un accès en lecture et en écriture sur le paquet S3 que vous spécifiez avec la propriété S3_BUCKET.

     • S3_REGION= <Région AWS dans laquelle vous avez créé le paquet S3>
     • S3_BACKUP_NAME = <nom du fichier de sauvegarde>

       Cette propriété est uniquement utilisée lorsque vous restaurez un déploiement ArcGIS Enterprise. Spécifiez le nom du fichier de sauvegarde que vous voulez restaurer. Si vous n'indiquez pas le nom du fichier de sauvegarde, le dernier fichier de sauvegarde est restauré.

   • Si votre déploiement ArcGIS Enterprise s'exécute sur AWS et que le répertoire de contenu de votre portail est stocké sur Amazon S3, vous avez besoin d'un paquet de sauvegarde pour le répertoire de contenu. Créez un paquet de sauvegarde dans S3 et définissez PORTAL_BACKUP_S3_BUCKET dans le fichier de propriétés sur le nom du paquet, puis définissez PORTAL_BACKUP_S3_REGION sur la région AWS dans laquelle vous avez créé le paquet S3. Reportez-vous à la rubrique Configurer une instance ArcGIS Enterprise haute disponibilité avec les services de stockage dans l’aide relative à ArcGIS Enterprise on Amazon Web Services pour plus d’informations sur ce type d’implémentation.

     Héritage :

     Avant ArcGIS Enterprise 10.5.1, la propriété PORTAL_BACKUP_S3_BUCKET était BACKUP_BUCKET_NAME.

   • Si vous définissez BACKUP_STORE_PROVIDER sur AzureBlob, fournissez les informations correspondant aux propriétés suivantes :
     • AZURE_BLOB_ACCOUNT_NAME = <compte de stockage Azure>

       Définissez le nom du compte de stockage blob Azure.

       Astuce:

       Vous avez indiqué le nom de ce compte de stockage lorsque vous avez choisi d'utiliser le stockage cloud Azure pour l'emplacement de configuration et de contenu dans le volet Options de déploiement de Cloud Builder.

     • AZURE_BLOB_ACCOUNT_KEY = <clé du compte>

       Spécifiez la clé de compte associée à votre compte de stockage blob Azure.

     • AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED = false

       Lorsque vous ajoutez les valeurs ACCOUNT_KEY au fichier pour la première fois, indiquez false. Lorsque vous enregistrez le fichier webgisdr.properties, la clé est chiffrée et l’outil définit ces propriétés sur true.

     • AZURE_BLOB_CONTAINER_NAME = <Nom de votre conteneur de stockage blob Azure>

       Indiquez le nom du conteneur blob.

     • AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <extrémité du compte de stockage blob>

       Indiquez l'extrémité du compte de stockage de service blob.

     • (Facultatif) AZURE_BLOB_ENDPOINT_URL = <URL de service blob>

       Indiquez l’URL de l’extrémité de service blob si vous utilisez une extrémité de stockage blob personnalisée. Si vous n’utilisez pas d’extrémité personnalisée, ne supprimez pas les marques de commentaire sur cette ligne. L’URL par défaut est au format https://<BLOB_ACCOUNT_NAME>.blob.core.windows.net.

   • Vous pouvez également stocker votre répertoire de contenu du portail dans un conteneur de stockage blob Azure. Dans ce cas, vous devez disposer d’un paquet de sauvegarde pour le répertoire de contenu dans Azure. Le jeu de propriétés qui commence par PORTAL_BACKUP_BLOB définit le compte utilisé pour le répertoire de contenu du portail. Les valeurs de ces propriétés doivent correspondre à celles définies dans la section AZURE_BLOB ci-dessus. Les définitions de cette section s’appliquent également ici.
     • PORTAL_BACKUP_BLOB_ACCOUNT_NAME = <compte de stockage Azure>
     • PORTAL_BACKUP_BLOB_ACCOUNT_KEY = <clé du compte>
     • PORTAL_BACKUP_BLOB_ACCOUNT_KEY_ENCRYPTED = false
     • PORTAL_BACKUP_BLOB_CONTAINER_NAME = <Nom de votre conteneur de stockage blob Azure>
     • PORTAL_BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = <extrémité du compte de stockage blob>
     • (Facultatif) PORTAL_BACKUP_BLOB_ENDPOINT_URL = <URL du service blob personnalisé>
   • IS_PORTAL_PKI_AUTHENTICATED = <true | false>

     Si vous avez configuré une infrastructure à clé publique (PKI) pour sécuriser l’accès à votre portail, définissez cette valeur sur true.

     Pour en savoir plus sur les options d’authentification du portail

     Si cette option est définie sur true (vrai), fournissez des valeurs pour les propriétés suivantes :

     • PORTAL_CLIENT_CERTIFICATE_FILE_PATH = <chemin complet du fichier de certificat>

       Indiquez le chemin complet du fichier correspondant au certificat PKI du portail au format PKCS12.

     • PORTAL_CLIENT_CERTIFICATE_PASSWORD = <mot de passe du certificat>

       Fournissez le mot de passe du certificat PKI.

     • PORTAL_CLIENT_CERTIFICATE_PASSWORD_ENCRYPTED = false

       Lorsque vous saisissez pour la première fois le mot de passe du certificat, conservez la valeur false. Lors de la première exécution de l’outil après avoir enregistré cette valeur, l’outil chiffre le mot de passe et modifie cette propriété en true.

   Dans cet exemple, une sauvegarde du portail à l’URL https://portalhostname.domain.com:7443/arcgis, plus les services et paramètres de ses serveurs d’hébergement et fédérés, ainsi que les données des couches d’entités hébergées stockées dans le data store relationnel ArcGIS Data Store, sont initialement générés dans des fichiers sur \\\\myserver\\tempbackups. Chaque fichier est compressé dans un seul fichier de sauvegarde (entbackup)) et copié sur \\mybuserver\\wgbackups. Les caches des couches de scènes provenant du data store de cache tuilé ArcGIS Data Store ne sont pas inclus, car INCLUDE_SCENE_TILE_CACHES est défini sur false.

   PORTAL_ADMIN_URL = https://portalhostname.domain.com:7443/arcgis
   PORTAL_ADMIN_USERNAME = admin
   PORTAL_ADMIN_PASSWORD = Th3.Ad.Pass
   PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
   
   BACKUP_RESTORE_MODE = full
   SHARED_LOCATION = \\\\myserver\\tempbackups
   INCLUDE_SCENE_TILE_CACHES = false
   
   BACKUP_STORE_PROVIDER = FileSystem
   BACKUP_LOCATION = \\\\mybuserver\\wgbackups\\entbackup

   Dans cet exemple, une sauvegarde complète du portail à l'URL https://portalonaws.mydomain.com:7443/gis, son répertoire de contenu (stocké dans le paquet S3 portalcontent), les services et paramètres de ses serveurs d'hébergement et fédérés, ainsi que les données stockées dans les stockages des données du cache de tuiles et relationnelles, sont générés dans le paquet S3 entbackups de la région eu-west-1 d'AWS. Le nom du fichier de sauvegarde est fullbackup06June. Un rôle IAM est utilisé pour accéder au compte AWS.

   PORTAL_ADMIN_URL = https://portalonaws.mydomain.com:7443/arcgis
   PORTAL_ADMIN_USERNAME = entadmin
   PORTAL_ADMIN_PASSWORD = p0rtl.a.p
   PORTAL_ADMIN_PASSWORD_ENCRYPTED = false
   
   BACKUP_RESTORE_MODE = full
   SHARED_LOCATION = \\fileserver\backups
   INCLUDE_SCENE_TILE_CACHES = true
   BACKUP_STORE_PROVIDER = AmazonS3
   
   S3_BUCKET = entbackups
   S3_CREDENTIAL_TYPE = IAMRole
   S3_REGION = eu-west-1
   S3_BACKUP_NAME = fullbackup06June
   
   PORTAL_BACKUP_S3_BUCKET = portalcontent
   PORTAL_BACKUP_S3_REGION =eu-west-1

   Cet exemple est destiné au stockage Microsoft Azure Blob. Une sauvegarde complète du portail à l’URL https://portalonazure.domain.com:7443/arcgis, de son répertoire de contenu, des services et paramètres de ses serveurs d’hébergement et fédérés, ainsi que des données stockées dans le stockage de données relationnelles et de cache de tuiles est générée dans le blob Azure drbackups.

   PORTAL_ADMIN_URL = https://portalonazure.domain.com:7443/arcgis
   PORTAL_ADMIN_USERNAME = entadmin
   PORTAL_ADMIN_PASSWORD = p0rtl.a.p
   
   SHARED_LOCATION = \\fileserver\backups
   BACKUP_STORE_PROVIDER = AzureBlob
   
   AZURE_BLOB_ACCOUNT_NAME = entbackups
   AZURE_BLOB_ACCOUNT_KEY = <key>
   AZURE_BLOB_ACCOUNT_KEY_ENCRYPTED =false
   AZURE_BLOB_ACCOUNT_ENDPOINT_SUFFIX = core.windows.net
   AZURE_BLOB_CONTAINER_NAME = drbackups
   
   PORTAL_BACKUP_BLOB_ACCOUNT_NAME = entbackups
   PORTAL_BACKUP_BLOB_ACCOUNT_KEY = <key>
   PORTAL_BACKUP_BLOB_ACCOUNT_KEY_ENCRYPTED = false
   PORTAL_BACKUP_BLOB_ACCOUNT_ENDPOINT_SUFFIX = core.windows.net
   PORTAL_BACKUP_BLOB_CONTAINER_NAME = portalcontent

3. Enregistrez le fichier de propriétés.

   La valeur de PORTAL_ADMIN_PASSWORD est chiffrée dans le fichier et PORTAL_ADMIN_PASSWORD_ENCRYPTED est défini sur true une fois l’utilitaire webgisdr exécuté avec ce fichier.

4. Ouvrez une interface de commande sur la machine Portal for ArcGIS, définissez le répertoire sur l’emplacement de l’utilitaire webgisdr et exécutez l’utilitaire avec l’option d’exportation.

   L’utilitaire webgisdr est installé dans <Portal for ArcGIS installation directory>/tools/webgisdr.

   La syntaxe de l'utilitaire webgisdr est la suivante :

   webgisdr --{export | import} --file <location and name of properties file>

   Comme indiqué précédemment, le fichier de propriétés (mywebgis.properties) a été enregistré dans le répertoire créé par l’utilisateur /home/ags/arcgis/portal/propfiles.

   webgisdr --export --file /home/ags/arcgis/portal/propfiles/mywebgis.properties

   Le fichier de sauvegarde est créé à l’emplacement spécifié pour la valeur SHARED_LOCATION dans le fichier de propriétés. Le nom de fichier est <timestamp>.webgissite.

5. Si votre déploiement ArcGIS Enterprise contient des caches de couches de tuiles hébergées ou de service de carte, faites une copie de sauvegarde manuelle de tous les répertoires dans lesquels vos tuiles de cache sont stockées (par exemple, l’intégralité du répertoire arcgiscache sous C:\arcgisserver\directories\ ou <ArcGIS Server installation directory>/arcgis/server/usr/directories).

   Ces répertoires contiendront les tuiles de cache de carte et le fichier de structure de tuilage conf.xml. Les répertoires de cache peuvent également contenir une géodatabase fichier, status.gdb, qui donne des informations concernant les tuiles qui ont été créées.

Vous pouvez utiliser ce fichier pour restaurer votre déploiement ArcGIS Enterprise.