misc: Use demo.recordsansible.org instead of api.demo

ara-web isn't currently in a state where we can demo it and it tends to
confuse users so remove it's mention for now.

Given that we no longer have a distinction between api and web, use
plain "demo.recordsansible.org" instead.

Change-Id: I788d5d457fc011364a7839172fbadc5c24de76d4
This commit is contained in:
David Moreau Simard 2021-01-17 13:10:54 -05:00
parent f9500e1b50
commit 5171bf9e97
No known key found for this signature in database
GPG Key ID: 7D4729EC4E64E8B7
7 changed files with 10 additions and 24 deletions

View File

@ -143,7 +143,7 @@
them to the live demo.
vars:
ara_api_client: http
ara_api_server: "https://api.demo.recordsansible.org"
ara_api_server: "https://demo.recordsansible.org"
required-projects:
- name: github.com/ansible/ansible
override-checkout: stable-2.9

View File

@ -46,15 +46,6 @@ A built-in CLI client for querying and managing playbooks and their recorded dat
The full list of commands, their arguments as well as examples can be found in
the `CLI documentation <https://ara.readthedocs.io/en/latest/cli.html#cli-ara-api-client>`_.
ara-web
-------
A project that is a work in progress and would appreciate contributions,
`ara-web <https://github.com/ansible-community/ara-web>`_ is a stateless
javascript interface to the API built with react and patternfly.
.. image:: doc/source/_static/ui-ara-web.png
Getting started
===============
@ -146,14 +137,9 @@ Read more about how container images are built and how to run them in the `docum
Live demo
=========
Deployments of the ARA API server and ara-web are available for demonstration
and test purposes:
A live demo for demonstration and test purposes is available at https://demo.recordsansible.org
- https://api.demo.recordsansible.org
- https://web.demo.recordsansible.org
These live demos are deployed using the ara_api and ara_web Ansible roles from the ara Ansible collection:
https://github.com/ansible-community/ara-collection
This demo is deployed with the help of the ara collection: https://github.com/ansible-community/ara-collection
Documentation
=============

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

View File

@ -25,7 +25,7 @@ For example, a customized callback plugin configuration might look like this in
[ara]
api_client = http
api_server = https://api.demo.recordsansible.org
api_server = https://demo.recordsansible.org
api_username = user
api_password = password
api_timeout = 15
@ -40,7 +40,7 @@ or as environment variables:
.. code-block:: bash
export ARA_API_CLIENT=http
export ARA_API_SERVER="https://api.demo.recordsansible.org"
export ARA_API_SERVER="https://demo.recordsansible.org"
export ARA_API_USERNAME=user
export ARA_API_PASSWORD=password
export ARA_API_TIMEOUT=15

View File

@ -23,7 +23,7 @@ You can also see what a detailed view looks like by querying a specific object i
.. image:: ../source/_static/ui-api-browser-playbook.png
Alternatively, you may also find an up-to-date live demonstration of the API at
``https://api.demo.recordsansible.org``.
``https://demo.recordsansible.org``.
Relationship between objects
----------------------------

View File

@ -50,7 +50,7 @@ specifying an endpoint parameter:
# Import the client
from ara.clients.http import AraHttpClient
endpoint = "https://api.demo.recordsansible.org"
endpoint = "https://demo.recordsansible.org"
# Instanciate the HTTP client with an endpoint where an API server is listening
client = AraHttpClient(endpoint=endpoint)
@ -73,7 +73,7 @@ Here's a code example to help you get started:
from ara.clients.http import AraHttpClient
# Instanciate the HTTP client with an endpoint where an API server is listening
client = AraHttpClient(endpoint="https://api.demo.recordsansible.org")
client = AraHttpClient(endpoint="https://demo.recordsansible.org")
# Get a list of failed playbooks
# /api/v1/playbooks?status=failed

View File

@ -39,7 +39,7 @@ Query a running API server for the 10 latest failed playbooks:
.. code-block:: bash
ara playbook list --client http \
--server https://api.demo.recordsansible.org \
--server https://demo.recordsansible.org \
--status failed \
--limit 10
@ -66,7 +66,7 @@ Show details about a playbook from a running API server and format the result in
.. code-block:: bash
ara playbook show --client http --server https://api.demo.recordsansible.org 1 -f json
ara playbook show --client http --server https://demo.recordsansible.org 1 -f json
Show details about a playbook from a local installation using the default offline
API client and format the result in yaml: