Public Information

charts/README.md

@@ -0,0 +1,100 @@
+# nplus Charts
+
+These are the sources to the nplus Charts. There are 4 levels:
+
+1. Cluster
+2. Environment
+3. Instance
+4. Component
+
+## Cluster
+
+The ***cluster*** chart is responsible for installing all prerequisites for nplus into the Kubernetes Cluster. This is specifically the CRDs later used by the environment.
+
+## Environment
+
+The ***environment*** chart installes the nplus operator, toolbox etc. into a Kubernetes namespace, making this namespace capable of housing nplus Instances
+
+## Instance
+
+The ***instance*** and ***instance-argo** charts install an nplus Instance into an nplus Environment. Every Instance consist of any possible combination of componens:
+
+## Components
+
+### administrator
+
+This is the official nscale Administrator (Web / RAP). It connects to an Application Layer to store its state in the global client settings. It can however connect to any nscale component to perform the **online** configuration.
+
+### Prepper
+
+Downloads, deploys and runs any git asset or script prior to deployment of the components
+
+### application
+
+This handles the installation of solutions / scenarios / apps into a running instance.
+
+### cmis
+
+This component exposes a CMIS compatible interface, with REST and SOAP flavours. 
+
+### database
+
+The database charts installs a postgres instance into the nplus instance. It should not be used for production without further service.
+
+### ilm
+
+The ***ilm*** chart installs the *nscale ERP ILM Connector* which is a SAP certified ILM service.
+
+### proxy
+
+The ***proxy*** chart installs the *nscale ERP Proxy Connector* which is a SAP Content Service request forwarder to migrate alien Archiv Solutions to nscale
+
+### mon
+
+The ***mon*** chart adds a *nscale Monitoring Console* to the nplus instance.
+
+### nappl
+
+The ***nappl*** chart hosts an nscale Server Application Layer, which is a central component in the nscale ecosystem. Most nplus Instances should have at least one ***nappl*** instance. However, there are also scenarios like *central services* (see samples), where one would potentially not use a ***nappl*** within the nplus instance.
+
+### nstl
+
+A *nscale Server Storage Layer* is added by this ***nstl*** chart. The Storage Layer is basically a Blob Store Component, that virtualizes storage subsystems and adds a layer of legal compliance for many governmental requirements.
+
+In terms of storage subsystems, the ***nstl*** chart can be used to connect multiple storage subsystems like S3, Azure Blob Storage and also Hardware Stores like NetApp, EMC Centera etc.
+
+### pam
+
+This is a Chart for the *nscale Process Automation Modeler*, an administrative component that allows the definition of workflows or processes in BPMN on a web ui.
+
+### pipeliner
+
+The ***pipeliner*** chart installs the *nscale Pipeliner*. It also features an optional **WebDAV** component to provide upload capabilities.
+
+### rms
+
+The ***rms*** chart can be used as an *Adminstrator Server* for the nscale Administrator Client. The chart comes with the original nscale RMS component as well as a TCP Proxy, that allows to connect to the original component running in a container via TCP.
+
+The chart exposes its service through a virtual IP adress provided by a Kubernetes loadbalancer service.
+
+### rs
+
+The *nscale Rendition Server* is installed by this ***rs*** chart. It is used by the *nscale Application Layer* to render content into multiple formats.
+
+### sharepoint
+
+This is a chart for *nscale Sharepoint Connector*
+
+### web
+
+*nscale Web* is the official Web Client for *nscale*. It connects to a *nscale Application Layer* as the *EIM* backend. 
+
+### webdav
+
+*nscale WebDAV Connector* is a WebDAV Client for *nscale*. It connects to a *nscale Application Layer* as the *EIM* backend. It services a standard WebDAV protocol interface to be used by any WebDAV client.
+
+
+
+# Misc
+
+The ***global*** chart is a library chart with common functions used by all other charts. It cannot be installed.