magen in

Служба приема Магена

Magen Ingestion Service — это микросервис, отвечающий за загрузку цифровых данных в систему. Он предоставляет REST API для управления цифровыми активами. Под активами мы понимаем любые конфиденциальные ресурсы, которые могут быть зашифрованы или упакованы с целью ограничения доступа к ним.

Текущая версия: 1.3a16

Git-клон

Все службы Magen зависят от подмодуля операций git magen_helper . При клонировании этого репозитория обязательно укажите флаг --recursive или после клонирования выполните команду для обновления подмодуля git magen-helpers :

 git submodule update --init --recursive

Для этой службы доступны команды make . Makefile находится в папке Ingesting/

Сделать цель по умолчанию: make default . Вот список целей, доступных для приема

 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

Требования: MacOS X.

0. python3 -V : Python 3.6.3 (>= 3.6.3 )
1. pip3 -V : пип 9.0.1
2. make -v : GNU Make 3.81
3. docker -v : версия Docker 17.03.0-ce , сборка 60ccb22
4. docker-compose -v : docker-compose версия 1.11.2 , сборка dfed245
5. Убедитесь, что у вас есть правильные права на клонирование организации Cisco-Magen на GitHub.

Требования: AWS EC2 Ubuntu

0. python3 -V : Питон 3.6.3
1. pip3 -V : пип 9.0.1
2. make -v : GNU Make 4.1
3. docker -v : версия Docker 17.03.0-ce , сборка 60ccb22
4. docker-compose -v : docker-compose версия 1.11.2 , сборка dfed245
5. Убедитесь, что пользователь и root-пользователь AWS имеют правильные права на организацию Cisco-Magen на GitHub.

Цели

1. make all -> Установить зависимости Magen-Core , очистить, упаковать и установить пакет приема
2. make test -> запустить тесты приема

Примите эту инфраструктуру

1. получить helper_scripts в репозиторий
2. следуйте структуре docker_ingestion , чтобы создать файлы docker-compose.yml и Dockerfile
3. используйте Makefile в качестве примера для автоматизации сборки make

Настройка документации Sphinx

Для сервиса имеется настроенная документация Sphinx API. Для компиляции документов выполните:

make html в каталоге docs

или запустите:

make doc в каталоге ingestion