magen in

Layanan Penelanan Magen

Magen Ingestion Service adalah layanan mikro yang bertanggung jawab untuk menyerap data digital ke dalam sistem. Ini memperlihatkan REST API untuk mengelola aset digital. Yang kami maksud dengan aset adalah sumber daya sensitif apa pun yang dapat dienkripsi atau dibungkus untuk membatasi akses ke sumber daya tersebut.

Versi saat ini: 1.3a16

Klon Git

Semua layanan Magen bergantung pada submodul operasi git magen_helper . Saat mengkloning repo ini, pastikan untuk memberikan tanda --recursive atau setelah klon menjalankan perintah untuk memperbarui submodul magen-helpers git:

 git submodule update --init --recursive

Untuk Layanan Ini tersedia perintah make . Makefile terletak di bawah penyerapan/

Jadikan Target Default: make default . Berikut adalah daftar target yang tersedia untuk penyerapan

 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

Persyaratan: MacOS X

0. python3 -V : Python 3.6.3 (>= 3.6.3 )
1. pip3 -V : pip 9.0.1
2. make -v : GNU Buat 3.81
3. docker -v : Docker versi 17.03.0-ce , build 60ccb22
4. docker-compose -v : docker-compose versi 1.11.2 , build dfed245
5. Pastikan Anda memiliki hak yang benar untuk mengkloning organisasi github Cisco-Magen

Persyaratan: AWS EC2 Ubuntu

0. python3 -V : Python 3.6.3
1. pip3 -V : pip 9.0.1
2. make -v : GNU Buat 4.1
3. docker -v : Docker versi 17.03.0-ce , build 60ccb22
4. docker-compose -v : docker-compose versi 1.11.2 , build dfed245
5. Pastikan pengguna dan root AWS memiliki hak yang benar atas organisasi github Cisco-Magen

Target

1. make all -> Instal dependensi Magen-Core , bersihkan, paket, dan instal paket penyerapan
2. make test -> jalankan tes penyerapan

Adopsi Infrastruktur ini

1. dapatkan helper_scripts ke repo
2. ikuti struktur di docker_ingestion untuk membuat file docker-compose.yml dan Dockerfile
3. gunakan Makefile sebagai contoh untuk membangun otomatisasi make

Pengaturan Dokumentasi Sphinx

Ada dokumen API Sphinx yang dikonfigurasi untuk layanan ini. Untuk mengkompilasi dokumen, jalankan:

make html di direktori docs

atau jalankan:

make doc di direktori ingestion