Skip to Content
Technical Articles

How to deploy Eclipse Dirigible in the SAP Cloud Platform Cloud Foundry environment

Overview


Eclipse Dirigible is an open-source cloud development platform that provides capabilities for end-to-end development processes from database modeling and management, through RESTful services using server-side JavaScript, to pattern-based user interface generation, role-based security, external services integration, testing, debugging, operations and monitoring.

Some of the unique features include:

The platform aims to unify open-source business services by providing software developers with a convenient set of tools for building, running, and operating business applications in the Cloud. Dirigible is also part of the Eclipse Cloud Development top-level project.

Setup


Starting with the Eclipse Dirigible 4.3 release, there is a built-in integration with the SAP Cloud Platform Cloud Foundry environment. To deploy Eclipse Dirigible in your Cloud Foundry space, follow these steps:

  • Install the Cloud Foundry CLI. You can either get the latest release on the official release page or use your package manager
  • Clone the Eclipse Dirigible Deployment to the SAP Cloud Platform Cloud Foundry repository
    git clone https://github.com/dirigiblelabs/deployment-sap-cloud-foundry​
  • Navigate to the dirigible folder
  • Replace the following variables in vars.yaml before deploying
    Name Description Default Value
    applicationName The application name (e.g. dirigible) N/A
    subdomain The SAP Cloud Platform Cloud Foundry subdomain N/A
    regionId The SAP Cloud Platform Cloud Foundry region id N/A
    memory The runtime memory for the Eclipse Dirigible runtime 2G
    diskQuota The runtime disk quota for the Eclipse Dirigible runtime 2G
    dockerImageTag The docker image version of Eclipse Dirigible latest
    • Replace the subdomain with your subdomain, which you can find in the SAP Cloud Platform cockpit in your Cloud Foundry subaccount  overview page:
    • Replace the regionId with your specific region (e.g. eu10). You can find it in the API endpoint just before hana.ondemand.com. More details on the region specific URLs can be found here.
  • Replace the <applicationName> in xs-security.json, it should match the one that you’ve entered in the vars.yaml
  • Create an XSUAA service instance
    cf create-service xsuaa application <applicationName>-xsuaa -c xs-security.json​

Replace <applicationName> before executing the command, it should match the one that you’ve entered in the vars.yaml

  • Deploy Eclipse Dirigible
    cf push --vars-file vars.yaml
  • Assign the Developer and the Operator role to your user from the SAP Cloud Platform cockpit
    1. Navigate to your subaccount.
    2. You can skip the steps bellow (3-6) and go to step 7 using the default dirigible role collection
    3. Go to SecurityRole Collections.
    4. Create New Role Collection (e.g. dirigible):
    5. Select the newly created role collection (e.g. dirigible).
    6. Add the Developer and the Operator roles to the role collection:
    7. Go to Security → Trust Configuration and select your trust configuration (e.g. SAP ID Service):
    8. Enter your e-mail address and click the Show Assignments button.
    9. Click Assign Role Collection and assign your role collection (e.g. dirigible):
  • Access the Eclipse Dirigible instance at: https://<applicationName>-<subdomain>.cfapps.<regionId>.hana.ondemand.com
    1. Navigate to your space.
    2. Select the newly created application (e.g. dirigible).
    3. Access the Eclipse Dirigible instance by clicking the application route:
  • Once started, you can begin developing your next business application with Eclipse Dirigible

 

Notes


Next you can follow the Samples section to master some of the basic functionalities, explore the Enterprise JavaScript APIs, check out the YouTube channel for video content or simply visit the official site for news and updates.

5 Comments
You must be Logged on to comment or reply to a post.
  • No. Eclipse Dirigible is a community driven open source project under Eclipse Foundation, while SAP WebIDE and SAP Business Application Studio are SAP provided managed services on SAP Cloud Platform.

  • Hello,

    I’ve followed the configuration steps, but once I try to load the development IDE, it shows an empty screen. By checking the chrome debugger, I can see the followng errors. Can you please suggest what could be wrong?

    Error1Empty%20Screen

    Empty Screen

    Error1

  • Hi Arthur Chinelato,

     

    I’ve just tried out the exact same steps and I was able to deploy and access Eclipse Dirigible successfully.

     

    It could be the case, that at the time you’ve tried to deploy Dirigible, the dirigible-sap-cf:latest image was broken. You can change the image tag version from latest to some stable one (like 4.6.0), by updating the runtimeDockerImageTag property in the vars.yaml:

     

    Anyway, you can reach us out directly at dirigible-dev@eclipse.org, https://eclipse-dirigible.slack.com/ or on ours SAP mails,  so we can do the deployment together with you and help you in case of problems or questions.

     

    Regards,

    Yordan

    /
    • Hello Yordan,

       

      Thanks a lot for your response and guidance as well. I’ll try to proceed as suggested and in case I still have troubles, I will get in touch through the mentioned channels.

       

      Best Regards,

      Arthur