Merge branch 'feature/update_doc' into develop

Author: avara1986

docs/index.rst

@@ -20,6 +20,7 @@ Content
    :maxdepth: 4
 
    installation
+   runinkubernetes
    quickstart
    structure
    configuration

docs/installation.rst

@@ -8,67 +8,4 @@ Clone the project
 
 Configure your project and the path of your MS. See :doc:`configuration </configuration>` section.
 
-Configure your setup.py with your project information
-
-
-
-Use MS with Docker
-------------------
-`Install docker <https://docs.docker.com/install/>`_
-
-
-Use MS with Kubernetes localy
------------------------------
-Configure your service.yaml (TODO: create docs to configure kubernetes service.yaml)
-
-* Installing Kubernetes...
-
-.. code-block:: bash
-
-        curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.9.0/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/
-
-* Installing Minikube...
-
-.. code-block:: bash
-
-        curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
-
-
-Start minikube and set the environment of docker
-
-.. code-block:: bash
-
-    minikube start
-    eval $(minikube docker-env)
-    kubectl config use-context minikube
-
-If a shell isn't your friend. You could use kubernetes web panel to see your pods:
-
-.. code-block:: bash
-
-    minikube dashboard
-
-Create your image
-
-.. code-block:: bash
-
-    docker build -t your-app:v1 .
-
-Deploy your images localy:
-
-.. code-block:: bash
-
-    kubectl create -f service.yaml
-    minikube service your-app
-
-
-Clean your environment
-
-.. code-block:: bash
-
-    kubectl delete service your-app
-    kubectl delete deployment your-app
-    docker rmi your-app:v1 -f
-    minikube stop
-    eval $(minikube docker-env -u)
-    minikube delete
+Configure your setup.py with your project information

docs/runinkubernetes.rst

@@ -0,0 +1,63 @@
+Run in kubernetes
+=================
+
+Use MS with Docker
+------------------
+`Install docker <https://docs.docker.com/install/>`_
+
+
+Use MS with Kubernetes localy
+-----------------------------
+Configure your service.yaml (TODO: create docs to configure kubernetes service.yaml)
+
+* Installing Kubernetes...
+
+.. code-block:: bash
+
+        curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.9.0/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/
+
+* Installing Minikube...
+
+.. code-block:: bash
+
+        curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin/
+
+
+Start minikube and set the environment of docker
+
+.. code-block:: bash
+
+    minikube start
+    eval $(minikube docker-env)
+    kubectl config use-context minikube
+
+If a shell isn't your friend. You could use kubernetes web panel to see your pods:
+
+.. code-block:: bash
+
+    minikube dashboard
+
+Create your image
+
+.. code-block:: bash
+
+    docker build -t template:v1 .
+
+Deploy your images localy:
+
+.. code-block:: bash
+
+    kubectl apply -f service.yaml
+    minikube service template
+
+
+Clean your environment
+
+.. code-block:: bash
+
+    kubectl delete template
+    kubectl delete template
+    docker rmi template:v1 -f
+    minikube stop
+    eval $(minikube docker-env -u)
+    minikube delete

docs/structure.rst

@@ -6,13 +6,26 @@ You have a project with this structure:
 .. code-block:: bash
 
    manager.py
+   requirements.txt
+   requirements-tests.txt
+   requirements-docker.txt
+   setup.py
+   tox.ini
+   myms
+   ├ healthcheck
+   │ └ healthcheck.py
+   ├ logger
+   │ └ logger.py
+   ├ models
+   │ └ __init__.py
+   └ tracer
+     └ main.py
    project
    ├ __init__.py
    ├ config.py
    ├ views
    │ ├ __init__.py
-   │ ├ views.py
-   │ └ healthcheck.py
+   │ └ views.py
    ├ models
    │ ├ __init__.py
    │ └ models.py
@@ -25,26 +38,48 @@ manager.py
 A Django style command line. Use this to start the application like:
 
 .. code-block:: bash
+
     python manage.py runserver
 
 You can set the host and the port with:
 
 .. code-block:: bash
+
     python manage.py runserver -h 0.0.0.0 -p 8080
 
+Common Structure
+----------------
+
+myms/healthcheck/healthcheck.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This views is usually used by Kubernetes, Eureka and other systems to check if our application is up and running
+
+myms/logger/logger.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Print logger in JSON format to send to server like Elasticsearch. Inject span traces in logger
+
+myms/models/__init__.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Initizalize `flask_sqlalchemy.SQLAlchemy object`
+
+myms/tracer/main.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create an injector `flask_opentracing.FlaskTracer` to use in our projects
+
+Structure of a project
+----------------------
+
 project/__init__.py
--------------------
+~~~~~~~~~~~~~~~~~~~
 This file init the project with the funcion `create_app`. Initialize the Flask app, register `blueprints <http://flask.pocoo.org/docs/0.12/blueprints/>`_
 and intialize all libraries like Swagger, database, the trace system...
 
 project/config.py
------------------
+~~~~~~~~~~~~~~~~~
 See :doc:`configuration </configuration>` section
 
 project/views
--------------
+~~~~~~~~~~~~~
 use views.py or create your file. You must add after register the view blueprint in `project/views/__init__.py`.
 
-project/views/healthcheck.py
-----------------------------
-This views is usually used by Kubernetes, Eureka and other systems to check if our application is up and running
+

project/tests/test_views.py

@@ -10,7 +10,7 @@ def _format_response(response: Text = "") -> Union[List, Dict]:
     return json.loads(response)
 
 
-class FlaskrTestCase(unittest.TestCase):
+class ProjectTestCase(unittest.TestCase):
 
     def setUp(self):
         os.environ["ENVIRONMENT"] = "test"

service.yaml

@@ -1,14 +1,18 @@
+# interno
 kind: Service
 apiVersion: v1
+kind: Service
 metadata:
   name: template
 spec:
   selector:
     app: template
   ports:
   - protocol: TCP
-    port: 80
+    port: 5000
     targetPort: 5000
+  type: LoadBalancer
+  externalTrafficPolicy: "Local"
 ---
 apiVersion: extensions/v1beta1
 kind: Deployment
@@ -23,7 +27,16 @@ spec:
     spec:
       containers:
         - name: template
-          image: template:latest
+          image: template:v1
           ports:
             - name: http
-              containerPort: 5000
+              containerPort: 5000
+---
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: ingress
+spec:
+  backend:
+    serviceName: template
+    servicePort: 5000