Welcome to Open Service Catalog Manager!
Open Service Catalog Manager (OSCM) is an open source application with enterprise quality level. It supports a bright spectrum of use cases, from SaaS Marketplaces to Enterprise IaaS Stores. It offers ready-to-use service provisioning adapters for IaaS providers like Amazon Web Services (AWS) and OpenStack, but is also open for integrating other platforms.
Service Providers can define their services with flexible price models and publish them to an OSCM Marketplaces. The Service Provider can decide on using the OSCM Billing Engine for the service usage cost calculation, or integrate an external one. Customers can subscribe to and use the services.
More details can be found in the OSCM documentation.
This guide helps you start up a basic installation of Open Service Catalog Manager (OSCM) with Docker and Docker Compose as quickly as possible. For more advanced configuration and usage please refer to the individual Docker containers' documentation. You can find the links in the Resources section.
A Linux system with:
We will refer to the Linux system with Docker installed as the docker host.
For initial tests, we recommend:
- 2 CPU cores
- 8GB of RAM
- 20GB of disk space
Please note that this minimum configuration is not suitable for production use.
We require a directory on the docker host which holds various data such as persistent database data, configuration data and so on.
We will use
/docker as an example, please substitute your own directory path.
Obtain OSCM images
Follow the links listed in the Resources section and pull the respective images from DockerHub.
We will run a deployment container which prepares configuration file templates for us. Use
-v to mount the directory you created earlier to /target in the container.
docker run --name deployer1 --rm -v /docker:/target servicecatalog/oscm-deployer
This creates two files with configuration variables. Please edit both files and adjust the configuration to your environment.
- .env: Configuration for Docker, such as images and the base data directory
- var.env: Configuration for the application, such as mail server, database and other settings
Get Docker Compose files and start the application
We will run a second deployment container which does the following:
- Create the necessary Docker Compose files
- Create the necessary subdirectories
- Initialize the application databases
- Start the application containers
docker run --name deployer2 --rm -v /docker:/target -v /var/run/docker.sock:/var/run/docker.sock -e INITDB=true -e STARTUP=true servicecatalog/oscm-deployer
The application will take a few minutes to start up. Once everything has started, you may access the OSCM administration portal in your web browser using the FQDN or IP address you specified earlier.
The initial login credentials are:
Enable login to APP and controllers
In order to be able to login to the Asynchronous Provisioning Platform (APP) and its service controllers, we will make some quick changes in the administration portal.
- Login to the administration portal
- Operation -> Manage organization
- Organization ID: Enter
- Enable the following Organization roles:
- Technology provider
- Fill in the mandatory fields (red asterisks)
- Click Save
- Account -> Manage users (Attention: Not Operation -> Manage users)
- Click on administrator
- Enter your Email address
- Enable all User roles:
- Click Save
- Logout of the administration portal and login again to enable the changes
Now you will be able to login to the APP:
As well as to the OpenStack controller:
/docker with the directory where Docker is installed. This directory is shared by all containers. By default, if you use your own SSL key pairs, you must also place all the public certificate files here. Read here for details on using custom SSL key pairs and adding public certificates to the OSCM truststore.
- oscm-core: Core application
- oscm-app: Asynchronous Provisioning Platform (optional)
- oscm-db: Database for oscm-core and oscm-app
- oscm-initdb: Initializes or restores the databases for oscm-core and oscm-app
- oscm-birt: Reporting engine (optional)
- oscm-branding: Webserver for marketplace branding packages (optional)