Aggiunta di collegamenti simbolici a GIT

Sommario

<- Precedente: Dispatcher Verifica stato

In AMS otterrai un archivio GIT precompilato contenente il codice sorgente del dispatcher, pronto per iniziare lo sviluppo e la personalizzazione.

Dopo aver creato il primo file .vhost o il file farm.any di primo livello, sarà necessario creare un collegamento simbolico dalla directory available_* alla directory enabled_*. L’utilizzo del tipo di collegamento corretto sarà fondamentale per una distribuzione corretta tramite la pipeline di Cloud Manager. Questa pagina ti aiuterà a capire come farlo.

Archetipo Dispatcher

Lo sviluppatore AEM avvia il progetto in genere dall'archetipo AEM

Ecco un esempio dell’area del codice sorgente in cui puoi vedere i symlink utilizzati:

$ tree dispatcher
dispatcher
└── src
   ├── conf.d
.....SNIP.....
    │   └── available_vhosts
    │   │   ├── 000_unhealthy_author.vhost
    │   │   ├── 000_unhealthy_publish.vhost
    │   │   ├── aem_author.vhost
    │   │   ├── aem_flush.vhost
    │   │   ├── aem_health.vhost
    │   │   ├── aem_lc.vhost
    │   │   └── aem_publish.vhost
    └── dispatcher_vhost.conf
    │   └── enabled_vhosts
    │   │   ├── aem_author.vhost -> ../available_vhosts/aem_author.vhost
    │   │   ├── aem_flush.vhost -> ../available_vhosts/aem_flush.vhost
    │   │   ├── aem_health.vhost -> ../available_vhosts/aem_health.vhost
    │   │   └── aem_publish.vhost -> ../available_vhosts/aem_publish.vhost
.....SNIP.....
    └── conf.dispatcher.d
    │   ├── available_farms
    │   │   ├── 000_ams_author_farm.any
    │   │   ├── 001_ams_lc_farm.any
    │   │   └── 002_ams_publish_farm.any
.....SNIP.....
    │   └── enabled_farms
    │   │   ├── 000_ams_author_farm.any -> ../available_farms/000_ams_author_farm.any
    │   │   └── 002_ams_publish_farm.any -> ../available_farms/002_ams_publish_farm.any
.....SNIP.....
17 directories, 60 files

Ad esempio, la directory /etc/httpd/conf.d/available_vhosts/ contiene i potenziali file .vhost di staging che è possibile utilizzare nella configurazione in esecuzione.

I file .vhost abilitati verranno visualizzati come percorso relativo symlinks nella directory /etc/httpd/conf.d/enabled_vhosts/.

Creazione di un collegamento simbolico

Utilizziamo collegamenti simbolici al file in modo che il server web Apache tratti il file di destinazione come lo stesso file. Non è necessario duplicare il file in entrambe le directory. ma solo un collegamento da una directory (collegamento simbolico) all’altra.

Riconosci che le configurazioni implementate verranno indirizzate a un host Linux. La creazione di un collegamento simbolico non compatibile con il sistema di destinazione causerà errori e risultati indesiderati.

Se la tua workstation non è un computer Linux, probabilmente ti chiederai quali comandi utilizzare per creare correttamente questi collegamenti in modo che possano eseguirne il commit in GIT.

TIP: È importante utilizzare collegamenti relativi perché se si installasse una copia locale di Apache Web Server e si disponesse di una base di installazione diversa, i collegamenti continuerebbero a funzionare. Se utilizzi un percorso assoluto, la workstation o altri sistemi dovrebbero corrispondere esattamente alla stessa struttura di directory.

OSX/Linux

I collegamenti simbolici sono nativi di questi sistemi operativi e di seguito sono riportati alcuni esempi di come crearli. Apri l’applicazione terminale preferita e utilizza i seguenti comandi di esempio per creare il collegamento:

$ cd <LOCATION OF CLONED GIT REPO>\src\conf.d\enabled_vhosts
$ ln -s ../available_vhosts/<Destination File Name> <Target File Name>

Di seguito è riportato un esempio di comando popolato come riferimento:

$ git clone https://github.com/adobe/aem-project-archetype.git
$ cd aem-project-archetype/src/main/archetype/dispatcher.ams/src/conf.d/enabled_vhosts/
$ ln -s ../available_vhosts/aem_flush.vhost aem_flush.vhost

Di seguito è riportato un esempio del collegamento, se si elenca il file utilizzando il comando ls:

ls -l
total 0
lrwxrwxrwx. 1 root root 35 Oct 13 21:38 aem_flush.vhost -> ../available_vhosts/aem_flush.vhost

Windows

Note: MS Windows (meglio, NTFS) supporta i collegamenti simbolici da quando… Windows Vista

Il comando mklink Warning: per creare symlink richiede privilegi di amministratore per essere eseguito correttamente. Anche come account amministratore, è necessario eseguire il prompt dei comandi "Come amministratore" a meno che non sia stata abilitata la modalità sviluppatore

Autorizzazioni non appropriate:


Autorizzazioni appropriate:

Di seguito sono riportati i comandi per creare il collegamento:

C:\<PATH TO SRC>\enabled_vhosts> mklink <Target File Name> ..\available_vhosts\<Destination File Name>

Di seguito è riportato un esempio di comando popolato come riferimento:

C:\> git clone https://github.com/adobe/aem-project-archetype.git
C:\> cd aem-project-archetype\src\main\archetype\dispatcher.ams\src\conf.d\enabled_vhosts\
C:\aem-project-archetype\src\main\archetype\dispatcher.ams\src\conf.d\enabled_vhosts> mklink aem_flush.vhost ..\available_vhost\aem_flush.vhost
symbolic link created for aem_flush.vhost <<===>> ..\available_vhosts\aem_flush.vhost

Modalità sviluppatore ( Windows 10 )

Quando viene attivata la Modalità sviluppatore, Windows 10 consente di testare più facilmente le app che si stanno sviluppando, utilizzare l'ambiente Ubuntu Bash Shell, modificare una serie di impostazioni incentrate sugli sviluppatori e eseguire altre operazioni di questo tipo.

Microsoft sembra continuare ad aggiungere funzionalità alla modalità Sviluppatore, o abilitare alcune di queste funzionalità per impostazione predefinita una volta che raggiungono un’adozione più diffusa e sono considerate stabili (ad esempio con Creators Update, l’ambiente Ubuntu Bash Shell non ha più bisogno della modalità Sviluppatore).

E i symlink? Con Modalità sviluppatore ABILITATA, non è necessario eseguire un prompt dei comandi con privilegi elevati per creare symlink. Pertanto, una volta abilitata la modalità Sviluppatore, tutti gli utenti possono creare symlink.

Dopo aver abilitato la modalità Sviluppatore, gli utenti devono disconnettersi/accedere per rendere effettive le modifiche.

Ora è possibile vedere senza eseguire come amministratore il comando funziona

Approccio alternativo/programmatico

Esiste un criterio specifico che consente ad alcuni utenti di creare collegamenti simbolici → Creare collegamenti simbolici (Windows 10) - Protezione di Windows | Documentazione di Microsoft

PRO:

CON:

Per rendere effettive le modifiche ai criteri locali/di gruppo sarà necessario disconnettersi/accedere dall'utente.

Eseguire gpedit.msc, aggiungere/modificare gli utenti in base alle esigenze. Per impostazione predefinita, gli amministratori sono presenti

Abilita collegamenti simbolici in GIT

Git gestisce i symlink in base all’opzione core.symlinks

Source: Git - documentazione git-config

Se core.symlinks è false, i collegamenti simbolici vengono estratti come piccoli file semplici che contengono il testo del collegamento. git-update-index[1] e git-add[1] non modificheranno il tipo registrato in file normale. Utile su file system come FAT che non supportano collegamenti simbolici.
Il valore predefinito è true, ad eccezione di git-clone[1] o git-init[1] will probe and set core.symlinks false if appropriate when the repository is created. Nella maggior parte dei casi, Git presuppone che Windows non sia adatto per i collegamenti simbolici e imposterà questo valore su false.

Il comportamento di Git su Windows è ben spiegato qui: Collegamenti simbolici · Git-for-windows/git Wiki · GitHub

Info: i presupposti elencati nella documentazione qui sopra sembrano essere corretti con una possibile configurazione di AEM Developer su Windows, in particolare NTFS e il fatto che abbiamo solo file symlink rispetto a directory symlink

Ecco la buona notizia, dal momento che Git per Windows versione 2.10.2 il programma di installazione ha un'opzione esplicita per abilitare il supporto di collegamenti simbolici.

Warning: è possibile specificare l'opzione core.symlink in fase di esecuzione durante la clonazione dell'archivio oppure archiviarla come configurazione globale.

Git per Windows memorizzerà le preferenze globali in "C:\Program Files\Git\etc\gitconfig". Queste impostazioni potrebbero non essere considerate da altre app client desktop Git.
Questo è il problema, non tutti gli sviluppatori utilizzeranno il client nativo Git (ad esempio Git Cmd, Git Bash) e alcune delle app desktop Git (ad esempio GitHub Desktop, Atlassian Source) potrebbero avere impostazioni/impostazioni predefinite diverse per utilizzare System o un Git incorporato

Ecco un esempio di ciò che si trova all'interno del file gitconfig

[diff "astextplain"]
    textconv = astextplain
[filter "lfs"]
    clean = git-lfs clean -- %f
    smudge = git-lfs smudge -- %f
    process = git-lfs filter-process
    required = true
[http]
    sslBackend = openssl
    sslCAInfo = C:/Program Files/Git/mingw64/ssl/certs/ca-bundle.crt
[core]
    autocrlf = true
    fscache = true
    symlinks = true
[pull]
    rebase = false
[credential]
    helper = manager-core
[credential "https://dev.azure.com"]
    useHttpPath = true
[init]
    defaultBranch = master

Suggerimenti della riga di comando Git

In alcuni casi potrebbe essere necessario creare nuovi collegamenti simbolici, ad esempio aggiungendo un nuovo host o una nuova farm.

Nella documentazione di cui sopra è stato illustrato che Windows offre un comando "mklink" per la creazione di collegamenti simbolici.

Se si lavora in un ambiente Git Bash, è possibile utilizzare il comando Bash standard ln -s, ma deve essere preceduto da un'istruzione speciale come nell'esempio seguente:

MSYS=winsymlinks:nativestrict ln -s test_vhost_symlink ../dispatcher/src/conf.d/available_vhosts/default.vhost

Riepilogo

Per poter gestire correttamente i symlink Git (almeno per l’ambito della linea di base di configurazione del dispatcher AEM corrente) su un sistema operativo Microsoft Windows, è necessario:

Note: Se si dispone già di un repository locale, sarà necessario clonare nuovamente dall'origine. Puoi clonare in una nuova posizione e unire manualmente le modifiche locali non salvate/non gestite nell’archivio appena clonato.