Deploy CMP
To deploy the CMP
Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. stack to the target system, run the following command from the directory that the Ansible Playbook has unzipped from:
where <inventory file> is the file that has been generated by the Installation Configuration Tool.
See Common Ansible Command Line Parameters to get details about combinations of the command line parameters that can be used.
Common Ansible Command Line Parameters
The ansible-playbook is quite flexible, allowing users to control the way it accesses the target environment. Depending on the deployment scenario, a combination of the command line parameters that are described in the following table can be used:
|
Parameter |
Description |
Example |
|---|---|---|
|
-b |
Runs all the tasks in the play with elevated access (using sudo). This is mandatory parameter. It must always be used when running Ansible playbooks. |
|
|
-k |
Prompt user for connection password. If specified, the user will be prompted to enter the password for the user specified in the |
|
|
-K |
Prompt user for the sudo password. If specified, user will be prompted to enter the remote username password. Usually it is defined by the |
|
|
--ask-vault-pass |
Prompt user for the vault password. If specified, the user will be prompted to enter the vault password. |
|
|
--vault-password-file |
Points Ansible command to the vault password file. |
|
|
-i |
Points Ansible to the inventory file. |
|
Rather than deploying all CMP components in one go as described above, you can deploy individual components of the system using the playbooks files stored in the playbooks directory. The deploy.yaml playbook referenced in the overall installation above simply orchestrates these component-specific playbooks.
Important: Execution of lower level playbooks individually rather than using the orchestration in deploy.yaml can result in system misconfiguration if not done correctly. Zero downtime upgrade of a High Availability installation is also not possible by executing playbooks individually.Therefore only the use of deploy.yaml is supported for production environments unless MDS Global gives explicit instruction to execute a specific lower level playbook.
If the playbooks are executed individually, it is important to note that they have the following dependencies:
- Three components must be installed in order:
- Database (deploy-db.yaml)
- WSO2IS (deploy-wso2is.yaml)
- Role-extender (deploy-role-extender.yaml)
- JBoss An open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. JBoss AS is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other web-based applications and software. JBoss is an open source alternative to commercial offerings from IBM WebSphere and SAP NetWeaver. must be deployed prior to the following: agent-view-installation-layer, published-interfaces-layer, SOAP WS and configuration-centre.
- JWS must be deployed prior to agent-view and wso2is-login.
- Once JBoss and JWS are deployed, then the dependant components and any remaining components can be deployed in any order.
This table describes the deployment playbooks and summarises the dependencies between them:
|
Playbook Name |
Depends On |
Description |
|---|---|---|
|
deploy-db.yaml |
Deploys the postgres database |
|
|
deploy-wso2is.yaml |
deploy-db.yaml |
Deploys the WSO2 Identity Server |
|
deploy-role-extender.yaml |
deploy-db.yaml deploy-wso2is.yaml |
Deploys the Role Extender Application |
|
deploy-health-check.yaml |
deploy-db.yaml |
Deploys the Health Check Service |
|
deploy-sam-services.yaml |
deploy-db.yaml |
Deploys the SAM Services |
|
deploy-voucher-management-services.yaml |
deploy-db.yaml |
Deploys the Voucher Management Services |
| deploy-shared-services.yaml | deploy-db.yaml | Deploys the Shared Services |
|
deploy-jboss.yaml contains deployment roles for: agent-view-interfaces-layer pil configuration-centre soap-ws |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml |
Deploys the JBoss/Wildfly Application Server along with AgentView Interfaces Layer, Published Interfaces Layer, Configuration Centre and SOAP Web Services |
|
deploy-jws.yaml contains deployments roles for: wso2is-login agent-view |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml deploy-jboss.yaml |
Deploys the JBoss/Tomcat Web Server along with WSO2 Identity Server Custom Login application for SSO and AgentView |
|
deploy-rest-ws.yaml |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml |
Deploy REST Web Services |
|
deploy-bulk-action-console.yaml |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml |
Deploys the Bulk Action Console Application |
|
deploy-context-sensitive-help.yaml |
|
Deploys the Context Sensitive Help Application |
|
deploy-pentaho-server.yaml |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender deploy-jws.yaml |
Deploys the Pentaho Reporting Server |
|
deploy-artemis.yaml |
Deploys the Artemis / ActiveMQ Application |
|
| deploy-sparc-engine.yaml |
deploy-db.yaml deploy-artemis.yaml |
Deploys the SPaRC Engine Application |
| deploy-sabre-server.yaml |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml deploy-artemis.yaml |
Deploy the Sabre Server Application |
| deploy-sabre-console.yaml |
deploy-db.yaml deploy-wso2is.yaml deploy-role-extender.yaml deploy-artemis.yaml deploy-sabre-server.yaml |
Deploys the Administration Console Application |
The individual playbooks can be executed independently, providing that the playbooks they depend upon have already been executed.
Summary File
Once the deploy.yaml script has successfully completed execution, a new file will be produced. The file outlines the summary that includes the URLs of the installed components as well as location of the component log files. The summary filename matches the name of the inventory file used (without the .yaml extension) with the suffix, summary.txt.