This is documentation for the current major version Apprenda 7.
Documentation for older versions are also available.

Installing the Apprenda Cloud Platform

This guide goes through the steps of installing the Apprenda Cloud Platform using the Apprenda Platform Installer user interface. It assumes you are setting up a multi-node environment, but the same steps can be used if you are only installing on a single node.

The Platform installer will only install Apprenda on Windows nodes. If you plan to include Linux nodes in your Platform, they can be installed after you install the Platform on at least one Windows node. See more about installing Linux nodes.

Prerequisites

Before installing, make sure your environment is properly configured by following these guides:

To install you must have

  • at least one Windows node
  • the installation package of the Apprenda Cloud Platform (contact your support representative for more information on how to get this)
  • information about your environment configuration determined when going through the Pre-installation Checklist. This includes knowing your desired configuration for Linux nodes
  • the installer running on a node that will be part of the Platform

Installing the Platform

Start by opening the Apprenda.Wizard.exe from the Installer folder of the Apprenda Cloud Platform package. In the first screen select Install and click Next.


On the Welcome to Apprenda screen,

  1. select the Multi Server option as the Apprenda Installation mode
  2. check Show Advanced Options
  3. browse to the location of the Binaries folder in the install package

Then, click Next.


The following page displays Terms & Conditions for using the Apprenda Cloud Platform.

  1. read through the terms and conditions
  2. select the “I agree” check box

Then, click Next.


On the How would you like to license Apprenda? screen,

  1. select the license type

    • if you have not purchased a license and your total memory footprint is less than 16GB of RAM, select Use Apprenda Express License
    • otherwise, select I will provide a license File and browse to the location of your license file

Once you have selected a license file, the screen will show you the licensed attributes you will be able to use on the Platform. For Hybrid Cloud installations, your license file should encompass the URLs for all Clouds being installed. If you have an questions about your license, contact your support representative.

Click Next.


The next screen, Tell us who you are, is used to configure the initial Development Team account as well as the initial Platform Operator. You can use these accounts to log into the Platform after installation and begin configuring your Platform.

Fill in your company information and user credentials for all required fields. Company Alias, Administrator Email, and Administrator Password are used to create a special tenant on the Platform. If you are using Identity Federation and an External User Store, it is important that the Company Alias and Administrator Email not conflict with any tenant alias or user ID which will be returned by the EUS. If a conflict occurs, that user will not be able to log into the Platform.

Click Next.


On the Apprenda Needs to Send Emails. What Should it Use? screen, you can select how you'd like the Platform to send emails. The Platform will use the configured email service to help you monitor your Platform by send log or error messages from your guest applications. 

Using the Platform service to send emails is selected by default, but its recommended that you provide your own SMTP server for production environments. To use your own SMTP server,

  1. uncheck Use Apprenda's free cloud based solution to send emails
  2. fill in the information for the Sender Name, Sender Address, SMTP Host, and SMTP Port of your solution
  3. if you require a secure connection, select My SMTP server requires a secure connection
  4. if you require authentication, select My SMTP server requires authentication

Click Next when you are finished configuring.


On What Windows Users Should Apprenda Run As?, you should fill in the account information for the Administrator Account and Apprenda System Account used by the Platform to launch and manage websites and servers. These accounts require specific configuration settings to install correctly, see the Pre-Installation Checklist and the Platform accounts page for more information about the correct setup for these accounts.

As of Platform version 7.1.0, you do not need the Apprenda System Account to manage Windows Services on the Platform and the option to add credentials for it has been removed from the installer. Instead, the Platform will use Virtual Accounts by default to manage these workloads to increase security and simplify managing users. See more information about Virtual Accounts.

Fill in the domain, user name, and password. Click Next when you finish.


For the Configure Clouds screen input information for the Clouds of your Platform. The Platform supports multiple Clouds and this screen is where you can input basic information about each Cloud.

  1. fill in the Cloud Name. This will be the identifier for this Cloud
  2. fill in Cloud URL. Include http:// and make sure the URL matches one specified in the Platform license
  3. fill in a Description of the Cloud
  4. choose the Cloud Type from the drop-down. Clouds can be Private, Hosted, or Public
  5. choose the Infrastructure Provider from the drop-down
  6. select Generate a self-Signed SSL certificate to use a Platform generated certificate for encryption on the Cloud
  7. if you want to use your own certificate, uncheck Generate a self-Signed SSL certificate. Then browse to the SSL Certificate Path and fill in a password if required by your certificate
    • You can import a TCP/SSL certificate signed by a known Certification Authority (see more about TCP/SSL certificates). If you use your own certificates, you must verify that the Certification Authority is trusted by all nodes in the Platform, or else your Platform may run into issues.

After filling in this information for a single Cloud, if you have another Cloud to add to your Platform, select Add Another Cloud. The same information should be provided for any additional clouds you want to add. For each Cloud you configure, you will need to fill out the subsequent Installer screens for configuring the nodes in each Cloud:What Servers Should We Start Off With?, What Database Servers Should We Start Off With?, Where Should We Install The Coordination Cluster Nodes?, Where Should We Install the Load Manager Server?, Where Should We Install the Cache Service?.

To switch between Clouds on this screen, click on the cloud icon with the name of the Cloud you want to view.

When you finish adding Clouds, click Next.


The What Servers Should We Start Off With? screen asks for information about the nodes in a given Cloud. If you configured multiple Clouds on the previous screen, you should only add servers for the current Cloud. You will be able to configure nodes for other Clouds in the Platform later. The Cloud Name of the current cloud is shown above the boxes to input servers. Note that only Windows servers should be added on this screen and you can add Linux Servers after the Platform is installed.

To add a server

  1. input the host name of the server in the Web Servers or Application Servers section
  2. click the + icon to add the server

The servers will appear in the corresponding box for Web Servers or Application Servers. Note that a server can be both a Web Server and an Application Server. See more about server roles.

To remove a server

  1. right click on the server icon named for the server you want to remove
  2. click on Remove server

Once you have finished configuring the servers for this Cloud, click Next.


On the What Database Servers Should We Start Off With? the Installer asks for information about the database nodes of the Platform. If you configured multiple Clouds, you should only add database servers for the current Cloud. The Cloud Name of the current cloud is shown above the boxes to input databases.

To add a database

  1. choose the Database Type. You can add SQL Server, Oracle 11G or Oracle 12C databases. See more about supported versions.
  2. input the Instance Name, Username, Password, CPU, Memory, and Storage for the database
  3. if you've selected Oracle 11g or Oracle 12c as the Database Type to add, you also need to add the Service Name and Port that were configured for the database during the Oracle install
  4. click the + icon to add the database

To remove a database

  1. right click on the database icon for the database you want to remove
  2. click on Remove DatabaseName (where DatabaseName is the name of the database you want to remove)

Note that if you want to edit a database server that has already been added, you will need to remove the database and re-add it with the correct information. 

After configuring all database servers for a Cloud, click Next.


On Where Should We Install The Coordination Cluster Nodes? you can select nodes that should be used for Platform coordination for the current Cloud. If you configured multiple Clouds, you should select servers for the current Cloud only. The Cloud Name of the current cloud is shown above the list of nodes. See more about Platform roles.

It's recommended that you assign an odd number of servers for this role as a majority of Platform Coordination nodes ((n+1)/2, where n=the number of nodes) must be up and running in order for the Platform to function properly. 

Nodes added as Web Servers and Application Servers for the Cloud on the What Servers Should We Start With? screen will appear here as available options for the Platform Coordinator role. You may also choose to use off Platform servers for your coordination cluster. Note that you can't use a combination of on Platform and off Platform servers to make up you coordination cluster.

To add servers that will not be part of the Platform for your coordination cluster

  1. check the option to Use servers that are not part of the platform
  2. input the Server Name for the off Platform server
  3. click Add Host

You can remove an added server by clicking on a server and clicking Remove Selected Host.

To assign a server as the Platform Coordinator role

  1. click on the server icon and name. A box will appear around it to indicate it has been selected
  2. select as many servers as you like to for coordination cluster

Click Next when you finish.


In the following screen, Where Should We Install the Load Manager Server?, you can assign which node will act as a Load Manager for this Cloud. If you configured multiple Clouds, you should select servers for the current Cloud only. The Cloud Name of the current cloud is shown above the list of nodes. See more about Platform roles.

You may use nodes that are not a part of the Platform for this role. Note that if your Platform installation will include more than one Load Manager, Load Manager nodes can't also be selected as Web Servers (assigned on What Servers Should We Start Off With?).

To add servers that will not be part of the Platform for load management

  1. check the option to "Use a server that is not part of the platform"
  2. input the Server Name for the off Platform server
  3. click Add Host

You can remove an added server by clicking on a server and clicking "Remove Selected Host."

To assign a server this the Platform Coordinator role

  1. click on the server icon and name. A box will appear around it to indicate it has been selected
  2. select as many servers as you like for load management

Once you have selected the node, click the Next button:

 


The Where Should We Install the Cache Service? screen covers Cache Service target selection. If you configured multiple Clouds, you should select servers for the current Cloud only. The Cloud Name of the current cloud is shown above the list of nodes. See more about Platform roles. You may use nodes that are not a part of the Platform for this role.

To configure how the cache server will work on your Platform,

  1. fill in the Maximum memory usage (MB) per instance. This sets the memory limit that each instance is allowed to use for caching
  2. fill in a Cache Password that the Platform will use to secure the cache
  3. fill in one or more port numbers the Platform will use to communicate with cache instances. Each port listed will correspond to a cache instance the Platform will create on each machine that is designated to host the cache service. One cache instance per CPU core on a host machine is recommended

To add servers that will not be part of the Platform for the cache service,

  1. check the option to Use a server that is not part of the platform
  2. input the Server Name for the off Platform server
  3. click Add Host

You can remove an added server by clicking on a server and clicking Remove Selected Host.

To assign a server this the cache service role,

  1. click on the server icon and name. A box will appear around it to indicate it has been selected
  2. select as many servers as you like for load management

When you're done, click Next. This is a last Cloud specific screen. If you have multiple Clouds to configure, clicking Next will bring you to the What Servers Should We Start Off With? screen where you can start configuring servers and roles for that Cloud. If you have only one Cloud, or have finished configuring all the clouds in your Platform, clicking next will bring you to the Choose the core database server screen.


On the next screen, Choose the core database server, you choose the Core Database for the entire Platform. The screen will display a list of all the SQL databases configured for the Platform. Note that the Core Database can't be located on an Oracle database instance.

Select the database you'd like to act as a Core Database.

Click the Next.


The following screen, Configure Platform Auditing, is where you can optionally decide to enable Platform Auditing. Auditing will enable your Platform to log specific operations performed by users, such as password changes, login failures, updates to roles and securables, etc. You can only enable or disable this feature through the installer. Once it is turned on (or off) you must re-install the Platform to turn it off (or on).

To enable auditing

  1. select Enable Platform Auditing
  2. fill in the Instance Name, User Name, and Password for the SQL database you wish to use for Auditing. You may use a database that is not part of the Platform if you chose. 

The Platform does not encrypt the Auditing database by default and it is your responsibility to enable any encryption configurations, like Transparent Data Encryption, on the supplied database.

When you're done, click Next.


On the Linux Server Configuration screen you can provide your Platform with information about your Linux nodes. The Apprenda Installer only installs the Platform on Windows nodes and you must manually install Linux node onto an existing Platform. Information provided on this screen relates to how the Platform will be installed on Linux servers later.

  1. fill in the Application and Server Mount Point locations. See more about configuring these locations
  2. choose if Automatic Workload Account Creation is enabled or disabled. If enabled, this will allow Linux workload accounts that don't initially exist on Linux machines to be auto-created by the Platform on those machines
  3. fill in a Default Workload Account for Java Web Application workloads hosted on Linux servers to run under

When you're done, click Next:


On the Installation Preferences screen, you can provide the Installer with information about how you'd like to install your Platform.

  1. fill in the Runtime Drive Letter that the Platform will use on all servers to store the files for application workloads while they are running (this defaults to the C drive)
  2. in the URLs section, fill in the subdomain that the Platform should use for path-based application URLs and Platform user interfaces (the full URL, appearing as http://{subdomain}.{rootURL}, will appear next to the input box)
  3. choose the location of the Platform Repository
    • if you select a server that has already been selected as a web or app server, the Installer will create the required Repository folders on a share called "Partitions" on the selected machines
    • alternately, you can select the Use a network location that you've prepared option and enter either a UNC path or mapped drive\path to Repository folders that you have already prepared

After you are done with your configuration, click the Next button:


The following screen, How Should Apprenda Manage Security?, will be used to configure the security of the Platform. Select all settings that you wish to apply to your Platform.

  1. choose to Enforce SSL on All Pages. By default all Platform applications can be accessed both through HTTP and HTTPS, but this option will require HTTPS for all pages
  2. choose to Require Authorization to access the System Operations Center (SOC). See more information on the SOC
  3. choose Let me specify the certificates for signing if you'd like to specify the certificate the Platform will use to sign authentication tokens used during Platform login sessions. If you do not check this option, a Platform generated certificate will be used. See more about signing certificates
  4. choose This Apprenda instance should allow identity federation if you decide to let your users use Identity Federation.

Click the Next button once you are done.


The next screen, Should Apprenda Encrypt Internal Communications?, offers you the option of enforcing encryption of internal Platform communications. To enable encryption, check the Encrypt internal communications box.

You will not be able to enable/disable internal Platform encryption in future. The setting for internal Platform encryption chosen when installing will be used throughout the lifetime of the Platform.

If you choose to enable internal encryption, you have three options in regards to the certificates that will be used:

  1. Apprenda will generate and install the issuer certificates that will be used; Apprenda will then create and install host certificates (named after each individual host) as needed.
  2. You may specify an issuer certificate (as a PFX file) and password; Apprenda will install the issuer certificate and will then create and install host certificates (named after each individual host) as needed.
  3. You may specify a public key for the issuer certificate as either a PEM or CER file. Apprenda will install the issuer certificate. You must create and install the host certificates as indicated in the 6.5 Pre-Installation Checklist.

Once you configure these options, click Next. You are now finished configuring your Platform. The remaining screens will validate your configurations and install your Platform!

 


The Configure My System & Network screen will validate your configuration settings and do some additional configuration steps to make sure that you are ready to install.

To start validation, click on the Validate My Configuration. Many incorrectly-configured items are automatically corrected by the Installer with no further input from you. If any configuration check fails, however, a red dot is displayed along with information about the failure and suggested actions for correction.

Notes

  • After validation, it is recommended to reset IIS by running the "iisreset" command on all servers designated as a Load Manager or Web Server to make sure that installation runs correctly

When all of them complete successfully, you will get a success message and will be able to click on the Next button to access the Install screen.


 

From the Install Apprenda screen you can begin installing your Platform!

Click Install to begin. If a task fails a red dot will be displayed next to it. Consider retrying in the event of a failure; otherwise, double-click on the event to get a detailed message of what caused the task to fail.

After all tasks are complete, you will have finished installing the Apprenda Cloud Platform. The Wizard will allow you to download the SDK if desired; otherwise, simply exit the Installer. Your Platform is now ready to be used.