servicecatalog/oscm-deployer repository overview

⁠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), MS Azure, VMWare and OpenStack, but is also open for integrating other platforms. Service Providers can define their services with flexible price models and publish them to 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⁠.

⁠Getting Started

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.

⁠Prerequisites

A Linux system with:

• Docker⁠
• Docker Compose⁠

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.

⁠Data Directory

We require an install directory named 'docker' on the docker host which holds various data such as persistent database data, configuration data and so on. Choose any location you prefer. As example we will create this directory on the root level and refer to this as '/docker' in the following.

mkdir /docker

⁠Obtain OSCM Images

Follow the links listed in the Resources⁠ section and pull the respective images from DockerHub.

⁠Environment Settings

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. Use -e HOST_FQDN to set the host name, which you will use for accessing OSCM in your web browser.

docker run --name deployer1 --rm -v /docker:/target -e HOST_FQDN=$(hostname) 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
• Start the proxy container

docker run --name deployer2 --rm -v /docker:/target -v /var/run/docker.sock:/var/run/docker.sock -e INITDB=true -e PROXY=true -e STARTUP=true servicecatalog/oscm-deployer

⁠Usage

The application will take a few minutes to start up. Once everything has started, you may access the OSCM applications in your web browser using the FQDN or IP address you specified earlier.

https://hostname.fqdn

The OSCM welcome page provides a list of links to OSCM applications and documentation.

⁠Access the Administrator Portal

https://hostname.fqdn/oscm-portal/

The initial login credentials are:

• Username: administrator
• Password: admin123

⁠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 PLATFORM_OPERATOR
• Enable the following Organization roles:
  • Supplier
  • 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:

https://hostname.fqdn/oscm-app/

• Username: administrator
• Password: admin123

As well as to the OpenStack controller:

https://hostname.fqdn/oscm-app-openstack/

• Username: administrator
• Password: admin123

⁠Mail Mock

OSCM notifies users via email about access details for services and marketplaces, about permissions and other changes in case of event. In the default setup a mail mock is configured. This allows you to access all email from the web browser by following URL.

https://hostname.fqdn/mail/

The initial login credentials are:

• Username: administrator
• Password: admin123

Note: [1] The mail mock is best suitable for test and staging purposes. For productive usage, it's advised to configure a real mail server, with SMTPS or STARTLS as needed. Read the Operator's Guide for the details. [2] 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.

⁠Resources

• oscm-core⁠: Core application
• oscm-help⁠: Online help for the OSCM Portal
• 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)
• oscm-proxy⁠: Reverse Proxy for OSCM

⁠License

This software is provided under Apache 2.0 License⁠. View the NOTICE file⁠ for the third-party software contained.