#########################################
Welcome to Fed4FIRE+'s documentation hub!
#########################################

.. image:: _static/fed4fire_logo.png
   :align: right

This documentation site describes how you can get started on
:ref:`using the testbeds federated in Fed4FIRE+ <end_user_documentation>`, or how to
:ref:`integrate your testbed into the Fed4FIRE+ federation <testbed_owner_documentation>`.


To learn more `about the Fed4FIRE+ project <https://www.fed4fire.eu/the-project/>`_, please visit the
`general Fed4FIRE+ homepage <https://www.fed4fire.eu>`_.

.. _end_user_documentation:

Fed4FIRE+ End User Documentation
================================

This section guides you through the first steps into using the resources available within the Fed4FIRE+ federation,
and refers you to the proper documentation of each of the testbeds for more specific information.


:mdi:`rocket` Getting Started
-----------------------------

.. toctree::
   :maxdepth: 1

   getanaccount
   tools
   firstexperiment
   support


:mdi:`book-open-page-variant` Testbed documentation
---------------------------------------------------

An overview of the testbeds federated in Fed4FIRE+ can be found on
`Fed4FIRE+ Facilities overview <https://www.fed4fire.eu/testbeds/>`_.

To verify the current status of all testbeds federated within Fed4FIRE+, you can use the |heart-pulse|
`Federation Monitor <https://fedmon.fed4fire.eu>`_.

For more information about the usage of each testbed, we refer to the specific documentation pages of each testbed:

* `imec CityLab documentation <https://doc.lab.cityofthings.eu/wiki/Main_Page>`_
* `ExoGENI documentation <https://wiki.exogeni.net/doku.php>`_
* `FuSeCo documentation <http://fuseco.fokus.fraunhofer.de/doc>`_
* `GRID'5000 documentation <https://www.grid5000.fr/w/Getting_Started>`_
* `Ofelia i2CAT island documentation <http://lab.i2cat.net/testbed-openflow-wired/>`_
* `IRIS documentation <https://iris-testbed.connectcentre.ie/#tutorial>`_
* `LOG-a-TEC documentation <http://log-a-tec.eu/cr-etel-tutorial.html>`_
* `NETMODE documentation <http://www.netmode.ntua.gr/main/index.php?option=com_content&view=article&id=124&Itemid=89>`_
* `NITOS documentation <http://nitlab.inf.uth.gr/doc/>`_
* `Planetlab Europe documentation <https://www.planet-lab.eu/doc>`_
* `Smart Santander documentation <https://api.smartsantander.eu/docs>`_
* `imec Virtual Wall documentation <https://doc.ilabt.imec.be/ilabt/virtualwall/>`_
* `imec w-iLab.t documentation <https://doc.ilabt.imec.be/ilabt/wilab/index.html>`_
* `imec Portable Testbed documentation <https://doc.ilabt.imec.be/ilabt/portabletestbed/index.html>`_


:mdi:`information` Other
------------------------

..  toctree::

   advanced/index
   tutorials


.. _testbed_owner_documentation:

Testbed Owner Documentation
===========================

.. _testbed_owner_getting_started:

:mdi:`rocket` Getting Started
-----------------------------

When you want to join Fed4FIRE with your testbed, you can start with the following webinar (and accompanying slides):
`Fed4FIRE WP2: info for new testbeds <https://jfed.ilabt.imec.be/newtestbeds_video.html>`_.

:mdi:`book-open-page-variant` Documentation
-------------------------------------------

.. toctree::
    :maxdepth: 1

    testbed_owner/amsoft
    testbed_owner/addingtestbed
    testbed_owner/testbedtermsandconditions
    testbed_owner/debuggingam
    testbed_owner/rspec
    testbed_owner/stitching
    testbed_owner/speaksfor
    testbed_owner/oauth

:mdi:`link-variant` Useful links
--------------------------------

Other useful links for AM developers:

* Almost all AM servers use the `Geni AM API version 3 <http://groups.geni.net/geni/wiki/GAPI_AM_API_V3>`_.
* There is also a more generic AM API, the *Federation AM API*, however, it is not completely finished, and it is not
  used by any servers or supported by any clients. Though if any servers appear, we will certainly add support to jFed.
  The `API documentation <https://fed4fire-testbeds.ilabt.iminds.be/asciidoc/federation-am-api.html>`_ is built from
  the `github repo <https://github.com/open-multinet/federation-am-api>`_ where you can discuss or change the API.
* Documentation on the `Slice Authority and Member Authority APIs <http://groups.geni.net/geni/wiki/CommonFederationAPIv2>`_.
* More documentation on `RSpec <https://fed4fire-testbeds.ilabt.iminds.be/asciidoc/rspec.html>`_ including info on the
  `Fed4Fire RSpec extension for SSH Proxy <https://fed4fire-testbeds.ilabt.iminds.be/asciidoc/rspec.html#_ssh_proxy_manifest_rspec_extension>`_.

* Use the `Federation Monitor <https://fedmon.fed4fire.eu>`_ to monitor your testbeds status once the integration has been
  done

For more info, **contact us** at contact@fed4fire.eu