summaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/install-guide/layout.adoc
diff options
context:
space:
mode:
authorramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:25:39 +0100
committerramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:27:31 +0100
commitaf74a6270d6ab6badf04a97495a6ef8ccded9b4b (patch)
tree2c7a536e54207a0870ca2008ce457a64de917ab9 /src/site-docs/adoc/fragments/install-guide/layout.adoc
parent9e318f20f2e64970bf3c2e3a5532c516231a6f8a (diff)
Adding first set of apex-pdp document changes
Adding document changes for auth, context, core, model, services & the main apex-pdp module. Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b Issue-ID: POLICY-867 Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>
Diffstat (limited to 'src/site-docs/adoc/fragments/install-guide/layout.adoc')
-rw-r--r--src/site-docs/adoc/fragments/install-guide/layout.adoc47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/site-docs/adoc/fragments/install-guide/layout.adoc b/src/site-docs/adoc/fragments/install-guide/layout.adoc
new file mode 100644
index 000000000..ef3d1cf5b
--- /dev/null
+++ b/src/site-docs/adoc/fragments/install-guide/layout.adoc
@@ -0,0 +1,47 @@
+//
+// ============LICENSE_START=======================================================
+// Copyright (C) 2016-2018 Ericsson. All rights reserved.
+// ================================================================================
+// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+//
+// SPDX-License-Identifier: CC-BY-4.0
+// ============LICENSE_END=========================================================
+//
+// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+//
+
+== Installation Layout
+
+A full installation of APEX comes with the following layout.
+
+----
+$APEX_HOME
+ ├───bin <1>
+ ├───etc <2>
+ │ ├───editor
+ │ ├───hazelcast
+ │ ├───infinispan
+ │ └───META-INF
+ ├───examples <3>
+ │ ├───config <4>
+ │ ├───docker <5>
+ │ ├───events <6>
+ │ ├───models <7>
+ │ └───scripts <8>
+ ├───lib <9>
+ │ └───applications <10>
+ └───war <11>
+----
+<1> binaries, mainly scripts (bash and bat) to start the APEX engine and applications
+<2> configuration files, such as logback (logging) and third party library configurations
+<3> example policy models to get started
+<4> configurations for the examples (with sub directories for individual examples)
+<5> Docker files and additional Docker instructions for the exampples
+<6> example events for the examples (with sub directories for individual examples)
+<7> the policy models, generated for each example (with sub directories for individual examples)
+<8> additional scripts for the examples (with sub directories for individual examples)
+<9> the library folder with all Java JAR files
+<10> applications, also known as jar with dependencies (or fat jars), individually deployable
+<11> WAR files for web applications
+