magen in

Magen-Ingestion-Service

Magen Ingestion Service ist ein Mikroservice, der für die Aufnahme digitaler Daten in das System verantwortlich ist. Es stellt die REST-API für die Verwaltung digitaler Assets bereit. Unter Vermögenswerten verstehen wir alle sensiblen Ressourcen, die verschlüsselt oder verpackt werden könnten, um den Zugriff darauf einzuschränken.

Aktuelle Version: 1.3a16

Git-Klon

Alle Magen-Dienste hängen von einem Operations-Git-Submodul magen_helper ab. Stellen Sie beim Klonen dieses Repos sicher, dass Sie das Flag --recursive angeben oder nach dem Klonen einen Befehl ausführen, um magen-helpers Git-Submodul zu aktualisieren:

 git submodule update --init --recursive

Für diesen Dienst stehen make -Befehle zur Verfügung. Makefile befindet sich unter ingestion/

Als Standardziel festlegen: make default . Hier ist die Liste der zur Aufnahme verfügbaren Ziele

 default :
	@echo ' Makefile for Magen Ingestion Service '
	@echo
	@echo ' Usage: '
	@echo '	make clean    		:Remove packages from system and pyc files '
	@echo '	make test     		:Run the test suite '
	@echo '	make package  		:Create Python wheel package '
	@echo '	make install  		:Install Python wheel package '
	@echo '	make all      		:clean->package->install '
	@echo '	make list     		:List of All Magen Dependencies '
	@echo '	make build_docker 	:Pull Base Docker Image and Current Image '
	@echo '	make run_docker   	:Build and Run required Docker containers with mounted source '
	@echo '	make runpkg_docker	:Build and Run required Docker containers with created wheel '
	@echo '	make test_docker  	:Build, Start and Run tests inside main Docker container interactively '
	@echo '	make stop_docker  	:Stop and Remove All running Docker containers '
	@echo '	make clean_docker 	:Remove Docker unused images '
	@echo '	make rm_docker    	:Remove All Docker images if no containers running '
	@echo '	make doc		:Generate Sphinx API docs '
	@echo
	@echo

Anforderungen: MacOS X

0. python3 -V : Python 3.6.3 (>= 3.6.3 )
1. pip3 -V : pip 9.0.1
2. make -v : GNU Make 3.81
3. docker -v : Docker-Version 17.03.0-ce , Build 60ccb22
4. docker-compose -v : Docker-Compose-Version 1.11.2 , Build dfed245
5. Stellen Sie sicher, dass Sie über die richtigen Rechte zum Klonen der Cisco-Magen-Github-Organisation verfügen

Anforderungen: AWS EC2 Ubuntu

0. python3 -V : Python 3.6.3
1. pip3 -V : pip 9.0.1
2. make -v : GNU Make 4.1
3. docker -v : Docker-Version 17.03.0-ce , Build 60ccb22
4. docker-compose -v : Docker-Compose-Version 1.11.2 , Build dfed245
5. Stellen Sie sicher, dass AWS-Benutzer und Root über die richtigen Rechte für die Cisco-Magen-Github-Organisation verfügen

Ziele

1. make all -> Magen-Core- Abhängigkeiten installieren, bereinigen, packen und Aufnahmepaket installieren
2. make test -> Aufnahmetests ausführen

Übernehmen Sie diese Infrastruktur

1. Holen Sie sich helper_scripts in das Repo
2. Folgen Sie der Struktur in docker_ingestion, um die Dateien docker-compose.yml und Dockerfile zu erstellen
3. Verwenden Sie Makefile als Beispiel für die Erstellung einer Make-Automatisierung

Sphinx-Dokumentationssetup

Für den Dienst gibt es eine konfigurierte Sphinx-API-Dokumentation. Um Dokumente zu kompilieren, führen Sie Folgendes aus:

make html im docs -Verzeichnis

oder ausführen:

make doc im ingestion