Skip to content

api

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
dev_env
dev_env
 
 
ncf_api_flask_app
ncf_api_flask_app
 
 
README.md
README.md
 
 
requirements.txt
requirements.txt
 
 
run.py
run.py
 
 

README.md

ncf API

A Flask based REST API to manage Techniques in a ncf directory

API functions

  • [GET] /api/generics_methods: This gets all defined generics methods from parameter path and /usr/share/ncf

    • Parameters:
      • path [Optional][URL parameter]: path where to look for generic_methods

  • [GET] /api/techniques?path=/ncf/folder/path: This gets all defined techniques from parameter path and /usr/share/ncf

    • Parameters:
      • path [Optional][URL parameter]: path where to look for Techniques

  • [POST/PUT] /api/techniques: Create(POST)/Update(PUT) a technique from technique metadata into the ncf path passed as parameters.

    • Parameters:
      • path [Optional][JSON parameter]: path where the techique will be written ( default value: /usr/share/ncf )
      • technique [JSON parameter]: Technique metadata, need to write the file

  • [DELETE] /api/techniques/bundle_name: Delete technique bunlde_name in specified ncf path

    • Parameters:
      • path [Optional][URL parameter]: path where the technique will be deleted (default value: /usr/share/ncf)
      • bundle_name [URL]: Bundle name of the technique, used as technique filename to delete

Deploy ncf API

Use ncf-api-virtualenv package

The easiest way to deploy ncf API is to install the package ncf-api-virtualenv. The package is available in the same repository than ncf.

This will:

  • Create a virtual environment with all requirements
  • Add a wsgi file ready to deploy ncp api using the virtual environment
  • Add a ready to use apache configuration using the wsgi file

Use your own installation

You can install by yourself requirements (directly on your system or in a specific virtual env)

All python package needed are in file requirements.txt

You will also need a wsgi file to deploy your application. You can start from ncf-api-virtualenv wsgi (https://github.com/Normation/rudder-packages/blob/master/ncf-api-virtualenv/SOURCES/ncf_api_flask_app.wsgi) by just replacing the virtualenv path by your actual environement

Development

ncf API

To run ncf api in a development environment, run the following commands:

wget https://raw.githubusercontent.com/Normation/rudder-packages/master/ncf-api-virtualenv/SOURCES/virtualenv.py
python virtualenv.py flask
flask/bin/pip install -r requirements.txt
export PYTHONPATH=/path/to/ncf/tools:$PYTHONPATH
./run.py

ncf API is now available on http://localhost:5000

ncf technique editor

You will need apache to be installed (apache2/httpd)

cp  /path/to/ncf/api/dev-env/ncf-builder.conf /etc/(apache2|httpd)/conf.d/
chmod 755 /path/to/ncf/builder -R
service (apache2|httpd) restart

ncf API is now available on http://localhost/ncf ncf technique editor is now available on http://localhost/ncf-builder

Disable Rudder authentication

At this point you need a running rudder (dev or not) on localhost to access ncf api

to remove this need:

  • edit /path/to/ncf/api/ncf_flask_app/views.py
  • Replace line ' available_modules_name = ["Rudder"]' by available_modules_name = ["None"]