Vitam - Contributions [fr]

ONBOARDING

2025-03-19T11:23:34Z

Ptrochet :

= Accès aux différents sites =

- [https://messagerie.culture.gouv.fr/ Messagerie Outlook]

- [https://assistance.programmevitam.fr/ Tuleap]

- Slack

- Teams

- [https://jenkins.dev.programmevitam.fr/ Jenkins]

- [https://gitlab.dev.programmevitam.fr/ GitLab de Vitam Core]

- [https://github.com/ProgrammeVitam/vitam-ui/ GitHub de Vitam UI]

- [https://github.com/ProgrammeVitam/vitam-itests/ GitHub de Vitam-itests]

- [https://www.programmevitam.fr/pages/demonstration/ Webinaires]

= Prérequis =

Linux (x86) ou MacOS (y compris Apple Silicon)

Logiciels:
* Java 17 JDK
* IntelliJ IDEA 24 (Ultimate recommandé) avec:
** Plugin multirun
** Code style pour Java: [https://assistance.programmevitam.fr/plugins/document/projetvitam/folder/50 VitamStyle_Spotless.xml] à ajouter dans les paramètres de IntelliJ: Editor > Code Style > Java > Scheme > Import Scheme > IntelliJ IDEA code style XML
* Maven 3.9.X
* Docker (utiliser Rancher Desktop pour Mac)
* nvm: <code>curl -o- <nowiki>https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh</nowiki> | bash</code>
* ansible
** installer pipx: https://pipx.pypa.io/stable/
** puis installer ansible <code>pipx install --include-deps ansible</code>
* node 18 avec la commande <code>nvm install 18 && nvm use 18</code>

Matériels:
* Mémoire vive: 16GiB
* Stockage: 20GiB

= Procédure d’installation de Vitam Core =
'''Un script d'installation est disponible. Pour la procédure: [[Installation avec script]] (à réparer)'''

== Récupération du code et mise en place de l’environnement de travail ==

Cloner le code sur https://gitlab.dev.programmevitam.fr/vitam/vitam.git ainsi que le jeu de données de test sur https://github.com/ProgrammeVitam/vitam-itests.git. Nous présumons que le dossier du code source se nomme '''vitam_repo''' par la suite.

S’assurer que JAVA_HOME et M2_HOME sont renseignés dans le <code>.bashrc</code> ou équivalent (On peut obtenir M2_HOME avec la commande <code>mvn -version</code> )

Dans le fichier vitam_repo/sources/pom.xml désactiver les modules <code>ihm-demo</code> et <code>ihm-recette</code>

Dans les paramètres IntelliJ: Editor > Code Style > Java > Scheme > Import Scheme > IntelliJ IDEA code style XML et sélectionner le code style téléchargé plus tôt

Copier le répertoire vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations vers vitam_repo/.idea/runConfigurations (si le dossier existe déjà, remplacer le contenu.)

Comme alternative, on peut utiliser la commande suivante pour effectuer la copie : cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si le dossier cible '''n'existe pas''', créez-le avant la copie :

mkdir -p vitam_repo/.idea/runConfigurations

cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si vous n’avez pas les permissions pour écrire dans le répertoire cible, ajoutez <code>sudo: sudo cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/</code>

Vérification après copie: ls -l vitam_repo/.idea/runConfigurations/

Relancer Intellij IDEA.

Editer le fichier <code>/etc/hosts</code> (ou équivalent) et y ajouter les enregistrements suivants:

# Vitam
127.0.0.1 access-external.service.consul
127.0.0.1 access-internal.service.consul
127.0.0.1 external.service.consul
127.0.0.1 functional-administration.service.consul
127.0.0.1 ingest-external.service.consul
127.0.0.1 ingest-internal.service.consul
127.0.0.1 logbook.service.consul
127.0.0.1 metadata.service.consul
127.0.0.1 offer-fs-1.service.consul
127.0.0.1 offer.service.consul
127.0.0.1 processing.service.consul
127.0.0.1 security-internal.service.consul
127.0.0.1 storage.service.consul
127.0.0.1 workspace.service.consul

== Création de l’arborescence /vitam ==

Vitam Core a besoin d’avoir un dossier stockant des données dans la racine de l’ordinateur. Voici l’arborescence nécessaire :

<pre>/vitam/
├── conf
├── data
│ ├── ihm-recette
│ │ └── test-data
│ └── storage
├── log
└── tmp
</pre>
S’assurer que tous les répertoires appartiennent à votre utilisateur (chown)

Créer dans <code>/vitam/data/storage</code> un fichier nommé <code>fr.gouv.vitam.storage.offers.workspace.driver.DriverImpl</code> avec le contenu <code>offer-fs-1.service.consul</code>

Créer un lien symbolique de <code>/vitam/data/ihm-recette/test-data/data</code> vers <code>vitam-itests/data</code> (vitam-itests étant le deuxième dépôt cloné au départ.)

On peut créer un lien symbolique en utilisant la commande suisvante: ln -s vitam-itests/data /vitam/data/ihm-recette/test-data/data

Pour vérifier que le lien symbolique a été crée taper la commande ls -l /vitam/data/ihm-recette/test-data/data

Créer un lien symbolique <code>/vitam/conf</code> qui pointe vers <code>vitam_repo/vitam-conf-dev/conf</code>: ln -s vitam_repo/vitam-conf-dev/conf/ /vitam/conf 

Aller dans <code>/vitam/conf/metadata/mapping</code> et vérifier que les fichiers <code>unit-es-mapping.json</code> et <code>og-es-mapping.json</code> sont des liens symboliques vers les fichiers dans <code>vitam_repo/deployment/environments/files/elasticsearch-mappings/</code>.

Aller dans <code>/vitam/conf/worker</code> et s’assurer que <code>plugins.json</code> est bien un lien vers <code>deployment/ansible-vitam/roles/vitam/files/worker/plugins.json</code>

Ouvrir les paramètres IntelliJ IDEA > Appearance and Behavior > Path Variables et y ajouter une variable nommée <code>vitamLocalShareFolder</code> pointant vers <code>/vitam</code>

== Compilation ==

Depuis le répertoire vitam_repo/sources exécuter la commande

<code>mvn clean install -DskipTests -P-vitam</code>

La procédure peut prendre environ 10 à 20 minutes.

== Compilation des COTS ==

Les COTS sont des dépendances externes nécessaires pour lancer le projet en local (mongo et elasticSearch)

L’option la plus simple est d’utiliser docker compose, dont le fichier .yaml se trouve dans <code>vitam_repo/dev-deployment/docker-cots</code> Puis lancer avec IntelliJ ou docker compose: <code>docker compose up</code>

== Lancement ==

Dans IntelliJ, lancer la configuration multiRun Vitam, qui doit normalement éxecuter les 13 services le composant.

== Initialisation des données ==

Lancer le script <code>init_data_vitam.sh</code> depuis <code>vitam-conf-dev/scripts</code>. Celui-ci doit s’exécuter sans erreurs.

Dans IntelliJ, exécuter la configuration nommée <code>Cucumber init</code>. Celle-ci doit s'exécuter sans erreurs.

= Procédure d'installation de Vitam-UI =

== Récupération du code et mise en place de l’environnement de travail ==

Cloner le projet: https://github.com/ProgrammeVitam/vitam-ui.git

Changer les droits si besoin <code>sudo chown -R $USER vitam-ui/</code>

Builder le projet avec maven et le profil vitam (profil spécial pour les développeurs):
<code>mvn clean install -Pvitam</code>

Ajouter dans votre fichier /etc/hosts la ligne:

# Vitam-UI
127.0.0.1 dev.vitamui.com

== Génération des certificats (optionel) ==

cd deployment
./pki/scripts/generate_ca_dev.sh true && ./pki/scripts/generate_certs_dev.sh environments/hosts.local true && ./generate_stores_dev.sh

Autoriser les certificats CA suivants dans votre navigateur:
* dev-deployment/environments/certs/server/ca/ca-intermediate.crt
* dev-deployment/environments/certs/server/ca/ca-root.crt
Avec Chrome: chrome://settings/certificates -> Authorities -> Import

Avec Firefox: about:preferences#privacy -> Certificates -> Show Certificates -> Authorities -> Import

== Initialisation des données mongo ==

Lancer le script ./tools/docker/mongo/restart_dev.sh

== Configurer Vitam-UI pour utiliser Vitam Core sur le serveur int ==

Créer un répertoire /vitam/conf/vitam-ui et ajouter [https://assistance.programmevitam.fr/plugins/docman/download/156/1 les fichiers zippés ici]:
* access-external-client.conf
* collect-external-client.conf
* ingest-external-client.conf
* external.p12
* cacerts

== Installer les dépendances Angular ==

Build de la librairie vitamui-library

<code>cd vitam-ui/ui-frontend/ npm run build:vitamui-library</code>

Installation des dépendances

<code>cd vitam-ui/ui-frontend/ npm install</code>

== Lancer Vitam-UI en local ==

Lancer les runners suivants:
* security
* IAM
* CAS
* archive-search
* API gateway
* Angular: portal
* Angular identity
* Angular: archive-search

== Vérifier que Vitam-UI fonctionne ==

Lancer le portail: https://dev.vitamui.com:4200/

Connectez-vous avec le compte: admin@change-it.fr / password

Naviguer dans l'application

= Création des MR / PR =

Vous trouverez [https://mediawiki.dev.programmevitam.fr/index.php/Cr%C3%A9ation_d%27une_MR_/_PR ici] comment créer une MR / PR (règles de nommage, etc.):

2025-03-13T17:25:37Z

Ptrochet :

== Accès aux différents sites ==
- [https://messagerie.culture.gouv.fr/ Messagerie Outlook]

- [https://assistance.programmevitam.fr/ Tuleap]

- Slack

- Teams

- [https://jenkins.dev.programmevitam.fr/ Jenkins]

- [https://gitlab.dev.programmevitam.fr/ GitLab de Vitam Core]

- [https://github.com/ProgrammeVitam/vitam-ui/ GitHub de Vitam UI]

- [https://github.com/ProgrammeVitam/vitam-itests/ GitHub de Vitam-itests]

- [https://www.programmevitam.fr/pages/demonstration/ Webinaires]

<h1>
Procédure d’installation de Vitam Core
</h1>

'''Un script d'installation est disponible. Pour la procédure: [[Installation avec script]]'''

= Prérequis =

Linux (x86) ou MacOS (y compris Apple Silicon)

Logiciels: - IntelliJ IDEA 24 (Ultimate recommandé) - Plugin multirun - Code style: [https://assistance.programmevitam.fr/plugins/document/projetvitam/folder/50 VitamStyle_Spotless.xml] - Maven 3.9.X - Java 17 JDK - Docker (utiliser Rancher Desktop pour Mac)

Matériels: - Mémoire vive: 16GiB - Stockage: 20GiB
= Récupération du code et mise en place de l’environnement de travail =

Cloner le code sur https://gitlab.dev.programmevitam.fr/vitam/vitam.git ainsi que le jeu de données de test sur https://github.com/ProgrammeVitam/vitam-itests.git. Nous présumons que le dossier du code source se nomme '''vitam_repo''' par la suite.

S’assurer que JAVA_HOME et M2_HOME sont renseignés dans le <code>.bashrc</code> ou équivalent (On peut obtenir M2_HOME avec la commande <code>mvn -version</code> )

Dans le fichier vitam_repo/sources/pom.xml désactiver les modules <code>ihm-demo</code> et <code>ihm-recette</code>

Télécharger et installer NVM en utilisant comme alternative ou équivalent, la commande: curl -o- <nowiki>https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh</nowiki> | bash

S'assurer que nvm est installé: nvm --version

Installer node 18 avec la commande <code>nvm install 18 && nvm use 18</code>

Dans les paramètres IntelliJ: Editor > Code Style > Java > Scheme > Import Scheme > IntelliJ IDEA code style XML et sélectionner le code style téléchargé plus tôt

Copier le répertoire vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations vers vitam_repo/.idea/runConfigurations (si le dossier existe déjà, remplacer le contenu.)

Comme alternative, on peut utiliser la commande suivante pour effectuer la copie : cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si le dossier cible '''n'existe pas''', créez-le avant la copie :

mkdir -p vitam_repo/.idea/runConfigurations

cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si vous n’avez pas les permissions pour écrire dans le répertoire cible, ajoutez <code>sudo: sudo cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/</code>

Vérification après copie: ls -l vitam_repo/.idea/runConfigurations/

Relancer Intellij IDEA.

Editer le fichier <code>/etc/hosts</code> (ou équivalent) et y ajouter les enregistrements suivants:
# Vitam
127.0.0.1 access-external.service.consul
127.0.0.1 access-internal.service.consul
127.0.0.1 external.service.consul
127.0.0.1 functional-administration.service.consul
127.0.0.1 ingest-external.service.consul
127.0.0.1 ingest-internal.service.consul
127.0.0.1 logbook.service.consul
127.0.0.1 metadata.service.consul
127.0.0.1 offer-fs-1.service.consul
127.0.0.1 offer.service.consul
127.0.0.1 processing.service.consul
127.0.0.1 security-internal.service.consul
127.0.0.1 storage.service.consul
127.0.0.1 workspace.service.consul

= Création de l’arborescence /vitam =

Vitam Core a besoin d’avoir un dossier stockant des données dans la racine de l’ordinateur. Voici l’arborescence nécessaire :

<pre>/vitam/
├── conf
├── data
│ ├── ihm-recette
│ │ └── test-data
│ └── storage
├── log
└── tmp
</pre>
S’assurer que tous les répertoires appartiennent à votre utilisateur (chown)

Créer dans <code>/vitam/data/storage</code> un fichier nommé <code>fr.gouv.vitam.storage.offers.workspace.driver.DriverImpl</code> avec le contenu <code>offer-fs-1.service.consul</code>

Créer un lien symbolique de <code>/vitam/data/ihm-recette/test-data/data</code> vers <code>vitam-itests/data</code> (vitam-itests étant le deuxième dépôt cloné au départ.)

On peut créer un lien symbolique en utilisant la commande suisvante: ln -s /vitam/data/ihm-recette/test-data/data vitam-itests/data

Pour vérifier que le lien symbolique a été crée taper la commande ls -l vitam-itests/data

Créer un lien symbolique <code>/vitam/conf</code> qui pointe vers <code>vitam_repo/vitam-conf-dev/conf</code>: ln -s vitam_repo/vitam-conf-dev/conf/ /vitam/conf 

Aller dans <code>/vitam/conf/metadata/mapping</code> et vérifier que les fichiers <code>unit-es-mapping.json</code> et <code>og-es-mapping.json</code> sont des liens symboliques vers les fichiers dans <code>vitam_repo/deployment/environments/files/elasticsearch-mappings/</code>.

Aller dans <code>/vitam/conf/worker</code> et s’assurer que <code>plugins.json</code> est bien un lien vers <code>deployment/ansible-vitam/roles/vitam/files/worker/plugins.json</code>

Ouvrir les paramètres IntelliJ IDEA > Appearance and Behavior > Path Variables et y ajouter une variable nommée <code>vitamLocalShareFolder</code> pointant vers <code>/vitam</code>

= Compilation =

Depuis le répertoire vitam_repo/sources exécuter la commande

<code>mvn clean install -DskipTests -P-vitam</code>

La procédure peut prendre environ 10 à 20 minutes.
== Compilation des COTS ==

Les COTS sont des dépendances externes nécessaires pour lancer le projet en local (mongo et elasticSearch)

L’option la plus simple est d’utiliser docker compose, dont le fichier .yaml se trouve dans <code>vitam_repo/dev-deployment/docker-cots</code> Puis lancer avec IntelliJ ou docker compose: <code>docker compose up</code>
= Lancement =

Dans IntelliJ, lancer la configuration multiRun Vitam, qui doit normalement éxecuter les 13 services le composant.
= Initialisation des données =

Lancer le script <code>init_data_vitam.sh</code> depuis <code>vitam-conf-dev/scripts</code>. Celui-ci doit s’exécuter sans erreurs.

Dans IntelliJ, exécuter la configuration nommée <code>Cucumber init</code>. Celle-ci doit s'exécuter sans erreurs.

ONBOARDING

2025-03-13T17:23:43Z

Ptrochet :

== Accès aux différents sites ==
- [https://messagerie.culture.gouv.fr/ Messagerie Outlook]

- [https://assistance.programmevitam.fr/ Tuleap]

- Slack

- Teams

- [https://jenkins.dev.programmevitam.fr/ Jenkins]

- [https://gitlab.dev.programmevitam.fr/ GitLab de Vitam Core]

- [https://github.com/ProgrammeVitam/vitam-ui/ GitHub de Vitam UI]

- [https://github.com/ProgrammeVitam/vitam-itests/ GitHub de Vitam-itests]

- [https://www.programmevitam.fr/2023/11/13/vitam-en-ligne-interventions/ Webinaires]

<h1>
Procédure d’installation de Vitam Core
</h1>

'''Un script d'installation est disponible. Pour la procédure: [[Installation avec script]]'''

= Prérequis =

Linux (x86) ou MacOS (y compris Apple Silicon)

Logiciels: - IntelliJ IDEA 24 (Ultimate recommandé) - Plugin multirun - Code style: [https://assistance.programmevitam.fr/plugins/document/projetvitam/folder/50 VitamStyle_Spotless.xml] - Maven 3.9.X - Java 17 JDK - Docker (utiliser Rancher Desktop pour Mac)

Matériels: - Mémoire vive: 16GiB - Stockage: 20GiB
= Récupération du code et mise en place de l’environnement de travail =

Cloner le code sur https://gitlab.dev.programmevitam.fr/vitam/vitam.git ainsi que le jeu de données de test sur https://github.com/ProgrammeVitam/vitam-itests.git. Nous présumons que le dossier du code source se nomme '''vitam_repo''' par la suite.

S’assurer que JAVA_HOME et M2_HOME sont renseignés dans le <code>.bashrc</code> ou équivalent (On peut obtenir M2_HOME avec la commande <code>mvn -version</code> )

Dans le fichier vitam_repo/sources/pom.xml désactiver les modules <code>ihm-demo</code> et <code>ihm-recette</code>

Télécharger et installer NVM en utilisant comme alternative ou équivalent, la commande: curl -o- <nowiki>https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh</nowiki> | bash

S'assurer que nvm est installé: nvm --version

Installer node 18 avec la commande <code>nvm install 18 && nvm use 18</code>

Dans les paramètres IntelliJ: Editor > Code Style > Java > Scheme > Import Scheme > IntelliJ IDEA code style XML et sélectionner le code style téléchargé plus tôt

Copier le répertoire vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations vers vitam_repo/.idea/runConfigurations (si le dossier existe déjà, remplacer le contenu.)

Comme alternative, on peut utiliser la commande suivante pour effectuer la copie : cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si le dossier cible '''n'existe pas''', créez-le avant la copie :

mkdir -p vitam_repo/.idea/runConfigurations

cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/

Si vous n’avez pas les permissions pour écrire dans le répertoire cible, ajoutez <code>sudo: sudo cp -r vitam_repo/vitam-conf-dev/intellig-conf/runConfigurations/* vitam_repo/.idea/runConfigurations/</code>

Vérification après copie: ls -l vitam_repo/.idea/runConfigurations/

Relancer Intellij IDEA.

Editer le fichier <code>/etc/hosts</code> (ou équivalent) et y ajouter les enregistrements suivants:
# Vitam
127.0.0.1 access-external.service.consul
127.0.0.1 access-internal.service.consul
127.0.0.1 external.service.consul
127.0.0.1 functional-administration.service.consul
127.0.0.1 ingest-external.service.consul
127.0.0.1 ingest-internal.service.consul
127.0.0.1 logbook.service.consul
127.0.0.1 metadata.service.consul
127.0.0.1 offer-fs-1.service.consul
127.0.0.1 offer.service.consul
127.0.0.1 processing.service.consul
127.0.0.1 security-internal.service.consul
127.0.0.1 storage.service.consul
127.0.0.1 workspace.service.consul

= Création de l’arborescence /vitam =

Vitam Core a besoin d’avoir un dossier stockant des données dans la racine de l’ordinateur. Voici l’arborescence nécessaire :

<pre>/vitam/
├── conf
├── data
│ ├── ihm-recette
│ │ └── test-data
│ └── storage
├── log
└── tmp
</pre>
S’assurer que tous les répertoires appartiennent à votre utilisateur (chown)

Créer dans <code>/vitam/data/storage</code> un fichier nommé <code>fr.gouv.vitam.storage.offers.workspace.driver.DriverImpl</code> avec le contenu <code>offer-fs-1.service.consul</code>

Créer un lien symbolique de <code>/vitam/data/ihm-recette/test-data/data</code> vers <code>vitam-itests/data</code> (vitam-itests étant le deuxième dépôt cloné au départ.)

On peut créer un lien symbolique en utilisant la commande suisvante: ln -s /vitam/data/ihm-recette/test-data/data vitam-itests/data

Pour vérifier que le lien symbolique a été crée taper la commande ls -l vitam-itests/data

Créer un lien symbolique <code>/vitam/conf</code> qui pointe vers <code>vitam_repo/vitam-conf-dev/conf</code>: ln -s vitam_repo/vitam-conf-dev/conf/ /vitam/conf 

Aller dans <code>/vitam/conf/metadata/mapping</code> et vérifier que les fichiers <code>unit-es-mapping.json</code> et <code>og-es-mapping.json</code> sont des liens symboliques vers les fichiers dans <code>vitam_repo/deployment/environments/files/elasticsearch-mappings/</code>.

Aller dans <code>/vitam/conf/worker</code> et s’assurer que <code>plugins.json</code> est bien un lien vers <code>deployment/ansible-vitam/roles/vitam/files/worker/plugins.json</code>

Ouvrir les paramètres IntelliJ IDEA > Appearance and Behavior > Path Variables et y ajouter une variable nommée <code>vitamLocalShareFolder</code> pointant vers <code>/vitam</code>

= Compilation =

Depuis le répertoire vitam_repo/sources exécuter la commande

<code>mvn clean install -DskipTests -P-vitam</code>

La procédure peut prendre environ 10 à 20 minutes.
== Compilation des COTS ==

Les COTS sont des dépendances externes nécessaires pour lancer le projet en local (mongo et elasticSearch)

L’option la plus simple est d’utiliser docker compose, dont le fichier .yaml se trouve dans <code>vitam_repo/dev-deployment/docker-cots</code> Puis lancer avec IntelliJ ou docker compose: <code>docker compose up</code>
= Lancement =

Dans IntelliJ, lancer la configuration multiRun Vitam, qui doit normalement éxecuter les 13 services le composant.
= Initialisation des données =

Lancer le script <code>init_data_vitam.sh</code> depuis <code>vitam-conf-dev/scripts</code>. Celui-ci doit s’exécuter sans erreurs.

Dans IntelliJ, exécuter la configuration nommée <code>Cucumber init</code>. Celle-ci doit s'exécuter sans erreurs.