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:
- In-System development
- Low-Code/No-Code development
- Modeling and Generation from templates
- In-App extensibility
- Enterprise JavaScript APIs
- Web IDE
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 Eclipse Dirigible 5.0, there are built-in integrations with the SAP Cloud Platform Cloud Foundry and Kyma environments. To deploy Eclipse Dirigible on either one of these environments, you need to use a Docker image. While deploying the publicly available Dirigible Docker images is quite straightforward, there could be some cases where you might need to deploy a Docker image form a private Docker repository instead. Here are some of the cases:
- Creating a proprietary extension to the Dirigible Web IDE
- Using a new engine that supports custom Dirigible Runtime artifacts
- Deploying an application developed with Dirigible on production
In any of these cases, building a Docker image and pushing it to a private Docker repository, seems reasonable.
In this tutorial, I'm going to show you how to deploy an Eclipse Dirigible based Docker image from a private Docker repository. During the tutorial I'm going to use the Docker Hub "one private" repository policy from the "Free for Individuals" plan.
As a prerequisite, you need a Docker Hub registration. If you already have a Docker Hub registration, or you are going to use another private Docker repository, then skip this section.
- Go to https://hub.docker.com
- Create a new registration.
- Log on to your account.
(Docker Hub)
Next, we are going to create a new Private repository:
- Go to the Repositories tab.
- Click the Create Repository button.
- Name the repository (e.g. my-repository).
- Add a repository description (this is optional).
- Switch the visibility from Public to Private.
- Create the repository.
(Creating a new Docker Hub repository)
Once the private Docker repository is created, then it's time to push the Docker image to it:
- Build your Docker image:
docker build -t my-repository .
- Tag the Docker image:
docker tag my-repository <your-docker-hub-user>/my-repository
- Push the image to the private Docker repository:
docker push <your-docker-hub-user>/my-repository
- Check if the Docker image was successfully pushed:
(Docker Image Tags)
Now it's time to log on to the SAP Cloud Platform Cloud Foundry environment subaccount from the Cloud Foundry CLI:
- Install the Cloud Foundry CLI. You can either get the latest release from the official release page or use your package manager.
- Log on to the SAP Cloud Platform Cockpit and copy the Org Name and the API Endpoint:
- Set the Cloud Foundry CLI API endpoint:
cf api https://api.cf.eu10.hana.ondemand.com
- Log on to your subaccount:
cf login
The next step is to deploy the Docker image in the SAP Cloud Platform Cloud Foundry environment via the Cloud Foundry CLI:
- Execute the cf push command to create a new application:
CF_DOCKER_PASSWORD=<docker-hub-password> \
cf push <application-name> \
--docker-image=<docker-hub-username>/my-repository \
--docker-username=<docker-hub-username> \
--hostname <application-name>-<org-name> \
-m 2G -k 2G
- <docker-hub-password> - your Docker Hub password
- <application-name> - the application name
- <docker-hub-username> - your Docker Hub username
- <org-name> - the Org Name from the SAP Cloud Platform Cockpit
- Bind an Authorization & Trust Management (XSUAA) service instance to the application:
- Navigate to your subaccount from the SAP Cloud Platform Cockpit.
- Create a new service instance (if you already have one, skip this step):
- Go to Services -> Service Marketplace.
- Search for the Authorization & Trust Management service.
- Click the Create Instance button.
- Set the Service Plan to application.
- Name the service instance (e.g. my-xsuaa).
- Go to the Next page.
- Provide a JSON configuration for the service instance like this one:
{
"xsappname": "my-xsuaa",
"tenant-mode": "shared",
"scopes": [
{
"name": "$XSAPPNAME.Developer",
"description": "Developer scope"
},
{
"name": "$XSAPPNAME.Operator",
"description": "Operator scope"
}
],
"role-templates": [
{
"name": "Developer",
"description": "Developer related roles",
"scope-references": [
"$XSAPPNAME.Developer"
]
},
{
"name": "Operator",
"description": "Operator related roles",
"scope-references": [
"$XSAPPNAME.Operator"
]
}
],
"role-collections": [
{
"name": "dirigible",
"description": "Dirigible Developer",
"role-template-references": [
"$XSAPPNAME.Developer",
"$XSAPPNAME.Operator"
]
}
]
}
- Click the Create Instance button.
- Bind the XSUAA service instance to your application:
- Go to the Services -> Service Instances tab.
- Select your XSUAA service instance (e.g. my-xsuaa).
- From the "More" option, select Bind Application.
- Find your application and click the Create button.
- Assign the required roles:
- Go to Security -> Trust Configuration.
- Open the trust configuration (e.g. sap.default).
- Find for your user ID and assign the required roles.
- For more detailed explanation of the service binding process and the trust configuration steps, visit this blog post.
- Bind any additional services, if needed.
- You can refer to the following blog post on binding the PostgreSQL service.
- Restart the application.
- Access the application:
Related Resources
- How to deploy Eclipse Dirigible in the SAP Cloud Platform Cloud Foundry environment
- Eclipse Dirigible – Building a Docker Image for Your Application
- How to deploy Eclipse Dirigible private Docker image in the SAP Cloud Platform Cloud Foundry environ...
- How to deploy Eclipse Dirigible in the SAP Cloud Platform Kyma environment
Notes
Next, you can visit the Samples section to master some of the basic Eclipse Dirigible functionalities, explore the Enterprise JavaScript APIs, check out the YouTube channel for video content, or simply visit the official site for news and updates.
- SAP Managed Tags:
