Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
FOGL-6763 Re-order documentation sections (#768)
* FOGL-6763 Re-order documentation sections

Signed-off-by: Mark Riddoch <mark@dianomic.com>

* Ignore .bak files

Signed-off-by: Mark Riddoch <mark@dianomic.com>

* Update additional services wording

Signed-off-by: Mark Riddoch <mark@dianomic.com>
  • Loading branch information
MarkRiddoch committed Aug 5, 2022
1 parent d5737de commit baf659e
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 19 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Expand Up @@ -90,4 +90,7 @@ python/fledge/plugins/notificationDelivery/*
python/fledge/plugins/notificationRule/*

# doxygen build
doxy/
doxy/

# aspell backups
*.bak
13 changes: 6 additions & 7 deletions docs/KERBEROS.rst
Expand Up @@ -7,9 +7,8 @@
.. _curl sources: https://github.com/curl/curl/releases
.. _OMF: https://omf-docs.osisoft.com/

***********************
Kerberos authentication
***********************
OMF Kerberos Authentication
***************************

Introduction
============
Expand All @@ -18,13 +17,13 @@ The bundled OMF north plugin in Fledge can use a number of different authenticat

The Fledge *requirements.sh* script installs the Kerberos client to allow the integration with what in the specific terminology is called KDC (the Kerberos server).

PI-Server as the North endpoint
PI Server as the North endpoint
===============================

The OSI *Connector Relay* allows token authentication while *PI Web API* supports Basic and Kerberos.
The OSI *Connector Relay* allows token authentication while *PI Web API* supports Basic and Kerberos authentication.

There could be more than one configuration to allow the Kerberos authentication,
the easiest one is the Windows server on which the PI-Server is executed act as the Kerberos server also.
the easiest one is the Windows server on which the PI Server is executed act as the Kerberos server also.

The Windows Active directory should be installed and properly configured for allowing the Windows server to authenticate Kerberos requests.

Expand Down Expand Up @@ -159,7 +158,7 @@ Troubleshooting the Kerberos authentication
-rwxrwxrwx 1 fledge fledge 91 Jul 17 09:07 piwebapi_kerberos_https.keytab
-rw-rw-r-- 1 fledge fledge 199 Aug 13 15:30 README.rst
3) verify the reachability of the Kerberos server (usually the PI-Server) - Network reachability
3) verify the reachability of the Kerberos server (usually the PI Server) - Network reachability

.. code-block:: console
Expand Down
12 changes: 6 additions & 6 deletions docs/index.rst
Expand Up @@ -13,19 +13,19 @@ Welcome to Fledge's documentation!
quick_start/index
processing_data
fledge_architecture
fledge_plugins
storage
services/index
control
plugin_index
building_pipelines
securing_fledge
storage
tuning_fledge
control
troubleshooting_pi-server_integration
plugin_developers_guide/index
rest_api_guide/index
build_index
KERBEROS
fledge_plugins
91_version_history
92_downloads
KERBEROS
services/index
plugin_index
glossary
10 changes: 5 additions & 5 deletions docs/scripts/plugin_and_service_documentation
Expand Up @@ -172,11 +172,11 @@ fi
mkdir services

cat > services/index.rst << EOFSERVICES
*********************
Service Documentation
*********************
*******************
Additional Services
*******************
The following external services are currently available to extend the functionality of Fledge.
The following additional services are currently available to extend the functionality of Fledge. These are optional services not installed as part of the base Fledge installation.
.. toctree::
Expand All @@ -189,4 +189,4 @@ do
type=`echo $repo | sed -e 's/fledge-//' -e 's/foglamp-//' -e 's/-.*//'`
dest=services/index.rst
plugin_and_service_doc $repo $dest "services"
done
done

0 comments on commit baf659e

Please sign in to comment.