Skip to content

Core Module for Magen Data Leak Prevention Software

License

Notifications You must be signed in to change notification settings

magengit/magen-core

Repository files navigation

Magen-Core

Build Status codecov Code Health

This repo contains infrastructure Magen Packages.

Git clone

All of Magen services depend on an operations git submodule magen_helper. When cloning this repo, make sure to provide --recursive flag or after the clone execute a command to update magen-helpers git submodule:

git submodule update --init --recursive

Current List of Packages under Magen-Core:

Package Name Python Wheel
magen_logaru magen_logger-1.0a1-py3-none-any.whl
magen_utils magen_utils-1.2a2-py3-none-any.whl
magen_datastore magen_datastore-1.0a1-py3-none-any.whl
magen_rest magen_rest_service-1.2a4-py3-none-any.whl
magen_stats magen_statistics_service-1.1a1-py3-none-any.whl
magen_mongo magen_mongo-1.1a0-py3-none-any.whl
magen_id_client magen_id_client-2.1a0-py3-none-any.whl

For This Service there are available make commands. Makefile is located in a root directory. You can execute make targets only in a directory where Makefile is located.

Make Default Target: make default. Here is the list of targets available for policy

default:
        @echo 'Makefile for Magen Core'
        @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_base_docker 	:Build Base Docker Image and Current Image (Run if base image is outdated or gone)'
        @echo '	make clean_docker 		    :Stop and Remove Docker containers and unused images'
        @echo

Before running target make build_base_docker and make clean_docker make sure to have Docker Machine running

Requirements: MacOS X

  1. python3 -V: Python 3.6.3 (>=3.6)
  2. pip3 -V: pip 9.0.1
  3. make -v: GNU Make 3.81
  4. docker -v: Docker version 17.03.0-ce, build 60ccb22
  5. docker-compose -v: docker-compose version 1.11.2, build dfed245
  6. Make sure you have correct rights to clone Cisco-Magen github organization

Requirements: AWS EC2 Ubuntu

  1. python3 -V: Python 3.6.3
  2. pip3 -V: pip 9.0.1
  3. make -v: GNU Make 4.1
  4. docker -v: Docker version 17.03.0-ce, build 60ccb22
  5. docker-compose -v: docker-compose version 1.11.2, build dfed245
  6. Make sure AWS user and root have correct rights to Cisco-Magen github organization