.. |ge| unicode:: 0x2265

.. _C2EC2Manual:

#####################
CROC Cloud API Client
#####################

.. important:: Для работы с CROC Cloud API Client требуется Python 2 |ge| 2.7.9 или Python 3 |ge| 3.4

Для работы с различными API Облака КРОК можно использовать утилиты из пакета *c2-client*.

В состав пакета входят следующие утилиты:

- ``c2-as`` — клиент к Auto Scaling API;
- ``c2-ct`` — клиент к CloudTrail API;
- ``c2-cw`` — клиент к CloudWatch API;
- ``c2-ec2`` — клиент к EC2 API;
- ``c2-eks`` — клиент к EKS API;
- ``c2-paas`` — клиент к PaaS API;
- ``c2-elb`` — клиент к Elastic Load Balancing API;
- ``c2-route53`` — клиент к Route53 API;
- ``c2rc-convert`` — утилита конвертации настроек для использования в ОС Windows.

Для управления ресурсами в Облаке КРОК с помощью API необходимы кастомизированные версии библиотек `python-boto <https://github.com/C2Devel/boto/>`__ и `python-boto3 <https://github.com/C2Devel/boto3/>`__.

.. _InstallC2Client:

*********
Установка
*********

Все операционные системы
========================

.. code-block:: shell

   pip install git+https://github.com/C2Devel/boto.git@@BOTO_VERSION@-@BOTO_RELEASE@
   pip install git+https://github.com/C2Devel/boto3.git
   pip install git+https://github.com/C2Devel/botocore.git
   pip install c2client

Linux
=====

.. tab-set::

   .. tab-item:: RHEL 6/CentOS 6

      .. code-block:: shell

         [user@host ~]$ sudo wget https://copr.fedorainfracloud.org/coprs/c2devel/c2-sdk/repo/epel-6/c2devel-c2-sdk-epel-6.repo \
           -O /etc/yum.repos.d/c2devel-c2-sdk-epel-6.repo
         [user@host ~]$ sudo yum install python-boto c2-client

   .. tab-item:: RHEL 7/CentOS 7

      .. code-block:: shell

         [user@host ~]$ sudo wget https://copr.fedorainfracloud.org/coprs/c2devel/c2-sdk/repo/epel-7/c2devel-c2-sdk-epel-7.repo \
          -O /etc/yum.repos.d/c2devel-c2-sdk-epel-7.repo
         [user@host ~]$ sudo yum install python-boto c2-client

.. _c2ec2usage:

*************
Использование
*************

Необходимо получить настройки для доступа по API.
Сделать это можно `в консоли управления облаком <https://console.cloud.croc.ru>`_.
Нажмите на логин пользователя в правом верхнем углу и выберите :bdg-light:`Профиль` :octicon:`arrow-right` :bdg-light:`Получить настройки доступа к API`.

В переменной *C2_PROJECT* укажите идентификатор своего проекта.

Добавить полученные настройки в переменные окружения:

.. tab-set::

    .. tab-item:: Windwos

       Для ОС Windows нужно сконвертировать файл настроек и экпортировать переменные окружения:

       .. code-block:: bash

          C:\> c2rc-convert path\to\c2rc.sh path\to\c2rc.bat
          C:\> call path\to\c2rc.bat

    .. tab-item:: Linux

       Для OC Linux нужно экспортировать переменные окружения:

       .. code-block:: bash

          source path/to/c2rc.sh

Теперь можно использовать утилиты  согласно :ref:`документации <supported_api>`. Например:

.. code-block:: bash

   c2-ec2 DescribeAvailabilityZones
   c2-eks DescribeCluster name backend_production