Archi installeren
Inhoud
De architectuur modelleringstool Archi wordt gebruikt voor het ontwikkelen en onderhouden van het GEMMA ArchiMate-model. Eén van de redenen waarom is gekozen voor Archi is dat dit een open source tool is, waardoor het zeer laagdrempelig is om met deze tool te starten. Daarnaast is Archi gewoon een fijne tool, biedt zeer goede ArchiMate-ondersteuning en bevat uitstekende samenwerk functionaliteit.
Installeren[bewerken]
Gebruik gerust de nieuwste versie van Archi. De ervaring leert dat de Archi releases zeer stabiel zijn.
Voor het GEMMA Archimate-model en de van de GEMMA afgeleide projectmodellen geldt de eis dat minimaal versie 4.7 of hoger moet worden gebruikt. Reden hiervoor is:
- ondersteuning voor ArchiMate 3.1 (vanaf Archi 4.6)
- het samenvoegen van projectmodellen en het GEMMA Archimate-model (interne en geëxporteerde id's gelijk aan elkaar vanaf versie 4.7)
Voor Windows kun je kiezen voor de installeerbare versie of voor de portable versie
- als je meerdere versies naast elkaar wilt gebruiken, dan moet één van de versies portable zijn.
- Let op: ook de portable versie gebruikt default je profiel in je home directory
Verder geen bijzonderheden verder voor het installeren van Archi, volg de instructies van de site
Configureren[bewerken]
Voer onderstaande configuratie uit om goed te kunnen werken met de GEMMA architectuurmodellen
- voor standaard GEMMA kleuren en figuren importeer het voorkeurschema GEMMA_color.prefs uit de GEMMA repository
- Edit > Preferences > Colors and fonts
- import schema GEMMA_color.prefs
- Edit > Preferences > Diagram > tab Default figures
- wijzig de default figures voor Application component, Device, Grouping en Node (kies figure in rechter kolom)
- Edit > Preferences > Colors and fonts
- Optioneel, enkele persoonlijke handige instellingen voor het modelleren
- Automatic Relation Management
- Edit > Preferences > Connection > ARM
- Uitlijning op grid
- Zorg ervoor dat de grid-size en de grootte voor nieuwe figuren veelvouden van elkaar zijn. Voor de GEMMA worden de onderstaande grid-size en figure size gebruikt:
- Edit > Preferences > Diagram
- Wijzig de default grid-size van 12 naar 10;
- Edit > Preferences > General tab Appearance
- Wijzig de default size for new ArchiMate figures van 120 bij 55 naar 130 bij 60;
- Regeltje meer ruimte
- Edit > Preferences > Appearance
- De status bar toont welk object geselecteerd is. De titelbalk van het properties window toont deze informatie ook.
- Zet show status bar uit voor een extra regel ruimte
- Automatic Relation Management
Plugin coArchi[bewerken]
Wil je in Archi met verschillende versies van het architectuurmodel werken of je wilt met meerdere mensen aan één model samenwerken, dan heb je de collaboration plugin nodig en een git repository.
Zie coArchi – Model Collaboration for Archi voor documentatie
Voor het installeren van de plug-ins, volg de installatie instructies van de Archi website. Ga vervolgens naar de Archi plug-in pagina.
- Download de coArchi – Model Collaboration for Archi plug-in om samen te kunnen werken aan een architectuurmodel in een git-repository
- Ga naar Setup and Configuration
Samenwerken op GitHub[bewerken]
Let op: de ArchiMate-repositories zijn verhuisd van GitLab naar GitHub.
Welke git-provider gebruik je?[bewerken]
Git is gestandaardiseerd, het maakt eigenlijk niet uit welke provider je kiest. Het git gedeelte is overal hetzelfde. Wel zijn er verschillen tussen bijvoorbeeld GitHub of GitLab in hoe de site werkt en hoe je met mensen naast git kunt communiceren en samenwerken.
- Kies de provider die je fijn vind werken, je kunt een repository altijd verplaatsen naar een andere provider
- De VNG ArchiMate repositories vind je bij GitHub onder de VNG-Realisatie organisatie
- De GEMMA ArchiMate-repositories zijn publiek, dus voor iedereen toegankelijk
- Heb je toegang nodig tot een andere repository, maak dan een een account bij GitHub en vraag om toegang
- Als je een model met gemeenten wilt delen, dan kun je een verzoek indienen voor een repository onder de VNG Realisatie organisatie.
Inloggen bij GitHub met Archi[bewerken]
Hier worden de verschillende opties beschreven hoe je met Archi kunt inloggen bij GitHub. Als je met de browser naar GitHub gaat, dan log je in met een username password (en voor enkele acties nog een extra passcode). Echter als je met een tool - zoals Archi - met een git repository wilt werken, zijn er meer opties.
Hieronder de opties en enkele afwegingen om daaruit te kiezen.
- Inloggen met een username password (let op, dit werkt niet als je je account met 2FA authentication hebt beveiligd)
- niets extra aanmaken en configureren en dus een snelle start
- vanuit Archi zul je per repository moeten inloggen om toegang te krijgen
- Inloggen met een token voor API-clients (en Archi is een API-client)
- eenvoudig op te zetten
- met een token krijgt Archi (een API-client) toegang tot GitHub onder jouw account
- Zie Managing your personal access tokens voor hoe je een token maakt
- Gebruik vervolgens het token als wachtwoord in Archi
- Authenticeren met een SSH-key en PAT-Key (Personal Acces Token) van GitHub
- meer werk om op te zetten (key creëren en configureren)
- met een SSH-key is voor Archi de toegang tot alle repositories in één keer geregeld
- én meteen ook voor een andere git-client
Hoe maak je een een SSH-key aan (optioneel)[bewerken]
Voor het aanmaken en installeren van een SSH-key, zie Connecting to GitHub with SSH
Tips voor het het werken met SSH-key:
- gebruik de defaults
- gebruik één key en wees hier zuinig op
- Als je geen vertrouwen hebt dat je private key veilig is op de plek waar je deze bewaart, beveilig deze dan met een passphrase
Instructies voor Windows
- plaats deze key op je laptop op de default locatie met de default naam => voor Windows is dit
c:\User\<username>\.ssh\id_rsa
Instructies voor macOS
- Open een Terminal scherm
- Maak een SSH-keypair aan:
ssh-keygen -m PEM -t rsa -C "email@example.com"
- Accepteer de voorgestelde bestandsnaam
- Geef indien gewenst een wachtwoord op
- Kopieer de private key naar het klembord
pbcopy < ~/.ssh/id_rsa.pub
- Log in op de Git omgeving en vul de inhoud van het klembord in bij de SSH sleutels
Aanmaken van een PAT-Key (Personal Access Token) op GitHub[bewerken]
PAT-keys zijn een alternatief voor het gebruik van wachtwoorden voor verificatie aan GitHub bij gebruik van de GitHub API of de command line.
- Log in op je GitHub account
- Klik op je avatar/icoon rechtsboven en selecteer "Settings".
- Scroll in het menu links helemaal naar beneden naar "<> Developer settings"
- Selecteer in het linker menu Personal access tokens (classic)
- Klik op Generate new token en kies daar de classic variant "Personal access tokens (classic)"
- Geef je PAT-Key een duidelijke naam en selecteer alle opties. Vergeet niet de expiratie op de gewenste periode te zetten.
- Klik daarna op "Generate token"
- Kopieer je PAT-key en bewaar deze goed (bijvoorbeeld in een wachtwoord-manager)
Invullen login gegevens in Archi[bewerken]
Om te kunnen samenwerken aan architectuurmodellen, waaronder het GEMMA architectuurmodel in een repository op GitHub
- Edit > Preferences > Collaboration
- Vul je naam en email in. Onder deze naam laat git zien dat jij een wijziging hebt doorgevoerd
- Workspace default laten. Dit is de directory waar Archi voor iedere repository een .git directory aanmaakt (voor lokale wijzigingen) en waar een tijdelijk <repository>.archimate bestand wordt bewaard
- SSH Authentication; invullen als je kiest voor een ssh-key. Als je je key beveiligd met een wachtwoord,.
- HTTP authentication; default vink laten staan
- je kunt inloggen met username en password of PAT-Key
- of met de API-key
Op https://github.com/archimatetool/archi-modelrepository-plugin/wiki/Troubleshooting-Connection-Issues vind je de meeste voorkomende problemen wanneer je het model niet kan ophalen of bewerken.