https://github.com/thoth-station/management-api

An API service used for administration of deployed Thoth
https://github.com/thoth-station/management-api

artificial-intelligence hacktoberfest thoth

Last synced: about 2 months ago
JSON representation

An API service used for administration of deployed Thoth

• Host: GitHub
• URL: https://github.com/thoth-station/management-api
• Owner: thoth-station
• License: gpl-3.0
• Created: 2018-11-01T08:25:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-03T03:14:15.000Z (over 1 year ago)
• Last Synced: 2025-03-24T13:51:26.339Z (2 months ago)
• Topics: artificial-intelligence, hacktoberfest, thoth
• Language: Python
• Size: 2.13 MB
• Stars: 3
• Watchers: 8
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
Thoth Core Management API

=========================

.. image:: https://img.shields.io/github/v/tag/thoth-station/management-api?style=plastic

  :target: https://github.com/thoth-station/management-api/releases

  :alt: GitHub tag (latest by date)

.. image:: https://quay.io/repository/thoth-station/management-api/status

  :target: https://quay.io/repository/thoth-station/management-api?tab=tags

  :alt: Quay - Build

.. image:: https://api.codacy.com/project/badge/Grade/d8f62cde59b84854ac425d148570f1ab

   :alt: Codacy Badge

   :target: https://app.codacy.com/app/thoth-station/management-api?utm_source=github.com&utm_medium=referral&utm_content=thoth-station/management-api&utm_campaign=Badge_Grade_Dashboard

This API service is used for administrative and operational tasks for a Thoth

deployment. For Management API interaction, one needs a token that can be

obtained by contacting Thoth deployment administrator.

Installation and deployment

###########################

The service is built using OpenShift Source-to-Image and deployed

automatically via Argo CD - see `thoth-station/thoth-application

repository `_.

Running Management API locally

##############################

Management API can be run locally in a mode when it still talks to the cluster.

To run Management API locally, create ``.env`` file out out ``.env.template``

and adjust environment variable values as desired (see `thoth-station/storages

`__ for more info):

.. code-block:: console

  cp .env.template .env

  vim .env

Once the environment is properly setup, you can run Management API locally:

.. code-block:: console

  pipenv install

  pipenv run gunicorn thoth.management_api.openapi_server:app --config gunicorn.conf.py