Skip to content

Commit

Permalink
- Instroctions on how to configure GeoNode to login throguh LinkedIn…
Browse files Browse the repository at this point in the history
… and Facebook (#3607)
  • Loading branch information
Alessio Fabiani authored and francbartoli committed Feb 11, 2018
1 parent 5ee4146 commit 3d142c1
Show file tree
Hide file tree
Showing 73 changed files with 365 additions and 29 deletions.
3 changes: 3 additions & 0 deletions docs/tutorials/admin/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ You will know how to:
monitoring/index
database_shards/index
async_signals/index
socialaccounts/index

:ref:`geoserver_geonode_aa`
GeoNode interacts with GeoServer through an advanced security mechanism based on OAuth2 Protocol and GeoFence. This section is a walk through of the configuration and setup of GeoNode and GeoServer Advanced Security.
Expand Down Expand Up @@ -91,3 +92,5 @@ You will know how to:
:ref:`async_signals`
How to set up asynchronous signals handling.

:ref:`geonode_socialaccounts`
How to set up and login trhgough LinkedIn and Facebook Social Accounts.
File renamed without changes
File renamed without changes
54 changes: 27 additions & 27 deletions docs/tutorials/admin/monitoring/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,22 +74,22 @@ Here's step-by-step instruction how to create monitoring setup for deployment sc

1. Log in as admin, and go to admin section:

.. image:: ../../../img/monitoring/homepage-admin-link.png
.. image:: img/homepage-admin-link.png
:alt: go to admin section

2. Go to **monitoring** section (or type ``/admin/monitoring/`` as a path in URL):

.. image:: ../../../img/monitoring/admin-monitoring-section.png
.. image:: img/admin-monitoring-section.png
:alt: go to admin/monitoring section

3. Go to **Hosts**:

.. image:: ../../../img/monitoring/admin-monitoring-hosts-services-underline.png
.. image:: img/admin-monitoring-hosts-services-underline.png
:alt: go to admin/monitoring/hosts section

4. Click on **Add host +**:

.. image:: ../../../img/monitoring/admin-monitoring-add-host.png
.. image:: img/admin-monitoring-add-host.png
:alt: add host

5. Enter following information:
Expand All @@ -98,17 +98,17 @@ Here's step-by-step instruction how to create monitoring setup for deployment sc
Note, that **host** value is arbitrary. You can enter other name if you like.
Don't forget to save.

.. image:: ../../../img/monitoring/admin-monitoring-host.png
.. image:: img/admin-monitoring-host.png
:alt: added host

6. Go to **Services**:

.. image:: ../../../img/monitoring/admin-monitoring-hosts-services-underline.png
.. image:: img/admin-monitoring-hosts-services-underline.png
:alt: go to admin/monitoring/services section

7. Click on **Add service +**:

.. image:: ../../../img/monitoring/admin-monitoring-add-service.png
.. image:: img/admin-monitoring-add-service.png
:alt: add service

8. Enter following information:
Expand All @@ -117,7 +117,7 @@ Here's step-by-step instruction how to create monitoring setup for deployment sc
* **host**: `localhost`
* **service type**: `geonode`

.. image:: ../../../img/monitoring/admin-monitoring-service-local-geonode.png
.. image:: img/admin-monitoring-service-local-geonode.png
:alt: add geonode service

9. Add another **Service** Enter following information:
Expand All @@ -127,7 +127,7 @@ Here's step-by-step instruction how to create monitoring setup for deployment sc
* **service type**: `hostgeonode`
* **url**: `http://localhost/` (should point to GeoNode home page)

.. image:: ../../../img/monitoring/admin-monitoring-service-local-system-geonode.png
.. image:: img/admin-monitoring-service-local-system-geonode.png
:alt: add hostgeonode service

10. Add another **Service** and enter following information:
Expand All @@ -137,7 +137,7 @@ Here's step-by-step instruction how to create monitoring setup for deployment sc
* **service type**: `geoserver`
* **url**: `http://localhost/geoserver/` (should point to GeoServer home page)

.. image:: ../../../img/monitoring/admin-monitoring-service-local-geoserver.png
.. image:: img/admin-monitoring-service-local-geoserver.png
:alt: add geoserver service


Expand All @@ -161,22 +161,22 @@ Usage

Monitoring interface is available for superusers only. It's available in profile menu:

.. image:: ../../../img/monitoring/homepage-monitoring-link.png
.. image:: img/homepage-monitoring-link.png
:alt: monitoring link

Dashboard
+++++++++

Main view offers overview of recent situation in GeoNode deployment.

.. image:: ../../../img/monitoring/monitoring-dashboard.png
.. image:: img/monitoring-dashboard.png
:alt: monitoring dashboard


Top bar and indicators
++++++++++++++++++++++

.. figure:: ../../../img/monitoring/dashboard-indicators-ok.png
.. figure:: img/dashboard-indicators-ok.png
:alt: indicators in ok state

With top bar buttons User can:
Expand All @@ -201,7 +201,7 @@ Below there are four main health indicators:

* **Errors** - shows how many errors were captured during request processing. When clicked, Errors box will show detailed list of captured errors. See Errros description for details.

.. figure:: ../../../img/monitoring/dashboard-indicators-errors.png
.. figure:: img/dashboard-indicators-errors.png
:alt: indicators in ok state

Indicators in error state
Expand All @@ -212,47 +212,47 @@ Software Performance

Software Performance view shows GeoServer web service statistics, for all requests monitored and detailed, OWS-specific, per service type (WMS, WFS, OCS etc).

.. image:: ../../../img/monitoring/dashboard-sw-performance.png
.. image:: img/dashboard-sw-performance.png

Clicking on

.. image:: ../../../img/monitoring/dashboard-sw-performance-charts-button.png
.. image:: img/dashboard-sw-performance-charts-button.png
:align: center

will show charts with data history for overall performance and per-OWS performance:

.. image:: ../../../img/monitoring/dashboard-sw-performance-chart.png
.. image:: img/dashboard-sw-performance-chart.png


Hartware Performance
++++++++++++++++++++

Hardware performance box shows hardware usage statistics for selected host (monitored with any of hostgeonode or hostgeoserver type Service): % of CPU usage and average memory consumption. User can select from which host data will be presented.

.. image:: ../../../img/monitoring/dashboard-hw-performance.png
.. image:: img/dashboard-hw-performance.png

Clicking on

.. image:: ../../../img/monitoring/dashboard-hw-performance-charts-button.png
.. image:: img/dashboard-hw-performance-charts-button.png
:align: center

will show charts with data history for selected host and time period

.. image:: ../../../img/monitoring/dashboard-hw-performance-charts.png
.. image:: img/dashboard-hw-performance-charts.png


Errors
++++++

Errors view will show list of captured errors in GeoNode and GeoServer. List contents is displayed for selected time window.

.. image:: ../../../img/monitoring/dashboard-errors-list.png
.. image:: img/dashboard-errors-list.png

For each error, details are available:
* error class, message and stack trace
* basic request context (IP, path, user agent)

.. image:: ../../../img/monitoring/dashboard-error-details.png
.. image:: img/dashboard-error-details.png


Alerts
Expand All @@ -262,30 +262,30 @@ An alert is a descriptive information on situation when observed metric contains

Alerts view will show list of alerts for current moment (alerts that were generated in past are not displayed here):

.. image:: ../../../img/monitoring/monitoring-alerts.png
.. image:: img/monitoring-alerts.png

Each alert contains more descriptive information what is wrong:

.. image:: ../../../img/monitoring/monitoring-alerts-unfolded.png
.. image:: img/monitoring-alerts-unfolded.png

Notifications
+++++++++++++

Notification mechanism (not to be confused with notifications application in GeoNode) is a way to inform selected users about situations, where collected metric data would indicate a problem with deployment. Notifications are accessible from Alerts view:

.. image:: ../../../img/monitoring/monitoring-alerts-notification-link.png
.. image:: img/monitoring-alerts-notification-link.png

There can be several notification configurations available.


.. image:: ../../../img/monitoring/dashboard-notifications-list.png
.. image:: img/dashboard-notifications-list.png

Each notification configuration contains two main elements:

* list of email addressess which should be notified when alert is generated
* list of checks (at least one check must be in invalid state to generate alert)

.. image:: ../../../img/monitoring/dashboard-notifications-config.png
.. image:: img/dashboard-notifications-config.png

User can add arbitrary number of emails. Email address doesn't need to point to user registered in GeoNode instance. If email provided doesn't belong to any of users, alert will be send as a regular email. If email provided can be associated with specific user, notifications application (and thus, notification settings for that user) will be used to send alert.

Expand Down
Loading

0 comments on commit 3d142c1

Please sign in to comment.