L’installation d’Enterprise Server fournit un contrôle de version localisé (et centralisé), grâce à son service de contrôle de version. Ce service offre des possibilités de contrôle de version exactement là où vous en avez besoin, en local, sans avoir à rechercher ni à payer un logiciel externe de gestion de VCS.
En définissant les dépôts de conception de manière centralisée, une organisation peut contrôler entièrement les dépôts auxquels ses concepteurs peuvent accéder et qu’ils peuvent utiliser.
Relevance of the information on this page:
Une nouvelle installation d’Enterprise Server fournit un seul dépôt de conception basé sur Git pour héberger tous les projets de conception de votre Workspace – et c’est tout ! Cela évite toute configuration et complexité concernant le service local de contrôle de version d’Enterprise Server. Vous disposez d’un seul dépôt de conception – Versioned Storage – auquel tous vos concepteurs peuvent accéder et dans lequel ils peuvent publier des versions. Ainsi, la page VCS de l’interface navigateur du Workspace devient purement informative – vous ne pouvez pas ajouter un nouveau dépôt, et l’unique dépôt Git ne peut être modifié d’aucune manière, ni supprimé. Les informations de cette page ne s’appliquent donc pas à votre cas.
Si vous avez mis à niveau votre Enterprise Server depuis une version ou un produit serveur où l’utilisation de dépôts SVN était activée, ceux-ci resteront activés après la mise à niveau (veillez à actualiser votre licence Altium On-Prem Enterprise Server). Cela vous permet de continuer à utiliser votre flux de conception précédent (et établi). Dans ce cas, vous pouvez continuer à créer des dépôts via le service local de contrôle de version (SVN uniquement), ou vous connecter à des dépôts externes (SVN ou Git). Les informations de cette page restent donc pertinentes pour vous.
Important: Notez que sinon, le bouton
sera grisé, et la possibilité de créer/ajouter des dépôts ne sera pas disponible.
Principaux avantages
L’utilisation de ce service centralisé de contrôle de version présente deux avantages majeurs :
-
Vous disposez d’une gestion commune des utilisateurs et des droits pour Altium Designer et SVN. Lorsque vous vous connectez à Enterprise Server, le service de contrôle de version fonctionne avec votre session/vos identifiants.
-
Les dépôts définis via Enterprise Server (par la page VCS (Admin – VCS) de l’interface navigateur du Workspace d’Enterprise Server) sont automatiquement renseignés dans Altium Designer lors de la connexion ; les utilisateurs n’ont donc pas à se soucier des URL, protocoles, mots de passe, etc. Tout est simplement configuré une seule fois sur Enterprise Server, puis partagé avec les utilisateurs concernés selon les besoins.
Lorsqu’un nouvel utilisateur est créé pour Enterprise Server, le Password défini pour cet utilisateur est stocké à la fois dans Enterprise Server et dans le service SVN, puisque ce dernier ne peut pas accéder directement au mot de passe du premier.
Création de dépôts
Les dépôts peuvent être créés via le service local de contrôle de version (SVN uniquement), ou des dépôts externes peuvent être connectés (SVN ou Git). Ensemble, tous les dépôts sont gérés de manière centralisée via la page VCS (Admin – VCS) de l’interface navigateur du Workspace, en termes de :
-
Leur nom affiché, leur description et leur chemin de dépôt.
-
Leur accessibilité configurée – quels utilisateurs spécifiques peuvent y accéder (ou quels groupes dans le cas des dépôts définis via le service local de contrôle de version).
-
Leur disponibilité – les ajouter ou les supprimer de manière centralisée, plutôt que de laisser chaque concepteur créer et connecter des dépôts indépendamment.
Deux dépôts de conception sont disponibles par défaut, fournis par le service local de contrôle de version et nommés respectivement DefaultRepository (un dépôt SVN) et Versioned Storage (un dépôt Git). Le dépôt DefaultRepository ne peut pas être renommé, mais vous pouvez lui ajouter une description, gérer l’accès des utilisateurs, ou le supprimer, selon les besoins. Le dépôt Versioned Storage, qui est destiné uniquement au stockage intégré des projets Workspace, ne peut pas être renommé, partagé ni supprimé.
Lorsqu’un utilisateur d’Altium Designer se connecte au Workspace, les dépôts de conception qui lui sont accessibles sont automatiquement ajoutés à la page Data Management – Design Repositories de la boîte de dialogue Preferences. Notez que la liste inclura également tous les dépôts « non gérés » qui ont été ajoutés manuellement depuis cette page Preferences.
Définissez de manière centralisée l’accès aux dépôts de conception de votre organisation. Les dépôts peuvent être internes à l’installation d’Enterprise Server, définis à l’aide du service local de contrôle de version, ou externes via le SVN intégré d’Altium Designer, ou un service SVN ou Git tiers. Le contrôle d’accès s’effectue via la page VCS de l’interface navigateur du Workspace. Lorsqu’un utilisateur se connecte au Workspace, les dépôts de conception qui lui sont accessibles sont automatiquement ajoutés à la page Data Management – Design Repositories de la boîte de dialogue Preferences .
Ajout d’un dépôt
Pour ajouter un dépôt de conception, cliquez sur le bouton
, situé en haut à droite de la page. La fenêtre Add Repository apparaît ; utilisez-la pour définir le dépôt.
Seuls les dépôts de type SVN peuvent être créés via le service local de contrôle de version. Les dépôts existants (externes) peuvent être liés, et ceux-ci peuvent être soit SVN, soit Git.
Les propriétés requises dépendent du fait que vous créez un nouveau dépôt à l’aide du service local de contrôle de version, ou que vous établissez un lien vers un dépôt externe existant :
-
New – donnez au dépôt un nom et une description.
-
Existing – en plus d’un nom et d’une description, vous devez fournir le URL du dépôt, ainsi que des identifiants valides (User Name, Password) pour accéder à ce dépôt (si nécessaire).
Lors de la création d’un dépôt interne à Enterprise Server, le nom doit commencer par une lettre ou un chiffre et peut contenir A-Z, a-z ou 0-9. Les caractères de soulignement, tirets et espaces sont autorisés au milieu du nom. Vous ne pouvez pas utiliser les mots suivants : AUX, COM1-COM9, LPT1-LPT9, CON, NUL et PRN. Il n’existe aucune restriction de nommage pour un dépôt externe.
Créez un nouveau dépôt de conception basé sur SVN via le service local de contrôle de version d’Enterprise Server, ou établissez un lien vers un dépôt existant (SVN ou Git) créé en dehors d’Enterprise Server.
Un dépôt de conception externe lié se distingue dans la liste des dépôts par sa propriété External cochée (
).
Pour modifier ultérieurement les propriétés d’un dépôt de conception, cliquez sur le contrôle Edit associé (
). Pour supprimer un dépôt de conception, cliquez sur le contrôle Remove associé (
).
La liste des dépôts est automatiquement triée par ordre alphabétique selon Name, avec d’abord les dépôts locaux définis via le service de contrôle de version, puis les dépôts externes. Le dépôt Versioned Storage basé sur Git – qui ne peut être ni modifié ni supprimé – apparaît toujours en tête de liste.
Partage d’un dépôt
Après avoir centralisé vos dépôts de conception, vous devez vous assurer que les personnes qui ont besoin d’accéder à un dépôt donné – y compris les concepteurs qui travailleront sur les conceptions de cartes – disposent bien de cet accès. Cela se fait en partageant ce dépôt, ou plus précisément en gérant ses autorisations d’accès. Pour cela, cliquez sur le contrôle Share associé au dépôt (
).
La fenêtre Manage Permissions apparaît, avec tous les contrôles nécessaires pour partager le dépôt avec d’autres utilisateurs.
Avec des dépôts de conception organisés de manière centralisée, le partage avec d’autres consiste simplement à gérer les autorisations de chaque dépôt.
Points à connaître :
-
Pour un dépôt local créé via le service de contrôle de version d’Enterprise Server (c’est-à-dire non externe), ses autorisations par défaut partagent ce dépôt avec l’utilisateur qui l’a créé, ainsi qu’avec le groupe Administrators. Tous deux disposent d’un accès complet en lecture/écriture.
-
Pour un dépôt externe, il n’est partagé avec personne par défaut – pas même avec l’utilisateur qui a ajouté une connexion vers celui-ci via l’interface.
-
Seuls les dépôts locaux (non externes) peuvent être partagés avec des groupes définis pour Enterprise Server, ou publiquement. Les groupes sont listés après les utilisateurs individuels.
-
En termes d’autorisations, un utilisateur/groupe dispose d’un accès lecture/écriture lorsque l’option Can Write est activée (
). Si cette option est désactivée, il dispose d’un accès en lecture seule.
Be Aware : Les paramètres d’autorisation lors du partage d’un dépôt de conception interne ne fonctionnent pas exactement comme on pourrait s’y attendre. Même si un dépôt de conception interne lui-même peut être partagé en lecture seule avec un utilisateur du serveur, cet utilisateur peut tout de même créer de NOUVEAUX projets Workspace dans ce dépôt et obtenir des autorisations complètes en lecture/écriture pour les dossiers de projet correspondants qui sont créés. Notez que ce fonctionnement erroné s’applique uniquement aux nouveaux projets Workspace et à leurs dossiers, créés par cet utilisateur. L’utilisateur n’aura pas d’autorisations d’écriture sur les autres dossiers du dépôt.
-
Pour retirer à un utilisateur/groupe existant l’accès partagé à un dépôt, cliquez sur le contrôle Remove associé (
).
Sharing a Local Repository with a Workspace User
Pour partager un dépôt local (non externe) avec un autre utilisateur du Workspace :
-
Cliquez sur le contrôle Add User dans la fenêtre Manage Permissions.
-
Dans la fenêtre Add Users qui apparaît, commencez à saisir le nom complet, le nom d’utilisateur ou l’adresse e-mail d’un utilisateur du Workspace dans le champ Select Users to be added, afin de faire apparaître une liste des utilisateurs correspondants. Sélectionnez l’utilisateur requis dans cette liste. Plusieurs utilisateurs peuvent être choisis. Pour supprimer un utilisateur, cliquez sur la croix de suppression à droite de son nom.
-
Définissez l’autorisation pour le ou les utilisateurs à l’aide du champ Permission. Utilisez la liste déroulante pour choisir entre un accès Read ou un accès Read/Write.
-
Cliquez sur le bouton
pour confirmer l’ajout du ou des utilisateurs et revenir à la fenêtre Manage Permissions.
-
Cliquez sur le bouton
dans la fenêtre Manage Permissions.
Pour modifier les autorisations d’un utilisateur existant, utilisez l’option Can Write dans la fenêtre Manage Permissions, afin de basculer entre un accès Lecture/Écriture (activé) et un accès Lecture seule (désactivé).
Partage d’un dépôt local avec un groupe défini
Si le dépôt a été créé via le service local de contrôle de version, plutôt qu’à partir d’un dépôt externe, vous pouvez également le partager avec des groupes définis pour votre Workspace. Pour partager un dépôt local (et non externe) avec un autre groupe :
-
Cliquez sur le contrôle Add Group dans la fenêtre Manage Permissions.
-
Dans la fenêtre Add Groups qui s’affiche, commencez à saisir le nom d’un groupe dans le champ Select Groups to be added pour faire apparaître une liste des groupes correspondants. Sélectionnez le groupe requis dans cette liste. Plusieurs groupes peuvent être choisis. Pour supprimer un groupe, cliquez sur la croix de suppression à droite de son nom.
-
Définissez l’autorisation pour le ou les groupes à l’aide du champ Permission. Utilisez la liste déroulante pour choisir entre un accès Read ou un accès Read/Write.
-
Cliquez sur le bouton
pour confirmer l’ajout du ou des groupes et revenir à la fenêtre Manage Permissions.
-
Cliquez sur le bouton
dans la fenêtre Manage Permissions.
Pour modifier les autorisations d’un groupe existant, utilisez l’option Can Write dans la fenêtre Manage Permissions, afin de basculer entre un accès Lecture/Écriture (activé) et un accès Lecture seule (désactivé).
Partage d’un dépôt local avec tous les utilisateurs
Si le dépôt a été créé via le service local de contrôle de version, plutôt qu’à partir d’un dépôt externe, vous pouvez également partager ce dépôt avec tous les utilisateurs du Workspace. Pour partager un dépôt local (et non externe) avec toute personne pouvant se connecter au Workspace :
-
Cliquez sur le contrôle Add Anyone dans la fenêtre Manage Permissions.
-
L’entrée Anyone sera ajoutée directement à la liste des entités partagées, et partagée automatiquement avec un accès Lecture/Écriture.
-
Cliquez sur le bouton
dans la fenêtre Manage Permissions.
Pour modifier les autorisations de l’entité Anyone, utilisez l’option Can Write dans la fenêtre Manage Permissions, afin de basculer entre un accès Lecture/Écriture (activé) et un accès Lecture seule (désactivé).
Partage d’un dépôt externe avec un utilisateur du Workspace
Pour partager un dépôt externe avec un utilisateur du Workspace :
-
Cliquez sur le contrôle Add User dans la fenêtre Manage Permissions.
-
Dans la fenêtre Add Users qui s’affiche, commencez à saisir le nom complet, le nom d’utilisateur ou l’adresse e-mail d’un utilisateur du Workspace dans le champ Select Users to be added, afin de faire apparaître une liste des utilisateurs correspondants. Sélectionnez l’utilisateur requis dans cette liste. Pour supprimer l’utilisateur, cliquez sur la croix de suppression à droite de son nom.
Dans le champ SVN User, saisissez un nom enregistré dans le dépôt externe (SVN ou Git) et disposant donc d’un accès. En général, il s’agira du nom correspondant de l’utilisateur enregistré dans le dépôt.
-
Cliquez sur le bouton
pour confirmer l’ajout de l’utilisateur et revenir à la fenêtre Manage Permissions. Cliquez sur Add User pour ajouter d’autres utilisateurs comme décrit à l’étape 2 ci-dessus. Notez que, dans la deuxième image d’exemple ci-dessous, l’utilisateur Barry a été configuré pour utiliser son nom de dépôt correspondant BarrySmith, plutôt que le nom général ServerAdmin.
-
Cliquez sur le bouton
dans la fenêtre Manage Permissions.
Les utilisateurs du Workspace peuvent être associés à n’importe quel nom d’utilisateur valide dans le dépôt SVN externe, et plusieurs utilisateurs du Workspace peuvent être associés à un seul nom d’utilisateur dans le dépôt SVN externe.
-
L’accès lui-même (en Lecture seule ou Lecture/Écriture) est en fin de compte déterminé par l’installation du dépôt externe. Enterprise Server n’influence pas l’autorisation des utilisateurs du dépôt externe et ne peut donc pas gérer ces autorisations du côté d’Enterprise Server.
-
Lors de l’accès à un dépôt externe d’Enterprise Server depuis Altium Designer, par exemple lors de la création d’un nouveau projet, les informations d’identification de connexion au dépôt peuvent être demandées si cela n’a pas été fait auparavant. Ces informations d’identification seront ensuite utilisées automatiquement pour les activités ultérieures avec ce dépôt.
Accès externe à un dépôt de conception SVN local
Un dépôt de conception créé via le service local de contrôle de version d’Enterprise Server peut être consulté à l’aide d’un client SVN tel que TortoiseSVN. L’accès s’effectue à l’aide du protocole réseau standard (le svn:// est actuellement pris en charge). L’adresse correcte du dépôt peut être consultée/copée à partir de deux emplacements :
-
La page VCS de l’interface navigateur du Workspace – dans le champ Repository Path du dépôt cible.
Un dépôt « interne » créé depuis Enterprise Server affichera son chemin d’adresse relatif à Enterprise Server, qui correspond à l’adresse localhost du PC hôte.
Du point de vue d’Altium Designer – ou de toute application ne se trouvant pas sur le PC hôte d’Enterprise Server – les chemins d’adresse du dépôt sont basés sur le nom de leurs PC hôtes.
L’adresse affichée dépendra du fait que vous accédiez au dépôt depuis la même machine sur laquelle Enterprise Server est installé (svn://localhost/<RepositoryName>) ou depuis un PC distant (svn://<ComputerName>/<RepositoryName>, où ComputerName est le nom du PC sur lequel réside Enterprise Server).
Utilisez l’adresse obtenue dans la fonction de navigation du dépôt de votre client Subversion. Lors du premier accès, une boîte de dialogue intermédiaire Authentication s’ouvrira pour demander des informations d’identification de connexion valides. Saisissez le nom et le mot de passe d’un compte utilisateur du Workspace pour continuer. Ces informations d’identification sont valides si :
-
Le compte utilisateur a été ajouté after le dépôt a été créé dans Enterprise Server. Les utilisateurs qui s’appliquent aux dépôts créés peuvent être consultés dans le fichier
passwd situé dans le dossier \ProgramData\Altium\Altium365Data\Repository du PC Enterprise Server – voir ci-dessous.
-
Le dépôt a été partagé avec le compte utilisateur, en ajoutant ce nom d’utilisateur via la commande Add User dans la fenêtre Manage Permissions for <repository name> du serveur. Cela est visible dans le fichier
authz du dépôt, situé dans le dossier \ProgramData\Altium\Altium365Data\Repository du PC Enterprise Server.
Navigation dans le contenu d’un dépôt de conception créé via le service local de contrôle de version basé sur SVN de l’installation Enterprise Server.
Un dépôt de conception créé via le service local de contrôle de version stocke ses données internes dans un sous-dossier correspondant du dossier \ProgramData\Altium\Altium365Data\Repository (pour une installation par défaut d’Enterprise Server). Il est recommandé de ne pas modifier ni éditer les fichiers de ce dossier, sauf par le personnel informatique à des fins de maintenance.
Synchronisation des utilisateurs Enterprise Server & VCS
Lorsqu’un nouvel utilisateur du Workspace est créé, les informations d’identification définies (User Name et Password) pour cet utilisateur sont stockées à la fois dans la base de données d’Enterprise Server et dans le service de contrôle de version, puisque ce dernier ne peut pas accéder directement au mot de passe du premier. Le mot de passe est stocké dans le service de contrôle de version au format texte brut (dans le fichier \ProgramData\Altium\Altium365Data\Repository\passwd).
Les entrées de cette liste permettent d’accéder au dépôt SVN d’Enterprise Server lors de l’utilisation du service via Altium Designer. Il peut arriver que les informations d’identification d’un utilisateur ne soient pas incluses dans le fichier, par exemple lorsque des utilisateurs du Workspace existent déjà au moment de la création du premier dépôt SVN (et non l’inverse). Cela peut être corrigé en ajoutant manuellement ces combinaisons nom/mot de passe au fichier passwd, ou en ressaisissant le mot de passe pour chaque profil utilisateur dans le Workspace – cette dernière approche renseignera le fichier passwd en conséquence, sans nécessiter d’accès direct au PC Enterprise Server.
Dans une installation par défaut d’Enterprise Server, les informations d’identification des utilisateurs sont stockées pour le service de contrôle de version dans le fichier Passwd associé.
Suppression d’un dépôt
Pour supprimer un dépôt du service de contrôle de version d’Enterprise Server, cliquez sur le contrôle Remove (
) associé à ce dépôt, sur la page VCS de l’interface navigateur du Workspace.
Notez que la suppression d’un dépôt depuis la page
Data Management – Design Repositories page de la boîte de dialogue
Preferences dans Altium Designer ne fait que retirer ce dépôt de l’utilisation par cette instance d’Altium Designer. Cela ne supprime pas le dépôt du service de contrôle de version d’Enterprise Server. Si vous vous déconnectez d’Enterprise Server puis vous reconnectez, le dépôt réapparaîtra dans la liste des dépôts disponibles pour cette instance d’Altium Designer.
Les entrées de dépôt externe peuvent être supprimées, que le dépôt contienne ou non des projets. En revanche, les dépôts locaux (ceux créés en interne via le service de contrôle de version d’Enterprise Server) ne peuvent pas être supprimés s’ils contiennent un ou plusieurs projets. Vous en serez averti et devrez d’abord supprimer les projets avant de pouvoir procéder à la suppression.
Même dans ce cas, si un dépôt local ne contient aucun projet, il ne sera pas réellement supprimé, mais déplacé vers un répertoire d’archive (\ProgramData\Altium\Altium365Data\RepositoryDumps, pour une installation par défaut d’Enterprise Server). Le dépôt sera contenu dans un fichier Dump, avec un préfixe d’ID unique (par ex. 775f6c22-b9a1-468c-9f1f-4f217bb3be6b_central design repository.dump).