diff --git a/.gitreview b/.gitreview
index ce742ee0..66de0a43 100644
--- a/.gitreview
+++ b/.gitreview
@@ -1,4 +1,5 @@
[gerrit]
host=review.openstack.org
port=29418
-project=openstack/ara-server.git
+project=openstack/ara
+defaultbranch=feature/1.0
diff --git a/README.rst b/README.rst
index 82fe7b60..def226a5 100644
--- a/README.rst
+++ b/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 `_ and `django-rest-framework `_.
+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 `_
-- For the ARA REST API clients, look at `ara-clients `_
-- For the ARA web interface, look at `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 `_.
+Documentation for installing, configuring, running and using ara is
+available on `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 .
\ No newline at end of file
+ along with ARA Records Ansible. If not, see .
\ No newline at end of file
diff --git a/ara/clients/offline.py b/ara/clients/offline.py
index 3c0d92df..d1cbbdab 100644
--- a/ara/clients/offline.py
+++ b/ara/clients/offline.py
@@ -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
diff --git a/ara/plugins/callback/ara_default.py b/ara/plugins/callback/ara_default.py
index 513f6c31..405c3e35 100644
--- a/ara/plugins/callback/ara_default.py
+++ b/ara/plugins/callback/ara_default.py
@@ -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
diff --git a/doc/source/_static/screenshot.png b/doc/source/_static/screenshot.png
deleted file mode 100644
index ba18a2a3..00000000
Binary files a/doc/source/_static/screenshot.png and /dev/null differ
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 90f07670..51a0f972 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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'
diff --git a/setup.cfg b/setup.cfg
index 6b20cfa9..d0bef45d 100644
--- a/setup.cfg
+++ b/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]