Skip to content

Commit

Permalink
edits
Browse files Browse the repository at this point in the history
  • Loading branch information
richcar58 committed Jan 8, 2019
1 parent 77292fa commit 72f4467
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions docs/agave/guides/jobs/aloe-beta-tester-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Aloe Beta Tester Guide
======================

The Aloe Beta program allows users to test the new jobs service in a production-like Agave environment before we actually deploy it to production. The Aloe Beta test environment includes a snapshot of the production Agave database along with a way to generate credentials to access that environment. This document explains how to configure and use the Aloe Beta test environment.
The Aloe Beta program allows users to test the new **Jobs Service** in a production-like Agave environment before it gets deployed to production. The Aloe Beta test environment includes a snapshot of the production Agave database along with a way to generate credentials to access that environment. This document explains how to configure and use the Aloe Beta test environment.

The documentation on the new Aloe Job service itself can be found `here <https://tacc-cloud.readthedocs.io/projects/agave/en/latest/agave/guides/jobs/introduction.html>`_.

Expand All @@ -17,22 +17,14 @@ Getting Started

The Aloe Beta relies on the `sandbox key facility of WSO2 <https://docs.wso2.com/display/AM170/Maintaining+Separate+Production+and+Sandbox+Gateways>`_, which allows users to target the Beta environment with their existing credentials. You will need to generate sandbox keys in order to authenticate to the Aloe Jobs service.

1. Using your tenant’s production URL, create a client for the Aloe Beta where in the command below <username> is replaced by your username in double quotes and <base> is replaced by your tenant base URL. For example, the Cyverse base URL is https://agave.iplantc.org and the DesignSafe base URL is https://agave.designsafe-ci.org.
1. Using your tenant’s production URL, create a client for the Aloe Beta using the command below. Replace *<username>* with your username in double quotes; replace *<base>* with your tenant's base URL. For example, the Cyverse base URL is https://agave.iplantc.org and the DesignSafe base URL is https://agave.designsafe-ci.org. The command will prompt you for your password.

|
.. container:: foldable

.. container:: header

:fa:`caret-right`
**Show curl example**

.. code-block:: plaintext
.. code-block:: plaintext
$ curl -sku <username> -X POST -d "clientName=aloe_beta_client" https://<base>/clients/v2
|
This command will prompt you for your password.

2. Go to the WSO2 store for your tenant, which is just your tenant’s base URL + /store in your browser (for example, Cyverse would look like https://agave.iplantc.org/store). Login with the same credentials you just used to create the client.

3. Select the “My Subscriptions” tab and find the newly created client in the drop down under “Applications With Subscriptions”.
Expand All @@ -41,7 +33,7 @@ This command will prompt you for your password.

You now have a sandbox *Consumer Key*, *Consumer Secret* and *Access Token* for your tenant that can authenticate to the Aloe Jobs service. The default lifespan of a token is 4 hours (14400 seconds), but you can enter any lifespan you’d prefer and regenerate your token. For a token that doesn’t expire, enter -1 seconds (but be mindful of the security implications).

For curl and CLI users, use the sandbox access token generated as you would normally use your production token. The only difference is that the sandbox token will direct your requests to the Aloe Beta test environment.
For curl and CLI users, use the generated sandbox access token as you would normally use your production token. The only difference is that the sandbox token will direct your requests to the Aloe Beta test environment.

For portal administrators, install the sandbox Key and Secret in your portal test environment so that all requests in your test portal will be routed to the Aloe Beta environment.

Expand All @@ -53,7 +45,7 @@ Before you start running test jobs, there are a couple of important things to no

1. The Aloe Beta test database is NOT permanent. Any apps and systems defined and published in this environment will disappear at the end of the beta program. In addition, the history of jobs that you ran will also be discarded at the end of the Beta program. The archived output of jobs, however, will physically remain in the directories where it was written. Basically, everything saved to the Beta database will be lost at the conclusion of the Beta program.

2. The “snapshot” date for the Aloe Beta database (01/06/2019). The database will reflect your tenant’s production database up to the snapshot date. Any applications or systems defined after this date, or any job histories created after this date, will not be reflected in the Aloe Beta environment.
2. The “snapshot” date for the Aloe Beta database is 01/06/2019. The database will reflect your tenant’s production database up to the snapshot date. Any applications or systems defined after this date, or any job histories created after this date, will not be reflected in the Aloe Beta environment.



Expand Down

0 comments on commit 72f4467

Please sign in to comment.