Activation d'un référentiel de contenu externe pour le contrôle des sources

Vous pouvez utiliser la page Administration dans le client Web afin d'activer un référentiel de contenu externe pour le contrôle des sources. Si vous effectuez cette activation, le contenu de contrôle des sources dont le volume dépasse le seuil configuré est stocké dans le référentiel de contenu externe au lieu de la base de données de l'application.

Avant de commencer

Vous devez être connecté à la page d'administration d'une application de gestion des changements et de la configuration (CCM) enregistrée auprès de Jazz® Team Server. Vous devez être membre du groupe de droits d'accès au référentiel JazzAdmins pour disposer d'un accès administrateur permettant d'activer et de modifier les paramètres du magasin de contenu externe.

A propos de cette tâche

Jazz Source Control peut stocker du contenu de façon externe, soit sur un serveur qui prend en charge le protocole WebDAV, soit sur le système de fichiers local du serveur d'applications. Si vous configurez un serveur WebDAV externe, vous devez fournir des informations d'identification que l'application Engineering Workflow Management peut utiliser pour accéder à ce serveur.

Procédure

  1. Sur la page d'administration de l'application Gestion des changements et des configurations (pas pour Jazz Team Server), cliquez sur l'onglet Application.
    Important :
    • La manière dont vos fichiers sont stockés dans le magasin de fichiers externe dépend de la nature de cet utilitaire de stockage de fichiers. Les fichiers peuvent être stockés dans une base de données ou être chiffrés, selon le mode de configuration du magasin (par exemple, si un système de fichiers, un serveur WebDAV ou un autre serveur est utilisé).
    • Une fois que vous avez déplacé votre contenu de la base de données vers un magasin externe, un administrateur de base de données peut récupérer de l'espace dans la base de données, en fonction de la base de données elle-même.
    • Le magasin de contenu externe et la base de données doivent être sauvegardés en même temps pour que les références de la base de données au magasin de contenu externe soient cohérentes.
    • Si un objet est stocké en externe et que le serveur externe devient non disponible, vous recevez des messages d'erreur lorsque vous tentez d'accéder aux objets SCM volumineux. Ces erreurs sont similaires à celles d'un scénario où le serveur perd sa connexion à la base de données. Lorsque la connexion est rétablie, en l'absence de désintégration, le fonctionnement doit redevenir normal.
  2. Dans la section Configuration, cliquez sur Propriétés avancées.
  3. Sur la page Propriétés avancées, dans la zone SCM, définissez les propriétés suivantes :
    1. Contenu versionné Référentiel externe - Ecriture activée - 'true ou 'false. Lorsque la valeur est true, le nouveau contenu est écrit dans le magasin de contenu externe. Lorsque la valeur est définie sur false, le nouveau contenu est écrit dans la base de données Change and Configuration Management (CCM), mais le contenu déjà stocké dans un magasin de contenu externe continue d'être récupéré depuis ce magasin.
    2. Versioned Content External Content - Artifact Minimum Size - Taille minimale du contenu (en octets) qui doit être stocké dans le magasin de contenu externe (s'il est configuré).
    3. Référentiel externe de contenu versionné - Type - L'un des codes suivants : " NONE, " FILE ou " WEBDAV.
    4. Référentiel externe de contenu versionné - URI - URI pointant vers la racine du référentiel externe de contenu.
    5. Versioned Content External Repository - User ID - L'ID de l'utilisateur pour la connexion au magasin de contenu externe (si nécessaire).
    6. Versioned Content External Repository - Password - Le mot de passe pour la connexion au magasin de contenu externe (si nécessaire).

Modification du référentiel de contenu externe configuré

Vous pouvez modifier les valeurs de configuration du référentiel de contenu externe. Les modifications affectent l'emplacement de stockage du nouveau contenu ; elles n'affectent pas le mode de stockage ou d'extraction du contenu existant.

Procédure

  1. Définissez la propriété Versioned Content External Repository - Write Enabled sur 'false si vous souhaitez que tout nouveau contenu soit stocké dans la base de données du serveur Engineering Workflow Management, quelle que soit sa taille. Un contenu précédemment stocké dans un référentiel de contenu externe continue d'être extrait de ce référentiel de contenu externe.
  2. Modifiez la propriété " Référentiel externe de contenu versionné - URI si vous souhaitez que le nouveau contenu volumineux soit enregistré sur le nouveau serveur. Le contenu précédemment sauvegardé est conservé sur l'ancien serveur et en est extrait.
    Note : Il n'y a pas de limite au nombre de serveurs externes de dépôt de contenu qui peuvent héberger du contenu précédemment stocké. Toutefois, un seul référentiel de contenu externe peut être configuré pour stocker un nouveau contenu à un moment donné.

Modification des données d'identification d'accès de WebDAV

IBM® Engineering Workflow Management stocke les identifiants d'accès pour chaque valeur URI (Versioned Content External Repository) que vous saisissez. Si vous modifiez la valeur URI du Référentiel externe de contenu versionné et les informations d'identification qui lui sont associées, l'ancien URI et les anciennes informations d'identification sont stockés afin que Engineering Workflow Management puisse continuer à récupérer du contenu sur ce serveur tout en utilisant les nouvelles informations d'identification pour accéder au référentiel de contenu externe actuellement configuré.

Procédure

  1. Dans la section Configuration, cliquez sur Propriétés avancées.
  2. Cliquez sur Versioned Content External Repository - User ID pour modifier le nom de l'utilisateur.
  3. Cliquez sur Versioned Content External Repository - Password pour modifier le mot de passe.
  4. Pour modifier les données d'identification des serveurs WebDAV configurés précédemment, vous devez éditer directement le fichier des données d'identification du référentiel de contenu externe :
    1. Ouvrir le fichier d'identification JSON appelé 'externalContentRepositories.conf, situé dans le répertoire Engineering Workflow Management, typiquement dans './<server>/conf/ccm, où <server> est le répertoire d'installation du serveur Engineering Workflow Management. Le fichier externalContentRepositories.conf ci-après contient deux référentiels de contenu externe avec leurs données d'identification. Notez que les mots de passe sont chiffrés :
      [
          {
              "PASSWORD": "[qoSGR4gvSUY=]",
              "URI": "https:\/\/example.com\/artifactory\/content\/",
              "USER": "repoUser1"
          },
          {
              "PASSWORD": "[DZCEyaFThdWaWOsOL2l2Cg==]",
              "URI": "https:\/\/example.com\/artifactory\/content2\/",
              "USER": "repoUser2"
          }
      ]
    2. Utilisez un éditeur de texte pour modifier les champs USER et PASSWORD pour les référentiels de contenu externes appropriés. Editez les caractères entre guillemets pour les valeurs USER et PASSWORD. Les nouveaux mots de passe sont entrés sous la forme d'un texte en clair. Enregistrez le fichier et Engineering Workflow Management détecte automatiquement les modifications, met à jour les champs de mot de passe avec leurs valeurs cryptées et commence à utiliser les nouvelles informations d'identification. Voici le fichier " externalContentRepositories.conf mis à jour :
      [
          {
              "PASSWORD": "newPassword1",
              "URI": "https:\/\/example.com\/artifactory\/content\/",
              "USER": "repoUser1"
          },
          {
              "PASSWORD": "newPassword2",
              "URI": "https:\/\/example.com\/artifactory\/content2\/",
              "USER": "newRepoUser2"
          }
      ]

      Le fichier externalContentRepositories.conf inclut des entrées pour les référentiels de contenu externes de type fichier, mais les données d'identification ne sont actuellement utilisées que pour les référentiels WebDAV et ne sont pas prises en charge pour les référentiels de contenu externes basés sur des systèmes de fichiers.

Déplacement de contenu

Vous pouvez utiliser la commande moveContent des outils de référentiel pour déplacer un contenu précédemment stocké de trois manières.

A propos de cette tâche

Vous pouvez utiliser la commande moveContent des outils de référentiel pour déplacer un contenu précédemment stocké de l'une des manières suivantes :

  • De la base de données du serveur Engineering Workflow Management vers un référentiel de contenu externe
  • D'un référentiel de contenu externe vers la base de données du serveur Engineering Workflow Management
  • D'un ancien référentiel de contenu externe vers celui actuellement configuré

La commande moveContent possède des arguments permettant de spécifier les référentiels de contenu source et cible, ainsi que la taille minimale ou maximale du contenu à déplacer. Pour plus d'informations sur l'exécution de la commande avec différents arguments, consultez la documentation de référence sur la ligne de commande des outils du référentiel.

Suppression de contenu

A propos de cette tâche

Lorsque du contenu stocké dans un référentiel de contenu externe est supprimé à partir de Engineering Workflow Management, le serveur tente également de supprimer le contenu du référentiel de contenu externe. Le serveur tente d'effectuer la suppression mais la réussite de cette opération n'est pas garantie. Pour plus d'informations, consultez : Suppression de contenu du contrôle de source

Si un problème se produit lors de la suppression de contenu du référentiel externe, ce problème est consigné sur le serveur, mais il n'entraîne pas l'échec de la suppression.

Production de rapports à l'aide de beans gérés JMX

Dans « Engineering Workflow Management », vous pouvez surveiller le contenu stocké dans SCM à l'aide des beans gérés (MBeans) de l'interface « Java Management Extensions » ( JMX ).

A propos de cette tâche

Un administrateur peut activer le reporting des MBeans pour le contenu versionné par SCM en utilisant la page Propriétés avancées dans le client web pour le serveur Engineering Workflow Management

Procédure

  1. Ouvrez la page Administration du serveur de votre serveur Engineering Workflow Management, et cliquez sur Gérer le serveur.
  2. Dans la navigation de gauche, cliquez sur " Aptitude au service. Faites défiler vers le bas jusqu'à la section Serviceability Component , localisez la section com.ibm.team.scm.service.internal.metrics.VersionedContentMetricsTask et activez les beans que vous souhaitez surveiller.
    Tableau 1. Tâche de la métrique Contenu versionné
    Nom de la propriété Valeur par défaut Description
    Délai entre les appels 604800 Délai en secondes entre les appels de la tâche en arrière-plan Métrique du contenu versionné, qui collecte les données à publier comme beans gérés.
    Note : Après avoir activé les MBeans et redémarré le serveur, les beans sont collectés après l'expiration du "Délai entre les invocations".
    Activer le bean géré Métriques du référentiel de contenu versionné false Si cette propriété est définie sur true, elle publie les informations de tous les référentiels de contenu dans lesquels un contenu a été stocké.
    Activer le bean géré Métrique du composant de contenu versionné false Si cette propriété est définie sur true, pour chaque composant, elle publie un bean qui contient des informations sur le nombre de fichiers, la taille et l'emplacement de stockage du contenu demandé par les fichiers dans chaque composant.
    Activer le bean géré Tailles des plus gros fichiers false Si cette propriété est définie sur true, elle publie les informations sur les plus gros fichiers stockés dans SCM.
    Bean géré Tailles des fichiers - Nombre de fichiers pour lesquels générer un rapport 20 Nombre de fichiers à inclure dans le rapport pour le bean géré Tailles des plus gros fichiers.
    Bean géré Tailles des fichiers - seuil de taille 1000000 Taille minimale en octets des fichiers à prendre en compte par le bean géré Tailles des plus gros fichiers.

Bean géré Métrique du référentiel de contenu

Si le bean géré Métrique du référentiel de contenu est activé, un bean géré contenant une liste des référentiels de contenu dans lesquels un contenu a été stocké est publié. La base de données Engineering Workflow Management est représentée par un référentiel dont l'URI est 'DATABASE

A propos de cette tâche

Le nom du MBean a la forme " com.ibm.team.scm.content:name="<app-context>",type=repositoryMetrics. Le bean géré contient une liste de référentiels. Pour chaque référentiel de contenu, les informations suivantes sont publiées :

Tableau 2. Bean géré Métrique du référentiel de contenu
Nom de la propriété Description
externalURI URI du référentiel de contenu externe ou DATABASE pour le référentiel de base de données par défaut.
totalNoOfContent Nombre d'objets de contenu uniques stockés dans le référentiel de contenu.
compressedDBSize Nombre total d'octets stockés dans la base de données pour ce référentiel de contenu. Pour le référentiel DATABASE par défaut, il s'agit de la taille compressée du contenu. Les référentiel de contenu externes stockent des métadonnées dans la base de données.
totalSize Taille totale non compressée du contenu stocké dans le référentiel de contenu.

Bean géré Métrique du composant

Si le bean géré Métrique du composant est activé, un bean géré est publié pour chaque composant SCM.

A propos de cette tâche

Les noms des MBean ont la forme " com.ibm.team.scm.content:name="<app-context>",type=componentContent,componentNameAndId="<componentName>_<componentUUID>". Pour chaque référentiel de contenu, les informations suivantes sont publiées :

Tableau 3. Bean géré Métrique du composant
Nom de la propriété Description
componentName Nom du composant.
componentId Identificateur unique universel du composant.
ownerName Nom du propriétaire du composant. Il s'agit du nom de la zone de projet conteneur si le composant appartient à une zone de projet ou d'équipe ou du nom du contributeur propriétaire.
ownerId Identificateur unique universel du propriétaire du composant. Il s'agit de l'identificateur unique universel de la zone de projet conteneur si le composant appartient à une zone de projet ou d'équipe ou de l'identificateur unique universel du contributeur propriétaire.
totalNoOfContent Nombre d'objets de contenu uniques demandés par les fichiers de ce composant.
dbSize Nombre total d'octets stockés dans la base de données pour le contenu demandé par les fichiers de ce composant.
totalSize Taille totale non compressée du contenu demandé par les fichiers de ce composant.
externalStores Liste des référentiels de contenu externes dans lesquels un contenu est stocké pour ce composant. Cette valeur sera vide si tout le contenu est stocké dans la base de données Engineering Workflow Management Pour chaque référentiel de contenu externe, voir le tableau suivant :
Tableau 4. Contenu du magasin externe
Nom de la propriété Description
externalURI URI du référentiel de contenu externe.
totalSize Nombre total d'octets stockés dans le référentiel de contenu externe.
totalNoOfContent Nombre d'objets de contenu uniques demandés par les fichiers de ce composant stockés dans ce référentiel de contenu externe.

Engineering Workflow Management utilise un mécanisme de stockage basé sur le hachage pour éviter de stocker plusieurs copies d'un contenu identique. Si un contenu identique est restitué plusieurs fois, une seule copie de ce contenu est stockée physiquement et chaque projet, composant ou fichier qui y est associé pointe vers cette copie unique conservée. La transparence vis-à-vis des utilisateurs s'applique à la fois au contenu stocké dans la base de données du serveur Engineering Workflow Management et au contenu stocké dans des référentiels de contenu externes.

Le total combiné de tous les beans des métriques de composant peut être supérieur au nombre réel d'octets physiquement stockés dans la base de données ou les référentiels de contenu externes.

Bean géré Tailles des plus gros fichiers

Le nombre de fichiers rapportés par le MBean Top File Sizes est contrôlé par la propriété avancée du serveur Engineering Workflow Management File Sizes MBean - Number of Files to report sous 'VersionedContentMetricsTask. Si le bean géré Tailles des plus gros fichiers est activé, un bean est publié pour chacun des fichiers les plus volumineux dont la taille est supérieure à celle spécifiée par la propriété Bean géré Tailles des fichiers - seuil de taille (en octets).

A propos de cette tâche

Les noms des MBean ont la forme " com.ibm.team.scm.content:name="<app-context>",type=topContent,rank="<N>". Pour chacun des fichiers les plus volumineux, les informations suivantes sont publiées :

Tableau 5. Bean géré Tailles des plus gros fichiers
Nom de la propriété Description
contentSize Taille compressée de ce contenu s'il est stocké dans la base de données ; taille complète du contenu si ce dernier est stocké en externe.
externalURI L'URI du référentiel de contenu externe dans lequel ce contenu est stocké, ou " DATABASE s'il est stocké dans la base de données du serveur Engineering Workflow Management
contentClaimer Pour chaque référentiel de contenu externe, consultez le tableau ci-après.
componentName Nom du composant conteneur.
itemId Identificateur unique universel de l'élément du fichier demandeur.
stateId Identificateur unique universel de l'état du fichier demandeur.
approximatePath Chemin d'accès approximatif ou le plus courant de ce fichier. Le chemin d'accès d'un fichier est déterminé par la structure de répertoires de chaque flux ou espace de travail de référentiel dans lequel il apparaît et, en général, il ne peut pas être déterminé sans spécifier d'espace de travail ou de flux. Le fichier peut ne pas exister réellement dans la propriété approximatePath d'un espace de travail spécifique, en particulier si chaque espace de travail ou flux qui contient ce fichier possède un chemin d'accès différent.

Considérations sur le regroupement de laEngineering Workflow Management

Vous pouvez utiliser Engineering Workflow Management dans un environnement en grappe.

A propos de cette tâche

Si vous utilisez Engineering Workflow Management dans un environnement en grappe, tenez compte des éléments suivants :
  • Votre référentiel de contenu externe doit être accessible à tous les noeuds du cluster. Ce principe s'applique à la fois aux référentiels de contenus basés sur des fichiers et basés sur WebDAV.
  • Si le contenu se trouve dans plusieurs référentiels WebDAV et que vous devez éditer manuellement les fichiers des données d'identification, vous devez mettre à jour le fichier des données d'identification sur chaque noeud du cluster.

Sauvegarde

Lorsque vous sauvegardez une configuration de Engineering Workflow Management qui utilise des référentiels de contenu externes, il est important de sauvegarder d'abord la base de données de Engineering Workflow Management, puis les référentiels externes. Lorsque les données sont restaurées, le serveur reflète l'état dans lequel il se trouvait immédiatement après la sauvegarde de la base de données, quel que soit le moment où les référentiels de contenu externes sont sauvegardés.

A propos de cette tâche

Si vous réinitialisez le serveur, vous ne devez réinitialiser que la base de données Engineering Workflow Management Vous n'avez pas besoin de restaurer la version antérieure des référentiels de contenu externes. Dans ce type de scénario, les référentiel de contenu externes conservent tout contenu orphelin ajouté avant le rétablissement de la version antérieure de la base de données et l'intégrité des données n'est pas affectée. Le contenu orphelin est automatiquement récupéré si le contenu est restitué sur le serveur.

La procédure de sauvegarde d'un référentiel de contenu externe dépend du type de référentiel. Pour un magasin de contenu WebDAV, reportez-vous à la documentation du produit pour obtenir des instructions spécifiques. Pour un magasin de contenu basé sur un système de fichiers, vous pouvez utiliser une procédure de sauvegarde sur un système de fichiers standard.

Entre la fin de la sauvegarde de la base de données et la fin des sauvegardes des référentiels externes, n'utilisez pas la fonction de suppression de contenu ou la commande moveContent des outils de référentiel. La fonction de suppression de contenu est une action rare effectuée par un administrateur qui supprime des octets de contenu de Jazz Team Server: elle ne fait pas référence à l'action courante de vérification des suppressions de fichiers. La plupart des utilisateurs n'exécutent jamais la fonction de suppression de contenu.

Si des suppressions de contenu sont effectuées entre deux sauvegardes, elles doivent être réappliquées après la restauration des données afin de rétablir la base de données dans un état cohérent pour ces éléments. Les suppressions de contenu, si elles ont été effectuées à l'origine, doivent également être réappliquées si la base de données de Engineering Workflow Management est rétablie alors que le magasin de contenu externe ne l'est pas.

Pratiques recommandées

Tenez compte des pratiques recommandées suivantes lorsque vous configurez des référentiels de contenu externes :

A propos de cette tâche

WebDav
  • Pour utiliser la fonctionnalité de référentiel de contenu externe avec certains serveurs WebDAV strictement conformes, tels que Microsoft IIS, veillez à installer la version 6.0.6 de Rational® Team Concert® iFix003 ou une version ultérieure.
  • Divers serveurs WebDAV pouvant avoir une configuration requise spécifique, veillez à bien lire la documentation du serveur avant de configurer ce dernier.
  • Pour vérifier que le serveur WebDAV fonctionne correctement, exécutez les commandes curl PUT et curl GET.
  • Avant de configurer le serveur WebDAV, procurez-vous les informations suivantes :
    • Taille maximale des téléchargements de fichier imposée par le serveur WebDAV
    • Configuration des types de fichier et des types de contenu du serveur
    • Si l'authentification de base est installée et activée sur le serveur
  • Configurez le serveur WebDAV afin qu'il utilise HTTPS. Engineering Workflow Management utilise l'authentification de base pour envoyer les identifiants de connexion WebDAV. La configuration du serveur WebDAV pour qu'il utilise HTTPS permet de s'assurer que ces données d'identification sont chiffrées et qu'elles ne sont pas transmises sous forme de texte en clair.
  • Ne pas utiliser de très petites valeurs pour la propriété " Versioned Content External Content – Artifact Minimum Size Le temps système supplémentaire résultant de l'envoi de demandes HTTP à un serveur WebDAV a un impact négatif sur les performances si le système doit accéder à un très grand nombre de petits fichiers. La fonction de dépôt de contenu externe a été conçue pour déplacer des fichiers volumineux de la base de données du serveur Engineering Workflow Management vers des dépôts de contenu externes : elle n'est pas destinée à déplacer tous les fichiers SCM de la base de données du serveur CCM.

Si vous utilisez un serveur Microsoft IIS, vous pouvez rencontrer les problèmes suivants :

Tableau 6. Problèmes liés au serveur Microsoft IIS
Problème Solution
La fonction d'authentification de base d'IIS n'est pas installée ou activée par défaut Installez la fonction d'authentification de base d'IIS à l'aide du Panneau de configuration de Windows et activez l'authentification dans le gestionnaire des services IIS. Pour plus d'informations, consultez l'aide d' Microsoft IIS concernant l'authentification de base.
IIS ne parvient pas à renvoyer un contenu sans extension de fichier.

Ajoutez un mappage de type MIME pour les fichiers sans extension.

Vous pouvez configurer le type MIME au niveau du répertoire virtuel pour le répertoire virtuel qui inclut le contenu externe.

Configurez le type MIME dans le gestionnaire des services IIS. Pour plus d'informations, consultez l'aide d' Microsoft IIS e sur la configuration des types MIME dans IIS 7.

La taille maximale par défaut des téléchargements de fichier pour IIS n'est que de 30 Mo. Vous pouvez l'augmenter au niveau du site Web dans le gestionnaire des services IIS. Pour plus de détails, consultez l'aide Microsoft IIS concernant la configuration du filtrage des requêtes dans IIS.
IIS autorise une taille maximale de téléchargement de 4 Go.

Si vous devez gérer des fichiers plus volumineux, vous devez sélectionner un autre serveur, tel qu'Artifactory, ou utiliser un magasin de contenu de type Fichier.

Si vous configurez une taille maximale de téléchargement de fichiers sur votre serveur WebDAV, vous devez définir la propriété du serveur avancé Engineering Workflow Management "Versioned Content Maximum Size" à la même valeur. Si vous définissez une valeur et que vous enregistrez un fichier dont la taille est supérieure à la valeur définie, le client Engineering Workflow Management affiche un message d'erreur au lieu d'essayer de télécharger le fichier sur le serveur WebDAV.

Artifactory
  • Désactivez l'accès anonyme dans Artifactory pour empêcher les utilisateurs non authentifiés d'extraire le contenu du serveur Artifactory.
  • Si vous utilisez la fonction de suppression de contenu dans Engineering Workflow Management pour supprimer du contenu SCM sensible, vous devez vider votre dossier poubelle Artifactory ou configurer Artifactory pour qu'il n'utilise pas de dossier poubelle.
Fichier
  • Les chemins UNC ne sont pas pris en charge. Si vous souhaitez utiliser un stockage réseau pour un référentiel de contenu externe de type FILE, vous devez le monter sur le système de fichiers local sous Linux ou le mapper en tant qu'unité réseau sous Windows.
  • Utilisez des chemins canoniques lorsque vous configurez l'URI du référentiel de contenu. Les chemins d'accès qui contiennent des espaces doivent être précédés d'un caractère d'échappement (par exemple, file:////C:/Content%20Repository).