If you start using the platform SDK, this is the first document that you should study.
In this document:
If you are familiar with the APS integration principles generally and want to start practicing in the APS environment, follow the Get Started scenario that directs you through the step-by-step process of creating your first APS application. The scenario includes the simplified design, development, deployment, provisioning, and update of the application.
Distribution of cloud services to businesses is simpler through Hosting Providers, Telecommunication Companies and Value Added Resellers – Service Providers. With this channel, an Application becomes available to millions of existing customers across the globe. You can focus on improvements of your technology, while Service Providers take care of your business growth.
Odin Automation service automation platform provides its internal Application Packaging Standard (APS) controller as a way for independent software vendors (ISV) to distribute cloud services through service providers.
In Odin Automation, APS is a unified method to integrate applications and third-party management systems regardless of their complexity.
APS allows various cloud service vendors to integrate their applications with the platform through an integration APS package created for each application. The applications can collaborate with different cloud services through the standardized RESTful API within the APS ecosystem.
APS packages, certified as APS-compliant, are usually stored in the APS catalog, which makes them available to any service providers.
In Odin Automation, integration with applications is implemented by means of the APS ecosystem.
The platform contains a special module called APS controller that provides to applications a RESTful based bus for exposing application endpoints to be used by other applications and management systems.
The APS controller functions as a message broker - all APS REST messages go through it.
All participants on the APS bus are split into two groups:
The interaction between the integrated components goes through the APS controller. The latter stores the presentation of application resources as APS resources (objects) in its database.
The platform services are available for other integrated systems and applications as integration points, for example:
The platform user interface (UI) is provided through the provider control panel (PCP) and customer control panel (CCP v1 and CCP v2). Any integrated application can extend the control panels by adding their navigation panel with custom UI views.
An application is integrated into the APS ecosystem through a special integration component, known as APS application. The latter consists of:
To integrate an Application with the platform, the Application integrator should develop an APS package that allows providers to deploy the respective APS application on their platforms.
The APS application life-cycle includes the following steps:
In the Application life-cycle inside the APS ecosystem, an integrator needs to complete the first step, that is, to develop an APS package for the Application they want to integrate with the platform. Using this package, service providers will be able to deploy the Application and sell the Application services to many customers.
Odin Automation is the leading hosting and cloud services delivery platform used by thousands of service providers worldwide, from the largest telecom operators in the world to top hosters and providers of vertical solutions.
The platform combines Operations Support System (OSS) and Business Support System (BSS). In the simplest case, you may use a test platform containing only OSS installed on a single host called management node.
The platform uses the APS technology for application service delivery. Assuming that you have some developed APS packages, you will need to go through the rest of the application life-cycle stages to complete the integration with the platform:
The platform provides all necessary services for it as described in the following sections.
For testing APS applications and for training, we recommend that you use a separate test platform. In the simplest case, it consists of the OSS part on the management node without the BSS. You will need the BSS, when testing the integration with the platform commercial integration points.
If you do not have such a test platform yet, register your company and yourself in the APS development portal and then order a sandbox with the simplest configuration without BSS, that is “lin-mn” configuration, or with the complete configuration, for example, “lin-pba”, by following the corresponding procedures.
You can get started by using two major account types - provider and customer.
There is only one account of the provider type who is the owner of the installed platform.
On the newly installed platform, you have a user whose login name is
admin and the password
specified by you during the installation. Log in to the platform
admin credentials. For example, if the domain name you assigned to the management node
http://a.isv1.apsdemo.org:8080 in the address field of your browser and then log in as
HTTP on port 8080 is available only from the private network where the management node is installed. If you ordered an APS sandbox, you can access that network through a VPN channel. The access from the Internet to a production system is available through HTTPS only.
You will get access to the OSS provider control panel (PCP).
If BSS is also installed, you can switch to the BSS provider control panel and then switch back to OSS.
The provider can create any number of customers. Every customer normally has an administrator (staff member), who has necessary permissions to manage all customer resources. The administrator can log in to the customer control panel (CCP) using the same URL as the provider but entering their own email address as the login name. If necessary, the administrator can create any number of service users (end users) and assign services (resources) to them. Any of those users can get access to their own control panel, called MyCP, using their email address as the login name.
This section concerns application services and resources provided by them. We do not consider the application user interface (UI) here.
An APS package contains a declaration of the APS application API by means of APS types. For each APS application service, the package declares an APS type (one-to-one relation) with the following typical definitions in JSON format:
You can consider a cloud application as integrated into the APS ecosystem only after the provider establishes a secure connection between the platform and the original service API. Also, the platform must incorporate a custom application UI to manage the application services.
Installation of an APS application requires the following steps:
Appas the resource schema.
An APS connector must have a connection with the cloud application. It will convert the REST requests from the APS controller to the original API calls of the cloud application.
Generally, an APS package declares the following APS types:
Pay attention to the built-in APS specific resource classes described in the next section.
To provide any service, the platform must have a resource type describing the service specifics by means of activation parameters. For APS applications, there are two resource classes used to create two groups of resource types:
The provider can subscribe customers to services only through a service template that must contain all resource types the provider is going to sell.
For each resource type in a service template, the provider must set a limit. If a resource is unlimited,
limit property in the service template is set to -1.
In OSS, after a customer is subscribed to a service template, the system creates a subscription for the customer.
In the simplest case, a list of resources along with limits in a subscription are copied from the corresponding service template.
A subscriber can use a subscription to create (provision) and then use application resources.
Normally, one of the resources in a subscription is auto-provisioned in the previous step, when the subscription is created. During resource provisioning, the APS controller creates a new APS resource and requires the APS connector to provision a respective resource on the application side. When creating a resource, for example a mailbox, the customer can select an offer to assign its parameters to the new resource.
When integrating a cloud application into the APS ecosystem, the best way to start is to identify the integration points most suitable for you and follow the Integrating Cloud Services how-to procedures.
If the how-to procedures do not meet all your integration requirements and you need to know more details about the APS ecosystem and platform specifics, dive deeper into the Concepts. You will study there:
There are a number of reference guides with formal description of APS API and runtime environments that help you reach your goals in the most effective and efficient ways. Use them when you need to identify exactly the syntax of an API call, attributes of a type property, operations of a standard type, or other. Keep the following reference documents handy:
We recommend that you download, install, and use the APS tools when developing APS applications. The following documents help you arrange your APS development environment, validate and pack your APS project in compliance with the standard: