Merge pull request #8 from nebula-orchestrator/2.0.0a

2.0.0a

Author: naorlivne

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+python:
+  - "2.7"
+install:
+  - pip install -r requirements.txt
+script:
+  - python -m unittest discover

CONTRIBUTING

@@ -19,7 +19,7 @@ Nebula is designed with the following philosophy in mind, any feature\pull reque
 * Reliability is more important then shiny new features.
 * No vendor\cloud lock-in, if it's only available in one cloud it will not be used.
 * No latency sensitivity, assume workers to have a below average internet access and are in the other side of the world.
-* Fully stateless, all data is to be saved in the backend DB & all communication between components is to be passed through the massage queue.
+* Fully stateless, all data is to be saved in the backend DB.
 
 ### Documentation
 

NebulaPythonSDK/sdk.py

@@ -5,96 +5,160 @@ class Nebula:
 
     # the nebula class init module serves as the login against the nebula API as it's the only shared thing among the
     # class functions
-    def __init__(self, username, password, host, port=80, protocol="http", request_timeout=60):
+    def __init__(self, username=None, password=None, host="127.0.0.1", port=80, protocol="http", request_timeout=60):
         self.request_timeout = request_timeout
         self.username = username
         self.password = password
         self.protocol = protocol
-        self.protocol = port
+        self.port = port
         self.host = protocol + "://" + host + ":" + str(port)
-        self.basic_auth = base64.b64encode(username + ":" + password)
         self.headers = {
-            'authorization': "Basic " + self.basic_auth,
             'content-type': "application/json",
             'cache-control': "no-cache"
         }
+        if username is not None and password is not None:
+            self.basic_auth = base64.b64encode(username + ":" + password)
+            self.headers["authorization"] = "Basic " + self.basic_auth
+        self.API_VERSION = "v2"
 
     # create a new nebula app, requires the app name to create and a complete dict of the config values for it
     def create_app(self, app, config):
-        url = self.host + "/api/apps/" + app
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app
         payload = json.dumps(config)
         headers = self.headers
         response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # delete an existing nebula app, no confirmation required in SDK so be careful
     def delete_app(self, app):
-        url = self.host + "/api/apps/" + app
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app
         headers = self.headers
         response = requests.request("DELETE", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # list all of the apps managed by nebula
     def list_apps(self):
-        url = self.host + "/api/apps"
+        url = self.host + "/api/" + self.API_VERSION + "/apps"
         headers = self.headers
         response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # list the config of a nebula app, only requires the app name
     def list_app_info(self, app):
-        url = self.host + "/api/apps/" + app
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app
         headers = self.headers
         response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # stop a nebula app, only requires the app name
     def stop_app(self, app):
-        url = self.host + "/api/apps/" + app + "/stop"
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app + "/stop"
         headers = self.headers
         response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # start a nebula app, only requires the app name
     def start_app(self, app):
-        url = self.host + "/api/apps/" + app + "/start"
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app + "/start"
         headers = self.headers
         response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # restart a nebula app, only requires the app name
     def restart_app(self, app):
-        url = self.host + "/api/apps/" + app + "/restart"
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app + "/restart"
         headers = self.headers
         response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # update a nebula app, requires the app name and a dict of the config values you want to change, any combination of
     # config values is accepted as it keeps the rest unchanged
     def update_app(self, app, config):
-        url = self.host + "/api/apps/" + app + "/update"
+        url = self.host + "/api/" + self.API_VERSION + "/apps/" + app + "/update"
         payload = json.dumps(config)
         headers = self.headers
         response = requests.request("PUT", url, data=payload, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
-    # rolling restart an app, only requires the app name
-    def roll_app(self, app):
-        url = self.host + "/api/apps/" + app + "/roll"
+    # prune unused images on all devices
+    def prune_images(self):
+        url = self.host + "/api/" + self.API_VERSION + "/prune"
         headers = self.headers
         response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
-    # prune unused images on all devices running app on them
-    def prune_images(self, app):
-        url = self.host + "/api/apps/" + app + "/prune"
+    # prune unused images on all devices that are part of the device_group given
+    def prune__device_group_images(self, device_groups):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_groups + "/prune"
         headers = self.headers
         response = requests.request("POST", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
 
     # check that the contacted api is responding as expected
     def check_api(self):
-        url = self.host + "/api/status"
+        url = self.host + "/api/" + self.API_VERSION + "/status"
         headers = self.headers
         response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
-        return response
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # list the info of all apps and all data of a given device_group
+    def list_device_group_info(self, device_group):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_group + "/info"
+        headers = self.headers
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # list all device_groups
+    def list_device_groups(self):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups"
+        headers = self.headers
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # list device_group configuration
+    def list_device_group(self, device_group):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_group
+        headers = self.headers
+        response = requests.request("GET", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # create a new nebula delete_device_group, requires the app name to create and a complete dict of the config values
+    # for it
+    def create_device_group(self, device_group, config):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_group
+        payload = json.dumps(config)
+        headers = self.headers
+        response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # delete an existing nebula delete_device_group, no confirmation required in SDK so be careful
+    def delete_device_group(self, device_group):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_group
+        headers = self.headers
+        response = requests.request("DELETE", url, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response
+
+    # update apps in a device group
+    def update_device_group(self, device_group, config):
+        url = self.host + "/api/" + self.API_VERSION + "/device_groups/" + device_group + "/update"
+        payload = json.dumps(config)
+        headers = self.headers
+        response = requests.request("POST", url, data=payload, headers=headers, timeout=self.request_timeout)
+        filtered_response = {"status_code": response.status_code, "reply": response.json()}
+        return filtered_response

README.md

@@ -3,6 +3,8 @@ An SDK for managing [nebula](https://nebula-orchestrator.github.io/) via python.
 
 translates all of Nebula [API](http://nebula.readthedocs.io/en/latest/api/) calls to something more pythonic.
 
+Source code is available at [github](https://github.com/nebula-orchestrator/nebula-python-sdk)
+
 # How To Use
 first get NebulaPythonSDK onto your machine
 ```bash
@@ -35,6 +37,7 @@ app_conf = {
     "docker_ulimits": [],
     "networks": ["nebula"],
     "running": True,
+    "rolling_restart": False,
     "volumes": ["/tmp:/tmp/1", "/var/tmp/:/var/tmp/1:ro"],
     "containers_per": {
         "cpu": 6
@@ -50,6 +53,44 @@ app_conf = {
 }
 connection.create_app("app_name", app_conf)
 
-```
+# create device group
+device_group_config = {"apps": ["app_name"]}
+connection.create_device_group("device_group_name", device_group_config)
+
+# list device group
+connection.list_device_group("device_group_name")
+
+# list device group info
+connection.list_device_group_info("device_group_name")
+
+# ping api
+connection.check_api()
+
+# delete app
+connection.delete_app("app_name")
+
+# stop app
+connection.stop_app("app_name")
+
+# start app
+connection.start_app("app_name")
 
-Note that the response returned is a requests formatted response.
+# restart app
+connection.restart_app("app_name")
+
+# update app
+connection.update_app("app_name", app_conf)
+
+# prune images on all device groups
+connection.prune_images()
+
+# delete device_group
+connection.delete_device_group("device_group_name")
+
+# prune images on a selected device groups
+connection.prune__device_group_images("device_group_name")
+
+# update device group
+connection.update_device_group("device_group_name", device_group_config)
+
+```

setup.py

@@ -1,6 +1,6 @@
 __author__ = 'Naor Livne'
 __author_email__ = 'naorlivne@gmail.com'
-__version__ = '1.6.0'
+__version__ = '2.0.0a1'
 
 from setuptools import setup, find_packages