Merge pull request #31 from deephdc/ignacio-br0

Ignacio br0

source/conf.py

@@ -20,13 +20,13 @@
 # -- Project information -----------------------------------------------------
 
 project = 'DEEP-Hybrid-DataCloud'
-copyright = '2018, DEEP-Hybrid-DataCloud consortium'
+copyright = '2022, DEEP-Hybrid-DataCloud consortium'
 author = 'DEEP-Hybrid-DataCloud consortium'
 
 # The short X.Y version
-version = 'DEEP-2 (XXX)'
+version = 'DEEP-2'  #todo: add deep version
 # The full version, including alpha/beta/rc tags
-release = 'DEEP-2 (XXX)'
+release = 'DEEP-2'
 
 
 # -- General configuration ---------------------------------------------------

source/index.rst

@@ -1,6 +1,18 @@
 Welcome to DEEP-Hybrid-DataCloud's documentation!
 =================================================
 
+.. admonition:: Useful project links
+   :class: important
+
+    * `Project's Homepage <https://deep-hybrid-datacloud.eu/>`__
+    * `Marketplace <https://marketplace.deep-hybrid-datacloud.eu/>`__
+    * `Dashboard <https://train.deep-hybrid-datacloud.eu/>`__
+    * `Github <https://github.com/deephdc>`__
+    * `DockerHub <https://hub.docker.com/u/deephdc/>`__
+    * `Docs <https://docs.deep-hybrid-datacloud.eu/en/latest/>`__
+    * `NextCloud <https://nc.deep-hybrid-datacloud.eu/>`__
+    * `DEEP IAM <https://iam.deep-hybrid-datacloud.eu/>`_
+
 User documentation
 ------------------
 
@@ -10,8 +22,6 @@ If you are a user (current or potential) you should start here.
    :maxdepth: 3
 
    user/index
-
-You can also check these `slides <https://docs.google.com/viewer?url=https://raw.githubusercontent.com/deephdc/deep-docs/master/source/_static/overview.pdf>`_  for a quick overview of the project from the user's point of view.
 
 Component documentation
 -----------------------
@@ -28,21 +38,10 @@ If you are searching for technical notes on various areas, please check the
 following section.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 3
 
    technical/index
 
-.. admonition:: Useful project links
-   :class: important
-
-    * `DEEP IAM <https://iam.deep-hybrid-datacloud.eu/>`_
-    * `DEEP Open Catalog - Marketplace <https://marketplace.deep-hybrid-datacloud.eu/>`_
-    * DEEP Dashboard (`Training <https://train.deep-hybrid-datacloud.eu/>`_, `Advanced <https://paas.cloud.cnaf.infn.it/>`_)
-    * `DEEPaaS: DEEP as a Service <https://deepaas.deep-hybrid-datacloud.eu/>`_
-    * `DEEP Nextcloud <https://nc.deep-hybrid-datacloud.eu>`_
-    * `Official GitHub <https://github.com/deephdc>`_
-    * `Official DockerHub <https://hub.docker.com/u/deephdc/>`_
-
 Indices and tables
 ==================
 

source/user/howto/deploy-orchent.rst → source/technical/howto-developers/deploy-orchent.rst

@@ -2,16 +2,15 @@
 
 .. highlight:: console
 
-*****************************
 Deployment with CLI (orchent)
-*****************************
+=============================
 
 This is a step by step guide on how to make a deployment using the command line interface (instead of the Training
 Dashboard).
 
 .. admonition:: Requirements
 
-   * `oidc-agent <https://github.com/indigo-dc/oidc-agent/releases>`_ installed and configured for `DEEP-IAM <https://iam.deep-hybrid-datacloud.eu/>`_ (see :ref:`Configure oidc-agent <user/howto/oidc-agent:Configure oidc-agent>`).
+   * `oidc-agent <https://github.com/indigo-dc/oidc-agent/releases>`_ installed and configured for `DEEP-IAM <https://iam.deep-hybrid-datacloud.eu/>`_ (see :doc:`Configure oidc-agent <oidc-agent>`).
    * `orchent <https://github.com/indigo-dc/orchent/releases>`_ tool
 
 
@@ -66,7 +65,7 @@ This script will be the **only place** where you will have to indicate <your_nex
     **DO NOT** save the rclone credentials in the **CONTAINER** nor in the **TOSCA** file
 
 .. tip::
-    When developing an application with the :ref:`Data Science template <user/overview/cookiecutter-template:DEEP Data Science template>`,
+    When developing an application with the :doc:`DEEP Modules Template <../../user/overview/cookiecutter-template>`,
     the DEEP-OC-<your_project> repository will contain an exampled script, named *submit_orchent_tmpl.sh*
 
 Submit your deployment

source/technical/howto-developers/develop-dashboard.rst

@@ -0,0 +1,7 @@
+Develop Dashboard
+=================
+
+The `General purpose dashboard <https://paas.cloud.cnaf.infn.it/>`_ allows you to interact with the underling `TOSCA templates <https://github.com/indigo-dc/tosca-templates/tree/master/deep-oc>`_
+(which configure the job requirements) instead of modules and deploy more complex topologies (e.g. a kubernetes cluster).
+Modules can either use a `general template <https://github.com/indigo-dc/tosca-templates/blob/master/deep-oc/deep-oc-marathon-webdav.yml>`_
+or create a dedicated one based on the `existing templates <https://github.com/indigo-dc/tosca-templates/tree/master/deep-oc>`__.

source/user/howto/oidc-agent.rst → source/technical/howto-developers/oidc-agent.rst

@@ -1,8 +1,7 @@
 .. highlight:: console
 
-********************
 Configure oidc-agent
-********************
+====================
 
 `oidc-agent <https://indigo-dc.gitbook.io/oidc-agent/>`_ is a tool to manage OpenID Connect tokens
 and make them easily usable from the command line.

source/user/howto/oidc-auth.rst → source/technical/howto-developers/oidc-auth.rst

@@ -1,14 +1,12 @@
-====================================
 Using Openstack API with OIDC tokens
 ====================================
 
-
 |Using Openstack API| |with OIDC tokens|
 
 Note: this guide is made for GNU/Linux distributions
 
 Create file for OIDC
-====================
+--------------------
 
 After downloading Openstack RC file (Identity API v3) from Horizon web
 panel, the following changes are necessary for the authentication with
@@ -41,7 +39,7 @@ All the other attributes for authentication are in the RC v3 file
 downloaded from Horizon web panel.
 
 Using Openstack CLI
-===================
+-------------------
 
 After loading all necessary environment variables to the shell, just run
 openstack command. To create a RC file for OIDC you can do the

source/technical/index.rst

@@ -4,14 +4,26 @@ Technical documentation
 These pages contain technical notes software documentations, guides, tutorials,
 logbooks and similar documents produced with DEEP Hybrid DataCloud project
 
+HowTo's (developers)
+--------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   howto-developers/develop-dashboard.rst
+   howto-developers/oidc-agent.rst
+   howto-developers/deploy-orchent.rst
+   howto-developers/oidc-auth.rst
+
+
 Mesos
 -----
 
 .. toctree::
    :maxdepth: 1
 
-   mesos-cluster/enable-gpu-support.md
-   mesos-cluster/enable-openid-authentication.md
+   mesos-cluster/enable-gpu-support.rst
+   mesos-cluster/enable-openid-authentication.rst
 
 
 Kubernetes
@@ -20,8 +32,8 @@ Kubernetes
 .. toctree::
    :maxdepth: 1
 
-   kubernetes/gpu-kubernetes-centos7.md
-   kubernetes/gpu-kubernetes-ubuntu.md
+   kubernetes/gpu-kubernetes-centos7.rst
+   kubernetes/gpu-kubernetes-ubuntu.rst
 
 
 OpenStack nova-lxd
@@ -30,23 +42,23 @@ OpenStack nova-lxd
 .. toctree::
    :maxdepth: 1
 
-   nova-lxd/nova-lxd-ansible.md
-   nova-lxd/nova-lxd-devstack.md
-   nova-lxd/nova-lxd-juju.md
-   nova-lxd/nova-lxd-configuration-testing.md
+   nova-lxd/nova-lxd-ansible.rst
+   nova-lxd/nova-lxd-devstack.rst
+   nova-lxd/nova-lxd-juju.rst
+   nova-lxd/nova-lxd-configuration-testing.rst
 
 uDocker
 -------
 
 .. toctree::
    :maxdepth: 1
 
-   udocker/udocker_gpu_1stimplementation_tests.md
+   udocker/udocker_gpu_1stimplementation_tests.rst
 
-Miscelaneous
-------------
+Miscellaneous
+-------------
 
 .. toctree::
    :maxdepth: 1
 
-   others/gpu-sharing-with-mps.md
+   others/gpu-sharing-with-mps.rst