.. _index:

Welcome to OpsLib's documentation!
======================================


Getting Started
---------------

If you've never used ``OpsLib`` before, you should read the
:doc:`Getting Started with OpsLib <getting_started>` guide to get familiar
with ``OpsLib`` & its usage.


Currently Supported API
-----------------------


* **Common Library for Amazon Web Services**

  * :doc:`IcsEc2 API Reference <icsec2>`
  * :doc:`IcsELB API Reference <icselb>`
  * :doc:`IcsAS API Reference <icsas>`
  * :doc:`IcsS3 API Reference <icss3>`
  * :doc:`IcsR53 API Reference <icsr53>`
  * :doc:`IcsSNS API Reference <icssns>`
  * :doc:`IcsMeta API Reference <icsmeta>`
  * :doc:`IcsSGroup API Reference <icssgroup>`
  * :doc:`IcsSQS API Reference <icssqs>`

* **Common Library for ICS Utilities**

  * :doc:`IcsAlert API Reference <icsutils/icsalert>`
  * :doc:`Misc API Reference <icsutils/misc>`
  * :doc:`Daemon API Reference <icsutils/daemon>`
  * :doc:`CLI based on DOC Reference <icsutils/cli>`
  * :doc:`CLI based on JSON Reference <icsutils/jsoncli>`
  * :doc:`JSON Template Substitution Reference <icsutils/jsonsubs>`
  * :doc:`JSON Diff API Reference <icsutils/jsondiff>`

* **Common Library for ICS Logging**

  * :doc:`IcsLog API Reference <icslog>`

* **Common Library for ICS Exception**

  * :doc:`IcsException API Reference <icsexception>`


.. toctree::
   :hidden:

   getting_started
   icsec2
   icselb
   icsas
   icss3
   icssns
   icsr53
   icsmeta
   icslog
   icsexception
   icssgroup
   icssqs
   icsutils/icsalert
   icsutils/misc
   icsutils/daemon
   icsutils/cli
   icsutils/jsoncli
   icsutils/jsonsubs
   icsutils/jsondiff


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`