PA OXaaS APSv2 Deployment Guide: Difference between revisions

From Open-Xchange
Line 121: Line 121:


# Install PHP interpreter via yum install PHP and Apache HTTP server via yum install httpd if your Linux distribution does not include them. Please check your installed version of PHP via:
# Install PHP interpreter via yum install PHP and Apache HTTP server via yum install httpd if your Linux distribution does not include them. Please check your installed version of PHP via:
  #:[root@endpoint ~]# php -version
  [root@endpoint ~]# php -version
#:And ensure your Apache HTTP server is up and running:
#:And ensure your Apache HTTP server is up and running:
  #:[root@endpoint ~]# service httpd status
  #:[root@endpoint ~]# service httpd status

Revision as of 07:26, 15 December 2015

Deployment Guide for the OX as a Service APSv2 package into Odin Service Automation

This APS 2.0 package is only for the Open-Xchange own OXaaS platform or similar respective compatible deployments or copies of this platform. The package is designed for syndication and on-premise customers with Odin Service Automation 5.5 and higher.

This guide describes the integration for the OX as a Service APSv2 package into Odin Service Automation. This guide is intended for providers that use Odin Service Automation and want to sell Open-Xchange services to customers.

Terms and Abbreviations

Below is the list of concepts and abbreviations you will find in this page.

Abbreviation Definition
API Application Programming Interface
APS Application Packaging Standard, an open standard that was designed to simplify the delivery of SaaS applications in the cloud-computing industry.
HTTP Hypertext Transfer Protocol
OSA Odin Service Automation (former Parallels Automation), which includes both POA and PBA
PBA Parallels Business Automation.
POA Parallels Operations Automation.
SaaS Software as a Service.
SSO Single Sign-On.
URI Uniform Resource Identifier
URL Uniform Resource Locator
VM Virtual Machine
VPS Virtual Private Server


Conventions

Below is the list of conventions you will find in this page.

Abbreviation Definition
OpenXChange-xxxx.app.zip Package Open-Xchange is the name of the package and xx-xx is the placeholder for a specific version of the APS
Foldername Name of the folder where a specific file is located. In this case, “openxchange”
https://endpoint-ipor-dns IP or URL of the environment

Business Model Overview

About Open-Xchange

The standard business model of Open-Xchange consists of two major components: a platform fee and a revenue share. With the platform fee the customer pays the basic access to the hosted service or the software and it usually includes a certain amount of basic packages that are ideally distributed to a wide audience of users by bundling them into other products.

Integration Prerequisites

Before you start integrating Open-Xchange into OSA, learn about the necessary preparations for the process.

Prerequisites for the OSA Platform

The APS Package v1.1-9 requires POA v6.0.4 or higher and OX App Suite 7.6.2 or higher.

Prerequisites for the Endpoint

Prerequisites Notification code server
Description Specific node with Apache and PHP used to install the system script.
Software
  • Apache >= 2.2.15 with mod_ssl
  • PHP >= 5.3.3
  • aps_php_runtime >= 2.1-292
Platform

Preparing the Endpoint Host Server

Open-Xchange APS Package requires an application host server to be set up before it can be successfully imported and used in OSA. This endpoint server can be provisioned as a VPS or a VM in the same infrastructure as OSA systems. Please make sure you have OSA (POA + PBA) infrastructure set up properly before continuing. The Provider’s guide for setting up OSA can be found at http://download.pa.parallels.com/pa/6.0/doc/.

You can either choose the automated endpoint deployment by using the endpoint.sh script file or use the manual installation process by continuing reading this chapter. For more information about automated endpoint deployment, please refer to https://doc.apsstandard.org/2.1/pa/deployment/#automated-setup-based-onendpoint-sh for instructions of use and download here the script endpoint.sh: http://doc.apsstandard.org/2.1/pa/deployment/#automated-setup-based-onendpoint- sh.

Please verify if the endpoint is compliant with the above-mentioned prerequisites.

These deployment instructions are based on the fresh installation of CentOS 6. All required packages are installed and managed by its yum package manager.

Before carrying out the steps described below, you must have:

  • Server path
  • Credentials: ID and password
  1. Install PHP interpreter via yum install PHP and Apache HTTP server via yum install httpd if your Linux distribution does not include them. Please check your installed version of PHP via:
[root@endpoint ~]# php -version
  1. And ensure your Apache HTTP server is up and running:
#:[root@endpoint ~]# service httpd status
  1. The answer should be:
#:httpd (pid 5749) is running...
  1. The default document root directory for Apache HTTP Server is located at /var/www/html/.
  1. The application host server requires the APS PHP Runtime library. Check if you have installed the appropriate version by using the following command:
 [root@endpoint~]# rpm –qa | grep aps
Otherwise, it can be downloaded from http://doc.apsstandard.org/tools/php_lib/.
If you need to copy files from different servers, we recommend using an FTP client.
If you have an older version installed, execute the command below:
 [root@endpoint~]# rpm -Uvh aps-php-runtime-{version}.noarch.rpm
If you do not have PHP runtime installed on your server, do the following:
 [root@endpoint~]# rpm -ivh aps-php-runtime-{version}.noarch.rpm
Where aps-php-runtime-{version}.noarch.rpm is the name of the PHP runtime library, and {version} is the version number you download from the above link. After the installation, the /usr/share/aps/php directory will be added to the system php.ini file automatically.

Open-Xchange Services Provided

Below is the list of resources provided by Open-Xchange:

Resource Name Resource Class Limit Auto-Provide
OX Globals Application Service Reference 1 No
OX Brand Application Service Reference 1 No
OX Profile Webmail Application Service Reference Unlimited No
OX Profile Basic Application Service Reference Unlimited No
OX Profile Advanced Application Service Reference Unlimited No
OX Profile Pro Application Service Reference Unlimited No
OX Shared Domain* Application Service Reference Unlimited No
OX Shared Subdomain* Application Service Reference Unlimited No
Odin Business Automation Application Service Reference 1 No
OX Tenant Application Service 1 Yes
OX User Application Service Unlimited No
OX Email Address Application Service Unlimited No
OX Domain Application Service Unlimited No
OX Purchase Request Application Service Unlimited No
OX Group Application Service Unlimited No
OX Subdomain Application Service Unlimited No
OX Resource Application Service Unlimited No
OX Storage Quota Application Counter (KB) Unlimited No
  • You can add as many as necessary.

Integration Workflow

The integration workflow looks as follows:

Deployment

Please refer to the Deployment Guide for more detailed information. This action is performed once and consists of:

  1. Deploying Open-Xchange application endpoint.
  2. Importing Open-Xchange application package.
  3. Creating service instance in the Provider Control Panel.

PA Integration

  1. Creating the required resource types. For further details, please refer to the Resource Creation section of this guide.
  2. Creating the service template. For further details, please refer to the Service Template Creation section of this guide.

Localization List

Open-Xchange has been localized in the following languages for each category:

  • Customer Interface: English
  • PA task manager error logging: English
  • Open-Xchange API error messaging: English

Technical Overview

This section contains an outline of how the integration of Open-Xchange and PA is performed and the list of Open-Xchange features that are supported within the integration package.

Supported Architecture and Requirements

The Principle of OSA & APS 2

The usual way that users use Odin, in order to get OX App Suite, is as follows:

  1. Open-Xchange published an APS 2 package into the Odin catalogue/ecosystem.
  2. Odin customers, and service resellers, see the package and want to resell OX App Suite.
  3. The service resellers downloads the APS 2 package and installs it into their OSA system
  4. The OSA system will ask for the location of a running and compliant OX App Suite System (This can be OXaaS or a compliant in-house OX App Suite System)
  5. The reseller can then sell OX App Suite accounts.

Compliant OX App Suite System

There are two options to connect an OX App Suite system:

  1. Use the OXaaS service that is provided by Open-Xchange
  2. Use an on-premise installation that includes a complete OX App Suite system, a Dovecot mail system and all the related services.

Use the standard recommend components together with provided configurations for:

  • Apache
  • Mysql
  • Openldap (with a dedicated Open-Xchange schema)
  • HAproxy
  • Postfix
  • S3 compatible Objectstore (as a file/email backend)

Please refer to following high level architecture diagram and if you have any questions please contact sales@open-xchange.com

Odin Architecture.png

Components

The following table shows the main actions offered by the APS through the different panels of OSA.

Components Actions
Odin Admin
  • Import APS package.
  • Create an APS instance.
  • Manage application settings:
    • CRUD tasks to automatize report creation.
    • CRUD brands.
    • Edit OX App Suite branding settings.
    • Download reports.
    • CRUD shared domains / subdomains.
    • CRUD profiles.
Odin Customer Manager
  • Buy subscriptions.
  • View resource usage.
  • Buy more profiles (in app purchase).
  • Create service users.
  • Enable / Disable OX App Suite for a service user.
  • Add email aliases to an existing user of OX App Suite.
  • Change profile of an existing OX App Suite user.
  • View mailbox and storage usage per user.
  • CRUD user groups.
  • CRUD resources.
  • CRUD domains / subdomains.
  • Configure catch all for existing domains.
  • View all users’ purchase requests.
Odin Service User
  • View profile features.
  • Go to OX App Suite.

Download

APS package

Download the APS package from the APS catalog: http://dev.apsstandard.org/apps/2.0/Open-Xchange/Open-Xchange/Mamasu/

Open-Xchange

Please contact Open-Xchange for further download and configuration information via info@open-xchange.com.

OSA Integration

Configuring Services for Selling - POA

Learn about how to configure the service templates that are necessary to create Open-Xchange APS subscriptions for sale.

Instance Configuration

Minimum Instance Configuration

In order to configure the instance, the following minimum steps need to be observed:

  1. Configure the settings (please refer to the APP Settings subsection, under the Detailed Configuration section).
  2. Configure the reseller’s brands (please refer to the Brands subsection, under the Detailed Configuration section).
  3. Configure the profiles (please refer to the Profiles subsection, under the Detailed Configuration section).
Detailed Instance Configuration

A description follows on how to configure all the specific settings of this particular instance.

Accessing the Instance
  1. In the POA Provider Control Panel, navigate to Services>Applications.
  2. Click on the latest version of the Open-Xchange APS package.
  3. Go to the Instances tab.
  4. Click Open-Xchange.
App Settings

On this tab the list of possible scripts that can be configured as background tasks for this Open-XChange APS2 is displayed. These scripts are used to create the reports. Aps2 1.png

  • You can see the script name, file, next execution, period as well as their status, which can be:

Aps2 2.png: enabled
Aps2 3.png: pending

  • In order to create a cron, click Create. As soon as it is ready the status will change to “Enabled”, then it can also be Disabled, Edited or Deleted.
  • This tab also shows the last 10 cron executions to check their current status.

Aps2 4.png

  • The status of the executions can be:

Aps2 2.png: the execution was successful.
Aps2 5.png: the execution is in process.
Aps2 6.png: an error has occurred during the execution.

Brands

This tab is used to assign each Open-Xchange reseller with a brand. To do so:

  1. Click on Add new brand.
  2. Fill in the required fields:
    • Name: name of the brand.
    • Username: username of the brand.
    • Password: password or the brand.
    • API URL: URL where the API is located.
    • SSO URL: URL of the Single Sign On.
    • APP Suite Login Page: login page of the APP Suite.
    • Label of service name: name that will be displayed on all buttons and tabs and refers to the service. It could be “App Suite”, but if the provider has his own service name, which is used for his brand, it can also be defined here.
    • Select “Purchase request enabled” and “Catch all enabled for customers”, if appropriate. If the first option is enabled users are allowed to request customers some extra resources or services. The second one is to enable or disable the use of a catch all email in customers’ domains.
  3. Click on Create to add the brand.
  4. Once the brand has been created, you can view or edit the settings, branding and list of domains and subdomains.

    Aps2 7.png
  5. By clicking on View, you can:
    • See and edit the settings previously defined. You can also download the “Last contexts report” or the “Last users report” in CSV format.

      Aps2 8.png
    • See the brand’s settings:
      • Application URL.
      • Global settings.
      • Global application settings.
      • Various theme settings that can be defined per brand.

        Aps2 8.png
    • Add, edit or delete the reseller’s shared domains and subdomains:

      Aps2 9.png
      • Click on Add new domain or Add new subdomain to specify the domain name and login (login of an existing user in the current Open-Xchange reseller), then click on Save:

        Aps2 10.png
      • You can also edit an existing domain or subdomain by clicking on Edit.

        Aps2 11.png
Profiles

On this tab you can add, edit and delete a profile. Aps2 12.png

Click on Add new profile and specify the following features, then click on Save. Aps2 13.png

  • Name: profile name.
  • Feature level: select the level from the drop-down list.
  • Mail quota: mail quota provided (defined in KB).
  • Disk quota: disk quota provided (defined in KB).
  • Feature level defines a preset of add-ons, but two additional add-ons can be enabled apart from the predefined list. These are:
    • Documents.
    • Guard.

Resource Creation

  1. In the POA Provider Control Panel, navigate Services>Applications.
  2. Click Open-Xchange in the APS Packages tab.
  3. Go to the Resource Types tab.
Application Service Reference
Creating a Globals Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Globals.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.

      Aps2 14.png
  3. Click Next, then select Open-Xchange Application as the APS type.

    Aps2 15.png
  4. Click on the instance.

    Aps2 16.png
  5. Click Finish. The resource has been created.
Creating a Brand Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Brand.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Brand as the APS type and then click on the instance.
  4. Click Finish. The resource has been created.
Creating a Profile Basic Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Basic.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Profile as the APS type and click on the instance.
  4. Click Finish. The resource has been created.
Creating a Profile Webmail Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Webmail.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
  4. Click Finish. The resource has been created.
Creating a Profile Advanced Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Advanced.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
  4. Click Finish. The resource has been created.
Creating a Profile Pro Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Profile Pro.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Profile as the APS type and then click on the instance.
  4. Click Finish The resource has been created.
Creating a Shared Domain Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Shared Domain.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Shared Domain as the APS type and then click on the instance.
  4. Click Finish. The resource has been created.

NOTE: Please remember that you can add as many Shared Domain resources as necessary.

Creating a Shared Subdomain Resource
  1. Click on Create, then on Application Service Reference.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Shared Subdomain.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, select Open-Xchange Shared Subdomain as the APS type and then click on the instance.
  4. Click Finish. The resource has been created.

NOTE: Please remember that you can add as many Shared Subdomain resources as necessary.

Application Service
Creating a Tenant Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Tenant.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.

      Aps2 17.png
  3. Click Next, then select Open-Xchange Tenant as the APS type.

    Aps2 15.png
  4. Tick the “Automatically provision service” checkbox and leave the Priority field blank

    Aps2 19.png
  5. Click Next, then Finish. The resource has been added.
Creating a User Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange User.
  3. *Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  4. Click Next, then select Open-Xchange User as the APS type.
  5. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  6. Click Next, then Finish. The resource has been added.
Creating an Email Address Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Email Address.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Email Address as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Creating a Domain Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Domain.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Domain as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Creating a Purchase Request Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Purchase Request.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Purchase Request as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Creating a Group Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Group.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Group as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Creating a Subdomain Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Subdomain.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Subdomain as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Creating a Resource Resource
  1. Click on Create, then on Application Service.
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Resource Resource.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Open-Xchange Resource as the APS type.
  4. Leave the “Automatically provision service” box unchecked and the Priority field blank.
  5. Click Next, then Finish. The resource has been added.
Application Counter
Creating a Storage Quota Resource
  1. Click on Create, then on Application Counter (KB).
  2. Fill in the following fields:
    • Name: enter the name of the application and the type of resource. In this case, Open-Xchange Storage Quota.
    • Description: this field is used to describe the type of resource. You can leave it blank or enter the information you wish.
  3. Click Next, then select Tenant Storage Quota as the APS type.
  4. Click Finish. The resource has been added.

Template Creation

  1. In the POA Provider Control Panel, navigate Products>Service Templates.
  2. Click on the Add New Service Template button.

    Aps2 20.png
  3. Configure the service template’s general parameters:
    • Name: enter the name, for example: Open-Xchange.
    • Description: this field is used to describe the template. Leave it blank or enter the information you wish.
    • Tick the “Autoprovisioning” checkbox.
    • Type: set the type as “Custom”.

      Aps2 21.png
  4. Click Next. The template has been created.
  5. Select all the resources created earlier as well as Odin Business Automation, then click Next.
  6. Set the limits for the resource types included in the service template.
    • For Globals, Brand, Tenant and Odin Business Automation uncheck the Unlimited checkbox and set the limit as 1.
    • For the rest of resources, leave the Unlimited checkbox marked.
  7. Click Next, then Finish
  8. To activate the service template:
  9. Open the newly created service template (Open-Xchange).
  10. In the General tab, click on Activate.

    Aps2 22.png
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=PA_OXaaS_APSv2_Deployment_Guide&oldid=21111"