Skip to content

Commit

Permalink
Update ka_inst_relFiles.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@anbernabei
anbernabei committed May 21, 2018
1 parent d1f489c commit 68b67c8
Showing 1 changed file with 80 additions and 149 deletions.
229 changes: 80 additions & 149 deletions installation-guide/ka_inst_relFiles.rst
View file
Original file line number Diff line number Diff line change
@@ -1,231 +1,162 @@
Released file description
=========================

4.1 Installation procedure
===========================
It is possible to download the software in the web site `www.knowage-suite.com/portal <http://www.knowage-suite.com/portal>`__ where we can find all resources for the installation, the single packages and the DDL.

Knowage can be installed in two ways: manually or using the
installer. In this section we will describe both procedures.
Here the essential elements for the installation:

4.2. Installer usage
-Installer,

4.2 Installer usage
====================
-DDL (see Table 4.1),

Knowage installer is an application which steers the user to the
installation and the first configuration of the product. It works in
both Linux and Windows operating systems.
-the single software packages.

|image8| To launch the installer, it is necessary to enable the flag
execution on the installation file, typing the command in the bash:

Installation procedure
----------------

Knowage can be installed in two ways: manually or using the installer. In this section we will describe both procedures.

Installer usage
------------------
Knowage installer is an application which steers the user to the installation and the first configuration of the product. It works in both Linux and Windows operating systems.

|image8| To launch the installer, it is necessary to enable the flag execution on the installation file, typing the command in the bash:

+----------------------------------+
| chmod +x <Knowage_unix_1_0_0.sh> |
+----------------------------------+



Now the installer is executable. Knowage can be installed using a GUI
or a command line. In the first case the user must type the the
command:
Now the installer is executable. Knowage can be installed using a GUI or a command line. In the first case the user must type the the command:

+-------------------------+
| ./Knowage_unix_1_0_0.sh |
+-------------------------+



while in the second case he must type the command:
while in the second case he must type the command:

+----------------------------+
| ./Knowage_unix_1_0_0.sh -c |
+----------------------------+


|image9| On Windows systems the installer requires some administrator
permissions.

Let’s describe the main steps of the execution:

- **Step 1.**\ ( Figure 4.1) Click on “Next” to go on with the
installation or “Cancel” to call off.

- **Step 2.**\ (Figure 4.2) Accept the license terms and conditions and
click on “Next”.
|image9| On Windows systems the installer requires some administrator permissions.

- **Step 3.**\ (Figure 4.3) The installer requires internet access to
connect with Knowage server in order to activate the licences and
download the installation packages. It is possible to configure
the proxy with for Internet connectivity inside the wizard. In
case the settings are wrong, cancel the current installation and
start a new one. If the connection succeeds, then the installer
proceeds with the online licences, otherwise the user is asked to
continue with the offline activation or to cancel the
installation.
Let’s describe the main steps of the execution:

- **Step 4.**\ (Figure 4.4) It is possible to activate the product
on-line thanks to an online activation procedure. It is necessary
though to purchase one (or more) product key(s). There are as many
product keys as the available components in Knowage. If the
installer recognises the product key, then it starts the
procedure, otherwise the activation fails.
-**Step 1.**\ ( Figure 4.1) Click on “Next” to go on with the installation or “Cancel” to call off.

..
-**Step 2.**\ (Figure 4.2) Accept the license terms and conditions and click on “Next”.

The user can insert a new product key until there are components to
activate.
-**Step 3.**\ (Figure 4.3) The installer requires internet access to connect with Knowage server in order to activate the licences and download the installation packages. It is possible to configure the proxy with for Internet connectivity inside the wizard. In case the settings are wrong, cancel the current installation and start a new one. If the connection succeeds, then the installer proceeds with the online licences, otherwise the user is asked to continue with the offline activation or to cancel the installation.

|image10|
- **Step 4.**\ (Figure 4.4) It is possible to activate the product on-line thanks to an online activation procedure. It is necessary though to purchase one (or more) product key(s). There are as many product keys as the available components in Knowage. If the installer recognises the product key, then it starts the procedure, otherwise the activation fails.

Figure 4.1: Installer GUI.
The user can insert a new product key until there are components to activate.

|image11|
|image10|

Figure 4.2: Licence acceptance.
Figure 4.1: Installer GUI.

|image12|
|image11|

Figure 4.3: Internet connection.
Figure 4.2: Licence acceptance.

|image13|
|image12|

Figure 4.4: Insert the product key.
Figure 4.3: Internet connection.

- **Step 5.**\ (Figure 4.5) If the user has chosen the online
activation, the products corresponding to the purchased product
keys are selected automatically and are not changeable by the
user. If the user has chosen the offline procedure he/she must
manually select at least one component to be installed.
|image13|

..
Figure 4.4: Insert the product key.

|image14|
-**Step 5.**\ (Figure 4.5) If the user has chosen the online activation, the products corresponding to the purchased product keys are selected automatically and are not changeable by the user. If the user has chosen the offline procedure he/she must manually select at least one component to be installed.

|image14|

Figure 4.5: Select components.
Figure 4.5: Select components.

- **Step 6.**\ (Figure 4.6) Select the desired application server and
set up its installation folder. The installer checks the
installation path of the application server before moving to the
next step.
-**Step 6.**\ (Figure 4.6) Select the desired application server and set up its installation folder. The installer checks the
installation path of the application server before moving to the next step.

- **Step 7.**\ (Figure 4.7) The metadata database is used by Knowage as
repository for the configuration information.
-**Step 7.**\ (Figure 4.7) The metadata database is used by Knowage as repository for the configuration information.

..

**Remark.** Set up a priori a DBMS to store Knowage metadata. Select
then the desired DBMS for metadata storage and modify the fields
accordingly. The installer will verify the connection before moving
to the next step. In addition the installer asks the user if the JDBC
connector should be installed the JDBC connector.
**Remark.** Set up a priori a DBMS to store Knowage metadata. Select then the desired DBMS for metadata storage and modify the fields accordingly. The installer will verify the connection before moving to the next step. In addition the installer asks the user if the JDBC connector should be installed the JDBC connector.

To configure a data DB the user must check the relative feature of
the wizard, as shown in Figure 4.8, otherwise the installer will not
configure such connection. Select then the desired DBMS as data
database and modify the fields properly. Once again the installer
verifies the connection before moving to the next step. The user is
asked to install on the application server the JDBC connector for the
specified DBMS.
To configure a data DB the user must check the relative feature of the wizard, as shown in Figure 4.8, otherwise the installer will not configure such connection. Select then the desired DBMS as data database and modify the fields properly. Once again the installer verifies the connection before moving to the next step. The user is asked to install on the application server the JDBC connector for the specified DBMS.

- **Step 8.**\ (Figure 4.9) The setting for clustering is deselected by
default, that is Knowage
- **Step 8.**\ (Figure 4.9) The setting for clustering is deselected by default, that is Knowage

..
|image15|

|image15|
Figure 4.6: Application server configuration.

Figure 4.6: Application server configuration.
|image16|

|image16|
Figure 4.7: Configuration of the metadata database.

Figure 4.7: Configuration of the metadata database.
|image17|

|image17|
Figure 4.8: Configuration of the metadata database.

Figure 4.8: Configuration of the metadata database.
Executes on a single node if not otherwise specified. To enable the clustering, select the number of nodes and set up the related IP address for each of them. The installer controls the correctness of each and that they are not repeated. The installation process is therefore activated. The installer attempts to download the installation files from the Knowage web site, for which credentials are required. If the connection fails and the installer cannot verify the user’s credentials, the installer asks the user if he wants to go on using the local WAR files. In this case the installer will check if all essential WAR files are located in the specified path, according to the components selected in the previous steps. It will also copy the WAR files (in the case of the offline installation) and add additional files if needed. All the additional tasks are hidden behind the progress bar showed in the installation wizard (refer to Figure 4.10).

executes on a single node if not otherwise specified. To enable the
clustering, select the number of nodes and set up the related IP
address for each of them. The installer controls the correctness of
each and that they are not repeated. The installation process is
therefore activated. The installer attempts to download the
installation files from the Knowage web site, for which credentials
are required. If the connection fails and the installer cannot verify
the user’s credentials, the installer asks the user if he wants to go
on using the local WAR files. In this case the installer will check
if all essential WAR files are located in the specified path,
according to the components selected in the previous steps. It will
also copy the WAR files (in the case of the offline installation) and
add additional files if needed. All the additional tasks are hidden
behind the progress bar showed in the installation wizard (refer to
Figure 4.10).
**Remark: offline manual activation.** Note that in this case the wizard, Figure 4.11, provides the instructions to ask for technical support and get the licence files that the user must manually install.

**Remark: offline manual activation.** Note that in this case the
wizard, Figure 4.11, provides the instructions to ask for technical
support and get the licence files that the user must manually
install.
**Step 9.**\ (Figure 4.12) The installation succeded. The user can now choose if to visit the Knowage website and click "Finish" to exit setup.

• **Step 9.**\ (Figure 4.12) The installation succeded. The user can now
choose if to visit the Knowage website and click "Finish" to exit setup.
|image18|

|image18|
Figure 4.9: Clustering.

Figure 4.9: Clustering.
|image19|

|image19|
Figure 4.10: Additional tasks.

Figure 4.10: Additional tasks.
|image20|

|image20|
Figure 4.11: Offline manual activation.

Figure 4.11: Offline manual activation.
|image21|

|image21|
Figure 4.12: End of the installation.

Figure 4.12: End of the installation.

4.3. Uninstaller

4.3 Uninstaller
===============
Uninstaller
--------------

At the end of the installation, the user can find the **uninstaller**
file inside the installation folder. This can be executed to unistall
Knowage.
At the end of the installation, the user can find the **uninstaller** file inside the installation folder. This can be executed to unistall Knowage.

|image22| The uninstaller is executable from the Knowage installation
folder:
|image22| The uninstaller is executable from the Knowage installation folder:

- using the GUI if a desktop environment is available;

- using the bash if it is executed typing the parameter “-c”.
- using the bash if it is executed typing the parameter “-c”.

|image23| On Windows Systems the uninstaller requires administrator
permissions. It can be executed from Windows menu or from the Windows
control panel.
|image23| On Windows Systems the uninstaller requires administrator permissions. It can be executed from Windows menu or from the Windows control panel.

|image24|
|image24|

Figure 4.13: Knowage uninstaller.
Figure 4.13: Knowage uninstaller.

Select also which optional features to run (in Figure 4.14 the available
ones) and click on “Next”. The uninstaller controls if the application
server is running in that moment. If that is the case, the uninstaller
cannot succeed in removing the Knowage packages.
Select also which optional features to run (in Figure 4.14 the available ones) and click on “Next”. The uninstaller controls if the application server is running in that moment. If that is the case, the uninstaller cannot succeed in removing the Knowage packages.

The uninstaller removes also the previous installed files, restores the
databases and the application server configuration.
The uninstaller removes also the previous installed files, restores the databases and the application server configuration.

Uninstaller
Uninstaller

|image25|
|image25|

Figure 4.14: Knowage uninstaller.
Figure 4.14: Knowage uninstaller.

|image26|
|image26|

Figure 4.15: Knowage uninstaller.
Figure 4.15: Knowage uninstaller.

Uninstaller
Uninstaller

|image27|
|image27|

Figure 4.16: Knowage uninstaller.
Figure 4.16: Knowage uninstaller.

0 comments on commit 68b67c8

Please sign in to comment.