Rename references to ara-{server,plugins,clients} back to ara
This follows the fusion of the ara-{server,plugins,clients} reporitories into a branch of the ara repository. There are other references to clean up that will require a bit more work (e.g, documentation) so this is a first step.
This commit is contained in:
parent
4fb1b9049f
commit
b0d62ba7c4
@ -1,4 +1,5 @@
|
||||
[gerrit]
|
||||
host=review.openstack.org
|
||||
port=29418
|
||||
project=openstack/ara-server.git
|
||||
project=openstack/ara
|
||||
defaultbranch=feature/1.0
|
||||
|
58
README.rst
58
README.rst
@ -1,21 +1,17 @@
|
||||
ara-server
|
||||
==========
|
||||
ara
|
||||
===
|
||||
|
||||
.. image:: doc/source/_static/ara-with-icon.png
|
||||
|
||||
ARA Records Ansible playbook runs and makes the recorded data available and
|
||||
intuitive for users and systems.
|
||||
|
||||
ara-server is a modern python 3 application built with the latest releases of
|
||||
`Django <https://www.djangoproject.com/>`_ and `django-rest-framework <https://www.django-rest-framework.org/>`_.
|
||||
The project provides several distinct components in order to make this happen:
|
||||
|
||||
``ara-server`` is the component from ARA that manages the REST API and the database.
|
||||
|
||||
.. image:: doc/source/_static/screenshot.png
|
||||
|
||||
- For the ARA Ansible callback plugin or the ``ara_record`` action module, look at `ara-plugins <https://github.com/openstack/ara-plugins>`_
|
||||
- For the ARA REST API clients, look at `ara-clients <https://github.com/openstack/ara-clients>`_
|
||||
- For the ARA web interface, look at `ara-web <https://github.com/openstack/ara-web>`_
|
||||
- An API server for sending and querying data relative to playbook execution results
|
||||
- An API client library for communicating with the API
|
||||
- An Ansible callback plugin to record events as they happen throughout the execution
|
||||
- An Ansible action module to associate arbitrary key/values to your playbook reports
|
||||
|
||||
Quickstart
|
||||
==========
|
||||
@ -26,9 +22,11 @@ Here's how you can get started from scratch with default settings::
|
||||
python3 -m venv ~/.ara/venv
|
||||
|
||||
# Install Ansible and the required ARA projects
|
||||
~/.ara/venv/bin/pip install ansible ara-server ara-clients ara-plugins
|
||||
~/.ara/venv/bin/pip install ansible
|
||||
~/.ara/venv/bin/pip install git+https://github.com/openstack/ara@feature/1.0
|
||||
|
||||
# Tell Ansible to use the ARA callback plugin from ara-plugins
|
||||
# Tell Ansible to use the ARA callback plugin
|
||||
# "python -m ara.plugins" provides the path to the ARA plugins directory
|
||||
export ANSIBLE_CALLBACK_PLUGINS="$(~/.ara/venv/bin/python -m ara.plugins)/callback"
|
||||
|
||||
# Run your playbook as your normally would
|
||||
@ -36,11 +34,9 @@ Here's how you can get started from scratch with default settings::
|
||||
|
||||
The data is saved in real time during the Ansible playbook execution.
|
||||
|
||||
What happened behind the scenes is that the ARA Ansible callback plugin
|
||||
(provided by ``ara-plugins``) used the offline API client
|
||||
(provided by ``ara-clients``) to send your data to the ``ara-server`` API which
|
||||
then saved it to a database located by default at
|
||||
``~/.ara/server/ansible.sqlite``.
|
||||
What happened behind the scenes is that the ARA Ansible callback plugin used
|
||||
the offline API client to send the data to the API which then saved it to a
|
||||
database located by default at ``~/.ara/server/ansible.sqlite``.
|
||||
|
||||
You're now ready to start poking at the API with the built-in API clients !
|
||||
|
||||
@ -50,8 +46,8 @@ If you'd like to have the ARA web reporting interface, take a look at
|
||||
Documentation
|
||||
=============
|
||||
|
||||
Documentation for installing, configuring, running and using ara-server is
|
||||
available on `readthedocs.io <https://ara-server.readthedocs.io>`_.
|
||||
Documentation for installing, configuring, running and using ara is
|
||||
available on `readthedocs.io <https://ara.readthedocs.io>`_.
|
||||
|
||||
Community and getting help
|
||||
==========================
|
||||
@ -81,8 +77,9 @@ Development
|
||||
**TL;DR**: Using tox is convenient for the time being::
|
||||
|
||||
# Retrieve the source
|
||||
git clone https://github.com/openstack/ara-server
|
||||
cd ara-server
|
||||
git clone https://github.com/openstack/ara
|
||||
cd ara
|
||||
git checkout feature/1.0
|
||||
|
||||
# Install tox from pip or from your distro packages
|
||||
pip install tox
|
||||
@ -98,30 +95,29 @@ Development
|
||||
# Build docs
|
||||
tox -e docs
|
||||
|
||||
Authors and contributors
|
||||
========================
|
||||
Contributors
|
||||
============
|
||||
|
||||
ARA was created by David Moreau Simard (@dmsimard) and contributors can be
|
||||
found on GitHub_.
|
||||
See contributors on GitHub_.
|
||||
|
||||
.. _GitHub: https://github.com/openstack/ara-server/graphs/contributors
|
||||
.. _GitHub: https://github.com/openstack/ara/graphs/contributors
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
::
|
||||
|
||||
Copyright (c) 2018 Red Hat, Inc.
|
||||
Copyright (c) 2019 Red Hat, Inc.
|
||||
|
||||
ARA is free software: you can redistribute it and/or modify
|
||||
ARA Records Ansible is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
ARA is distributed in the hope that it will be useful,
|
||||
ARA Records Ansible is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
along with ARA Records Ansible. If not, see <http://www.gnu.org/licenses/>.
|
@ -32,13 +32,6 @@ class AraOfflineClient(AraHttpClient):
|
||||
def __init__(self):
|
||||
self.log = logging.getLogger(__name__)
|
||||
|
||||
# Validate that ara-server is available before letting Django attempt to
|
||||
# import it
|
||||
try:
|
||||
import ara.server # noqa
|
||||
except ImportError:
|
||||
raise ImportError("AraOfflineClient requires ara-server to be installed.")
|
||||
|
||||
from django import setup as django_setup
|
||||
from django.core.management import execute_from_command_line
|
||||
|
||||
|
@ -49,8 +49,7 @@ DOCUMENTATION = """
|
||||
callback: ara
|
||||
callback_type: notification
|
||||
requirements:
|
||||
- ara-plugins
|
||||
- ara-server (when using the offline API client)
|
||||
- ara
|
||||
short_description: Sends playbook execution data to the ARA API internally or over HTTP
|
||||
description:
|
||||
- Sends playbook execution data to the ARA API internally or over HTTP
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 42 KiB |
@ -20,7 +20,7 @@ import os
|
||||
import sys
|
||||
import sphinx_rtd_theme
|
||||
import pbr.version
|
||||
version_info = pbr.version.VersionInfo('ara-server')
|
||||
version_info = pbr.version.VersionInfo('ara')
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
# -- General configuration ----------------------------------------------------
|
||||
@ -43,7 +43,7 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'ara-server'
|
||||
project = u'ara'
|
||||
copyright = u'2018, Red Hat'
|
||||
author = 'OpenStack community'
|
||||
|
||||
|
10
setup.cfg
10
setup.cfg
@ -1,11 +1,11 @@
|
||||
[metadata]
|
||||
name = ara-server
|
||||
summary = ARA Records Ansible API and Server components
|
||||
name = ara
|
||||
summary = ARA Records Ansible
|
||||
description-file =
|
||||
README.rst
|
||||
author = OpenStack Community
|
||||
author-email = openstack-discuss@lists.openstack.org
|
||||
home-page = https://github.com/openstack/ara-server
|
||||
home-page = https://github.com/openstack/ara
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Information Technology
|
||||
@ -15,10 +15,8 @@ classifier =
|
||||
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
||||
Operating System :: POSIX :: Linux
|
||||
Programming Language :: Python
|
||||
Programming Language :: Python :: 2
|
||||
Programming Language :: Python :: 2.7
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: 3.5
|
||||
Programming Language :: Python :: 3.6
|
||||
Development Status :: 4 - Beta
|
||||
|
||||
[global]
|
||||
|
Loading…
x
Reference in New Issue
Block a user