This is an automated email from the ASF dual-hosted git repository.
smarru pushed a commit to branch 0.17
in repository https://gitbox.apache.org/repos/asf/airavata-docs.git
The following commit(s) were added to refs/heads/0.17 by this push:
new 5233a1e reverting to 0.17 changes
5233a1e is described below
commit 5233a1ec903f4699f2a3293a0591015c36513a6e
Author: Suresh Marru <[email protected]>
AuthorDate: Fri Jul 26 13:46:21 2019 -0400
reverting to 0.17 changes
---
docs/configuration/pga-configuration.md | 32 +++++++++++++++-----
docs/contact-us.md | 2 +-
docs/faq.md | 4 ---
docs/index.md | 12 ++++----
docs/previous-releases.md | 2 +-
docs/technical-documentation/django-portal.md | 0
.../helix-job-management.md | 0
docs/user-documentation/JSON-tutorials.md | 0
docs/user-documentation/admin-tutorials.md | 16 ++++++----
docs/user-documentation/cms-tutorials.md | 0
docs/user-documentation/user-tutorials.md | 7 +++--
mkdocs.yml | 34 ++++++++++------------
12 files changed, 61 insertions(+), 48 deletions(-)
diff --git a/docs/configuration/pga-configuration.md
b/docs/configuration/pga-configuration.md
index 2df2725..ed1e7d9 100644
--- a/docs/configuration/pga-configuration.md
+++ b/docs/configuration/pga-configuration.md
@@ -78,9 +78,11 @@
<br>
<br>
###Application Catalog
-1. Users in Admin group can add applications in to the gateway.
-2. Adding an application involves adding details in to the three tabs -
Details, Interface and Deployments.
-4. What each tab means and capture?
+1. Gateway admin add applications in to the gateway. Adding an application is
a 3 step process.
+2. Admin need to add application module, interface and deployment information
in order to launch specific application jobs on compute resources.
+3. Relationship between application module, interface and deployments.
+
+4. What each step means?
- <b class="blue">Application Module</b>
- Navigation: Admin Dashboard ⇒ App Catalog ⇒ Module
- This is the simple introduction of the application; Name,
Version and Description.
@@ -104,11 +106,25 @@
<br>
<br>
###Credential Store
-1. Navigation: Settings ⇒ Credential Store
+1. Navigation: Admin Dashboard ⇒ Credential Store
2. This interface is used to generate SSH key + token pairs.
3. These generated keys can be added in to the authorized key files in each
resource for SSH key based communication.
-4. Generated key can be either assigned at gateway level or/and at individual
resource allocation level; one key + token pair for all the resources OR have
separate key for each resource.
-5. SSH keys are used for communication with compute resources and storage
resources.
+4. Generated key can be either assigned at gateway level; one key + token pair
for all the resources OR have separate key for each resource.
+5. SSH keys are used for communication with compute resources, storage
resources and WSO2 identity server.
-###Keycloak Configuration
-<Will be added Soon!>
+###Identity Server Configuration
+1. Setting up WSO2 IS for the new gateway.
+2. Once PGA is cloned all information related to user identity will be in
app/config/pga_config.php. No modifications required for users who are using
hosted IS.
+3. For user identity management we could either use Airavata WSO2 IS or users
own WSO2 IS.
+4. Download WSO2 Identity Server 5.0 from
http://product-dist.wso2.com/products/identity-server/5.0.0/wso2is-5.0.0.zip
+5. Extract the downloaded IS binary archive to a location <IS_HOME>.
+6. Set JAVA_HOME variable and add jdk bin directory to the PATH variable.
+7. Open <IS_HOME>/repository/conf/carbon.xml and change the following property
to false
+<HideAdminServiceWSDLs>false</HideAdminServiceWSDLs>
+8. Execute the following command to run the server
+sh <IS_HOME>/bin/wso2server.sh
+You should be able to login to the Identity Server Web App using your browser
with url http://localhost:9443/carbon . Default admin credentials are username:
admin, password: admin
+9. For more information regarding WSO2 Identity Server refer <a
href="https://docs.wso2.org/display/IS460/Deploying+in+Production";
target="_blank">WSO2 IS Server</a>
+<br>Gateway admin will be provided with;
+ - Domain URL for the Gateway
+ - Admin User name
diff --git a/docs/contact-us.md b/docs/contact-us.md
index 7cc6ee0..65f6966 100644
--- a/docs/contact-us.md
+++ b/docs/contact-us.md
@@ -4,7 +4,7 @@ For your clarifications, Questions and Suggestions please
contact us through
OR
-<a>Chat</a>
+<a href="https://www.hipchat.com/gMDHyN1KM"; target="_blank">HipChat</a>
Issue Reporting
Any issue encountered with Airavata or our gateway please log through;
diff --git a/docs/faq.md b/docs/faq.md
index 8b232c4..3d820d0 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -7,10 +7,8 @@
### <h3 id="InstallFAQ">Installation FAQs </h3>
<b class="blue"> Q1.</b> I have setup my own gateway and Airavata. When I log
into the gateway I cannot create Compute resources. What should I do?</br>
<b class="blue">Answer: </b> In your pga_config.php (in folder
.../testdrive/app/config) under heading 'Portal Related Configurations' set
'super-admin-portal' => false, to true.</br>
-
<br><b class="blue">Q2.</b> I don't get notifications when users create new
accounts in my gateway. Why?</br>
<b class="blue">Answer: </b> That's because you have not defined an email
address in <br>'admin-emails' => ['[email protected]','[email protected]']. Here you can
add one or many.</br>
-
<br><br><b class="blue"> Q3.</b> I am not receiving email notifications from
compute resources for job status changes. What should I do?</br>
<b class="blue">Answer: </b> In airavata-server.properties please locate and
set your email account information.
<pre><code>email.based.monitor.host=imap.gmail.com
@@ -42,7 +40,6 @@ email.based.monitor.store.protocol=imaps (either imaps or
pop3)</pre></code>
PRIMARY KEY (GATEWAY_ID, TOKEN_ID)
);
</pre></code>
-
<br><br><b class="blue"> Q5.</b> I cannot login to my Compute Resource and
launch jobs from Airavata using the SSH key I generated. What should I do?
<br><b class="blue">Answer: </b> Steps to use generated SSH key<br>
- Generate SSH key + token using Credential Store<br>
@@ -74,7 +71,6 @@ email.based.monitor.store.protocol=imaps (either imaps or
pop3)</pre></code>
CustomLog logs/pga--access_log common
</VirtualHost></code></pre>
<br>
-
<br><b class="blue"> Q8.</b> I get the Error message Permission Denied to
app/storage directory.<br>
<br><b class="blue">Answer: </b>Execute the following command and grant
all permissions; <pre><code> sudo chmod -R 777 app/storage</code></pre>
diff --git a/docs/index.md b/docs/index.md
index dcb66d8..6cbbdd3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,15 +6,14 @@
- Used by scientific gateway developers as their middleware layer. They can
directly call Airavata API in order to communicate with grid based system.
- Provides a desktop tools and browser-based web interface components for
managing applications, workflows and generated data.
- Contains sophisticated server-side tools for registering and managing
scientific applications on computational resources.
-- The Django portal provides tools and methods to easily integrate with post
processing applications and application centric interfaces.
For more information on Airavata visit; <a href="http://airavata.apache.org/";
target="_blank">Apache Airavata</a>
<br>
<br>
-<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="user-documentation/admin-tutorials" target="_blank" ><b>Admin
Instructions & Tutorials</b><br/><br/>Gateway Admin of a deployed SciGaP
Gateway? </br>Gateway admin tutorials!</br></br>Collection of tutorials that
will provide instructions for quick set-up.</a></button>
-<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="user-documentation/user-tutorials" target="_blank" ><b>User Instructions
& Tutorials</b><br/><br/>A Gateway End User?</br>Tutorials for gateway users.
</br></br><br/>Assistance with job submission, management and
sharing!.</a></button>
-<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="installation/airavata-installation" target="_blank"><b>Download Apache
Airavata & Django Portal</b><br/><br/>A Gateway software developer?
</br></br>Download and install Airavata middleware and Django Gateway
Portal.<br/></br></a></button>
+<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="installation/airavata-installation"
target="_blank"><b>Download</b><br/><br/>Download and install Airavata
middleware and reference gateway (PGA).<br/></br>Select the best option for
you!</a></button>
+<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="user-documentation/admin-tutorials" target="_blank" ><b>Admin Quick
Start</b><br/><br/>Tutorials for gateway admin users!</br>Collection of
tutorials that will provide instructions for quick set-up.</a></button>
+<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="user-documentation/user-tutorials" target="_blank" ><b>User Quick
Start</b><br/><br/>Tutorials for gateway users!</br>Collection of tutorials way
users. <br/>Help with job submission and management!.</a></button>
<!--<button type="button"
style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border:
2px solid #2481b9;border-radius:4px"><a style="color:white"
href="http://airavata.readthedocs.io/en/latest/ target="_blank"><b>User
Guide</b></br><br>In-detail documentation on how to install, configure and do
upgrades for gateway admins.</br>Step by step guide for gateway users as
well.</br></a></button>
</br>
@@ -25,5 +24,6 @@ For more information on Airavata visit; <a
href="http://airavata.apache.org/"; ta
1. Using an already hosted gateway<br>
OR<br>
2. Having your own gateway hosted<br>
-you can contact a downstream project <a href="http://scigap.org/";
target="_blank">Science Gateways Platform as a Service (SciGaP)</a> and request
your gateway.
-<br>SciGaP runs Apache Airavata as a platform service.
+you can contact a downstream project <a href="http://scigap.org/";
target="_blank">Science Gateways Platform as a Service (SciGaP)</a>.
+
+<br>SciGaP runs Apache Airavata as platform service.
diff --git a/docs/previous-releases.md b/docs/previous-releases.md
index a588c11..b0dcedf 100644
--- a/docs/previous-releases.md
+++ b/docs/previous-releases.md
@@ -1,4 +1,4 @@
## Previous Releases
-- <h4><a href="http://airavata.readthedocs.io/en/0.17/";
target="_blank">Airavata 0.17 Release Docs</a></h4>
+
- <h4><a href="http://airavata.readthedocs.io/en/0.16/";
target="_blank">Airavata 0.16 Release Docs</a></h4>
\ No newline at end of file
diff --git a/docs/technical-documentation/django-portal.md
b/docs/technical-documentation/django-portal.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/technical-documentation/helix-job-management.md
b/docs/technical-documentation/helix-job-management.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/user-documentation/JSON-tutorials.md
b/docs/user-documentation/JSON-tutorials.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/user-documentation/admin-tutorials.md
b/docs/user-documentation/admin-tutorials.md
index 9463d9d..11a38bf 100644
--- a/docs/user-documentation/admin-tutorials.md
+++ b/docs/user-documentation/admin-tutorials.md
@@ -1,15 +1,19 @@
-## Admin Settings Configurations
+## Admin Dashboard Configurations
This page is dedicated to Gateway Admins!
### Prior to starting your configurations
-1. You need to have admin access to the Django portal, Settings. You need to
be in 'Admin' role of the Admin Group.
+1. You have admin access to the PGA portal, Admin Dashboard
- How to check?
- Log in to the gateway portal
- - You would land on Dashboard with all the applications you have
access to launch jobs.
- - Click 'Settings' from top right drop down menu.
- - Do you see icon 'Application Catalog' ? In it can you create
applications using 'New Application +'?.
- - Then you are good !
+ - You would land on Admin Dashboard with "Let's Get Started!"
+ - Click 'Browse Application Modules'
+ - Do you see button 'Create new Application Interface' ? Then you are
good.
+2. Storage resource ID is added to the pga_config.php </br>
+ - If not go to
+ - Admin Dashboard → Storage Resources → Browse
+ - Locate your resource and copy the ID
+ - Paste it in pga_config.php file in pga/app/config directory.
3. Credentials generated, assigned and added to authorized_keys files of
resources
- To generate key refer [Credential
Store](../configuration/pga-configuration.md#credential-store)
- Token Assignment [Gateway
Management](../configuration/pga-configuration.md#gateway-management-of-resources)
diff --git a/docs/user-documentation/cms-tutorials.md
b/docs/user-documentation/cms-tutorials.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/user-documentation/user-tutorials.md
b/docs/user-documentation/user-tutorials.md
index b78f406..82c2c1a 100644
--- a/docs/user-documentation/user-tutorials.md
+++ b/docs/user-documentation/user-tutorials.md
@@ -1,4 +1,5 @@
-###Basic tutorials for gateway end users and admin users.
-1. <a
href="https://cwiki.apache.org/confluence/display/AIRAVATA/Django+Portal+for+Airavata+-+End-User+Guide";
target="_blank">Django Portal End User Tutorial</a> <br>
-2. <a
href="https://cwiki.apache.org/confluence/display/AIRAVATA/Django+Portal+for+Airavata%3A+Gateway+Admin+Guide";
target="_blank"> Django Portal Admin Tutorial</a>
\ No newline at end of file
+## Work-in-Progress
+###For now please follow:
+1. <a
href="https://cwiki.apache.org/confluence/display/AIRAVATA/Tutorial+04+-+PHP+Reference+Gateway+for+Airavata+-+End-User+Guide";
target="_blank">PGA Portal End User Tutorial</a> <br>
+2. <a
href="https://cwiki.apache.org/confluence/display/AIRAVATA/Tutorial+05+-+PHP+Reference+Gateway+for+Airavata+-+Gateway+Admin+Guide";
target="_blank"> PGA Portal Admin Tutorial</a>
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 6719756..135b1cf 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: Apache Airavata 0.18
+site_name: Apache Airavata 0.17
site_url: https://airavata.apache.org/
site_description: Apache Airavata Documentation
@@ -8,29 +8,25 @@ docs_dir: docs
pages:
- Home: 'index.md'
+- Installation:
+ - Apache Airavata Installation: 'installation/airavata-installation.md'
+ - PGA Installation: 'installation/pga-installation.md'
+ - Apache Airavata Server Properties:
'installation/airavata-server-properties.md'
+- Configuration:
+ - Keycloak Configuration: 'configuration/keycloak-configuration.md'
+ - PGA Configuration: 'configuration/pga-configuration.md'
+- Maintenance:
+ - Code Update:
+ - Apache Airavata Update: 'maintenance/code-update/airavata-update.md'
+ - PGA Update: 'maintenance/code-update/pga-update.md'
+ - PGA Maintenance: 'maintenance/pga-maintenance.md'
- User Documentation:
- Gateway User Tutorials: 'user-documentation/user-tutorials.md'
- Gateway Admin Tutorials: 'user-documentation/admin-tutorials.md'
- - Gateway Theme Implemenetation: 'user-documentation/cms-tutorials.md'
- - Advance Application Configuration: 'user-documentation/JSON-tutorials.md'
-# - Apache Airavata User Groups:
'user-documentation/airavata-user-profiles.md'
-# - Application Support: 'user-documentation/supported-applications.md'
-#- System Configuration:
-# - Keycloak Configuration: 'configuration/keycloak-configuration.md'
-# - Django Configuration: 'configuration/pga-configuration.md'
-# - Django FAQ: 'maintenance/pga-maintenance.md'
-- Installation:
- - Apache Airavata Installation: 'installation/airavata-installation.md'
- - Django Installation: 'installation/pga-installation.md'
-# - Apache Airavata Server Properties:
'installation/airavata-server-properties.md'
-# - Code Update:
-# - Code Update:
-# - Apache Airavata Update: 'maintenance/code-update/airavata-update.md'
-# - PGA Update: 'maintenance/code-update/pga-update.md'
+ - Apache Airavata User Profiles:
'user-documentation/airavata-user-profiles.md'
+ - Supported Applications: 'user-documentation/supported-applications.md'
- Technical Documentation:
- Apache Airavata API: 'technical-documentation/airavata-api.md'
- - Helix Job Management: 'technical-documentation/helix-job-management.md'
- - Django Portal: 'technical-documentation/django-portal.md'
- Sharing Documentation:
- Introduction:
'technical-documentation/sharing-documentation/introduction.md'
- API Overview:
'technical-documentation/sharing-documentation/api-overview.md'
