Normalize to one trailing slash on Nexus URL
[federation.git] / docs / overview.rst
1 .. ===============LICENSE_START=======================================================
2 .. Acumos CC-BY-4.0
3 .. ===================================================================================
4 .. Copyright (C) 2017 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 .. ===================================================================================
6 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
7 .. under the Creative Commons Attribution 4.0 International License (the "License");
8 .. you may not use this file except in compliance with the License.
9 .. You may obtain a copy of the License at
10 ..
11 .. http://creativecommons.org/licenses/by/4.0
12 ..
13 .. This file is distributed on an "AS IS" BASIS,
14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 .. See the License for the specific language governing permissions and
16 .. limitations under the License.
17 .. ===============LICENSE_END=========================================================
18
19 ===========================
20 Federation Gateway Overview
21 ===========================
22
23
24 The Acumos Federation Gateway feature provides a mechanism to exchange models
25 between two Acumos instances via a secure network channel.
26 The goal was to have a mechanism that provides great flexibility when designing a deployment.
27 The Gateway feature does not define how multiple Acumos instances are to be interconnected
28 or what roles they play.
29
30 Like many other system components, the Gateway is implemented as a server that listens 
31 for requests on a REST API.  The Gateway provides two interfaces, both using REST:
32
33 * Public: towards peers (also known as the "E5" interface)
34 * Private: changes between gateway and different adapter implementations
35
36 Architecture
37 ------------
38
39 The following picture shows how the gateway components communicate with each other and with
40 other Acumos features.  All communication is secured by use of client and server certificates.
41
42 .. image:: fed-gw-arch.png
43     :align: center
44     :alt: Federation Gateway Architecture
45
46 Developer Resources
47 -------------------
48 The source is available from the Linux Foundation Gerrit server:
49  
50     `<https://gerrit.acumos.org/r/gitweb?p=federation.git;a=summary>`_
51
52 The build (CI) jobs are in the Linux Foundation Jenkins server:
53
54     `<https://jenkins.acumos.org/view/federation/>`_
55
56 Issues are tracked in the Linux Foundation Jira server:
57
58     `<https://jira.acumos.org/secure/Dashboard.jspa>`_
59
60 Project information is available in the Linux Foundation Wiki:
61
62     `<https://wiki.acumos.org/>`_