Edcom

Edcom - Edge Computing

Edcom is a powerful framework for implementing edge computing architectures using microservices. With the rapid growth of Internet of Things (IoT) devices and the demand for real-time processing and low latency, Edcom provides a solution for deploying services closer to the edge devices, enabling efficient data processing and improving responsiveness.

Introduction
Features
Getting Started
- Installation
- Usage
Architecture
Contributing
License

Introduction

Edcom is designed to facilitate edge computing by leveraging microservices. It allows developers to deploy services closer to the edge devices, enabling local data processing and reducing network bandwidth requirements. By processing data at the edge, Edcom improves responsiveness and lowers latency, making it an ideal solution for applications that require real-time processing.

Features

Microservice-based: Edcom utilizes microservices to enable edge computing architectures, making it flexible and scalable.
Edge Device Deployment: Services can be deployed directly on edge devices, allowing for efficient local data processing.
Improved Responsiveness: By processing data at the edge, Edcom significantly reduces latency, leading to improved application responsiveness.
Reduced Bandwidth Requirements: Processing data locally at the edge devices reduces the need for transmitting large amounts of data over the network.
Flexible Integration: Edcom can be integrated with various IoT platforms and existing microservice ecosystems.
Fault Tolerance: Edcom provides fault tolerance mechanisms to ensure the stability and reliability of the edge computing environment.
Monitoring and Management: Edcom offers monitoring and management tools to facilitate edge computing deployment and maintenance.

Getting Started

Installation

To install Edcom, follow these steps:

Clone the Edcom repository from GitHub:

git clone https://github.com/edcom/edcom.git

Change into the Edcom directory:
```
cd edcom
```
Install the required dependencies:
```
npm install
```

Usage

To start using Edcom, you need to perform the following steps:

Define your microservices: Create the necessary microservices that you want to deploy at the edge. These services should be designed to handle local data processing efficiently.
Configure Edcom: Set up the Edcom configuration file to specify the edge devices where the services will be deployed and other relevant parameters.
Deploy microservices: Use the Edcom deployment tool to deploy the microservices to the specified edge devices. Edcom will handle the distribution and management of services across the edge computing network.
Monitor and manage: Utilize the Edcom monitoring and management tools to monitor the deployed services, collect performance metrics, and ensure the overall health of the edge computing environment.

For detailed instructions on using Edcom, refer to the documentation.

Architecture

Edcom follows a distributed architecture that incorporates microservices and edge devices. The architecture consists of the following components:

Edge Devices: These are the IoT devices located at the edge of the network, such as sensors, gateways, or edge servers. Edcom deploys microservices on these devices for local data processing.
Microservices: These are the individual components of an application that perform specific tasks. Edcom utilizes microservices to enable edge computing and deploys them on the edge devices.
Edcom Core: The core of Edcom manages the deployment, scaling, and monitoring of microservices across the edge devices. It handles the distribution of services, load balancing, fault tolerance, and communication between microservices.
Monitoring and Management Tools: Edcom provides tools for monitoring and managing the deployed microservices. These tools collect performance metrics, enable troubleshooting, and ensure the overall health of the edge computing environment.

For a more detailed explanation of the architecture and its components, refer to the Edcom Architecture Guide.

Contributing

We welcome contributions to Edcom! If you want to contribute to the project, please follow the guidelines outlined in the Contribution Guide. By participating in the Edcom community, you can help improve the framework and make edge computing more accessible and efficient.

License

Edcom is licensed under the MIT License. You are free to use, modify, and distribute Edcom in accordance with the terms of the license. Please refer to the LICENSE file for more information.

Requirements

Outline the minimum system requirements and dependencies needed to run Edcom. This section should include information about supported operating systems, programming languages, frameworks, and any other prerequisites.

Documentation

Provide a link to the comprehensive documentation for Edcom. This documentation should include detailed instructions on installation, configuration, usage, and troubleshooting. It’s essential to have clear and up-to-date documentation to help users understand and effectively use Edcom.

Examples

Include a section showcasing example use cases or sample code snippets that demonstrate how to use Edcom in various scenarios. This can help users understand the practical application of the framework and provide them with a starting point for their own projects.

Support

List the available support channels for Edcom. This can include links to community forums, chat groups, or a dedicated support email address. Encourage users to reach out with questions, bug reports, or feature requests and provide guidelines for submitting issues or contributing to the project.

Roadmap

Outline the future development plans for Edcom. This can include upcoming features, enhancements, or bug fixes that are planned for future releases. Sharing the roadmap helps users understand the direction of the project and encourages engagement from the community.

Frequently Asked Questions (FAQ)

Compile a list of frequently asked questions related to Edcom. Include answers to common queries and known issues. This section can save users time by addressing their concerns upfront and providing solutions to common problems.

Change Log

Maintain a detailed change log that highlights the version history of Edcom. This log should include release dates, a summary of changes, and links to relevant documentation or pull requests. It helps users stay informed about new features, bug fixes, and improvements introduced in each release.

Acknowledgments

Acknowledge individuals or organizations that have contributed significantly to the development of Edcom. This section expresses gratitude to those who have provided support, feedback, or contributed code to the project.

Including these sections in your README will provide comprehensive information about Edcom, making it easier for users to understand, install, and use the framework effectively.

Project Structure

Node is required for generation and recommended for development. package.json is always generated for a better development experience with prettier, commit hooks, scripts and so on.

In the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.

/src/* structure follows default Java structure.

.yo-rc.json - Yeoman configuration file JHipster configuration is stored in this file at generator-jhipster key. You may find generator-jhipster-* for specific blueprints configuration.
.yo-resolve (optional) - Yeoman conflict resolver Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match [pattern] [action] with pattern been a Minimatch pattern and action been one of skip (default if ommited) or force. Lines starting with # are considered comments and are ignored.
.jhipster/*.json - JHipster entity configuration files
npmw - wrapper to use locally installed npm. JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using ./npmw instead of the traditional npm you can configure a Node-less environment to develop or test your application.
/src/main/docker - Docker configurations for the application and services that the application depends on

Development

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

We use npm scripts and Angular CLI with Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./mvnw
npm start

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

PWA Support

JHipster ships with PWA (Progressive Web App) support, and it’s turned off by default. One of the main components of a PWA is a service worker.

The service worker initialization code is disabled by default. To enable it, uncomment the following code in src/main/webapp/app/app.module.ts:

ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

npm install --save --save-exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

npm install --save-dev --save-exact @types/leaflet

Then you would import the JS and CSS files specified in library’s installation instructions so that Webpack knows about them: Edit src/main/webapp/app/app.module.ts file:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/scss/vendor.scss file:

@import 'leaflet/dist/leaflet.css';

Note: There are still a few other things remaining to do for Leaflet that we won’t detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Developing Microfrontend

Microservices doesn’t contain every required backend feature to allow microfrontends to run alone. You must start a pre-built gateway version or from source.

Start gateway from source:

cd gateway
npm run docker:db:up # start database if necessary
npm run docker:others:up # start service discovery and authentication service if necessary
npm run app:start # alias for ./(mvnw|gradlew)

Microfrontend’s build-watch script is configured to watch and compile microfrontend’s sources and synchronizes with gateway’s frontend. Start it using:

cd microfrontend
npm run docker:db:up # start database if necessary
npm run build-watch

It’s possible to run microfrontend’s frontend standalone using:

cd microfrontend
npm run docker:db:up # start database if necessary
npm watch # alias for `npm start` and `npm run backend:start` in parallel

Using Angular CLI

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate few files:

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

JHipster Control Center

JHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:

docker compose -f src/main/docker/jhipster-control-center.yml up

OAuth 2.0 / OpenID Connect

Congratulations! You’ve selected an excellent way to secure your JHipster application. If you’re not sure what OAuth and OpenID Connect (OIDC) are, please see What the Heck is OAuth?

To log in to your app, you’ll need to have Keycloak up and running. The JHipster Team has created a Docker container for you that has the default users and roles. Start Keycloak using the following command.

docker compose -f src/main/docker/keycloak.yml up

The security settings in src/main/resources/config/application.yml are configured for this image.

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            issuer-uri: http://localhost:9080/realms/jhipster
        registration:
          oidc:
            client-id: web_app
            client-secret: web_app
            scope: openid,profile,email

Some of Keycloak configuration is now done in build time and the other part before running the app, here is the list of all build and configuration options.

Before moving to production, please make sure to follow this guide for better security and performance.

Also, you should never use start-dev nor KC_DB=dev-file in production.

When using Kubernetes, importing should be done using init-containers (with a volume when using db=dev-file).

Okta

If you’d like to use Okta instead of Keycloak, it’s pretty quick using the Okta CLI. After you’ve installed it, run:

okta register

Then, in your JHipster app’s directory, run okta apps create and select JHipster. This will set up an Okta app for you, create ROLE_ADMIN and ROLE_USER groups, create a .okta.env file with your Okta settings, and configure a groups claim in your ID token.

Run source .okta.env and start your app with Maven or Gradle. You should be able to sign in with the credentials you registered with.

If you’re on Windows, you should install WSL so the source command will work.

If you’d like to configure things manually through the Okta developer console, see the instructions below.

First, you’ll need to create a free developer account at https://developer.okta.com/signup/. After doing so, you’ll get your own Okta domain, that has a name like https://dev-123456.okta.com.

Modify src/main/resources/config/application.yml to use your Okta settings.

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            issuer-uri: https://{yourOktaDomain}/oauth2/default
        registration:
          oidc:
            client-id: {clientId}
            client-secret: {clientSecret}
security:

Create an OIDC App in Okta to get a {clientId} and {clientSecret}. To do this, log in to your Okta Developer account and navigate to Applications > Add Application. Click Web and click the Next button. Give the app a name you’ll remember, specify http://localhost:8080 as a Base URI, and http://localhost:8080/login/oauth2/code/oidc as a Login Redirect URI. Click Done, then Edit and add http://localhost:8080 as a Logout redirect URI. Copy and paste the client ID and secret into your application.yml file.

Create a ROLE_ADMIN and ROLE_USER group and add users into them. Modify e2e tests to use this account when running integration tests. You’ll need to change credentials in src/test/javascript/e2e/account/account.spec.ts and src/test/javascript/e2e/admin/administration.spec.ts.

Navigate to API > Authorization Servers, click the Authorization Servers tab and edit the default one. Click the Claims tab and Add Claim. Name it “groups”, and include it in the ID Token. Set the value type to “Groups” and set the filter to be a Regex of .*.

After making these changes, you should be good to go! If you have any issues, please post them to Stack Overflow. Make sure to tag your question with “jhipster” and “okta”.

Auth0

If you’d like to use Auth0 instead of Keycloak, follow the configuration steps below:

Create a free developer account at https://auth0.com/signup. After successful sign-up, your account will be associated with a unique domain like dev-xxx.us.auth0.com
Create a new application of type Regular Web Applications. Switch to the Settings tab, and configure your application settings like:
- Allowed Callback URLs: http://localhost:8080/login/oauth2/code/oidc
- Allowed Logout URLs: http://localhost:8080/
Navigate to User Management > Roles and create new roles named ROLE_ADMIN, and ROLE_USER.
Navigate to User Management > Users and create a new user account. Click on the Role tab to assign roles to the newly created user account.
Navigate to Auth Pipeline > Rules and create a new Rule. Choose Empty rule template. Provide a meaningful name like JHipster claims and replace Script content with the following and Save.

function (user, context, callback) {
  user.preferred_username = user.email;
  const roles = (context.authorization || {}).roles;

  function prepareCustomClaimKey(claim) {
    return `https://www.jhipster.tech/${claim}`;
  }

  const rolesClaim = prepareCustomClaimKey('roles');

  if (context.idToken) {
    context.idToken[rolesClaim] = roles;
  }

  if (context.accessToken) {
    context.accessToken[rolesClaim] = roles;
  }

  callback(null, user, context);
}

In your JHipster application, modify src/main/resources/config/application.yml to use your Auth0 application settings:

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            # make sure to include the ending slash!
            issuer-uri: https://{your-auth0-domain}/
        registration:
          oidc:
            client-id: {clientId}
            client-secret: {clientSecret}
            scope: openid,profile,email
jhipster:
  ...
  security:
    oauth2:
      audience:
        - https://{your-auth0-domain}/api/v2/

Doing API-First development using openapi-generator-cli

OpenAPI-Generator is configured for this application. You can generate API code from the src/main/resources/swagger/api.yml definition file by running:

./mvnw generate-sources

Then implements the generated delegate classes with @Service classes.

To edit the api.yml definition file, you can use a tool such as Swagger-Editor. Start a local instance of the swagger-editor using docker by running: docker compose -f src/main/docker/swagger-editor.yml up -d. The editor will then be reachable at http://localhost:7742.

Refer to Doing API-First development for more details.

Building for production

Packaging as jar

To build the final jar and optimize the Edcom application for production, run:

./mvnw -Pprod clean verify

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar target/*.jar

Then navigate to http://localhost:8081 in your browser.

Refer to Using JHipster in production for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:

./mvnw -Pprod,war clean verify

Testing

To launch your application’s tests, run:

./mvnw verify

Client tests

Unit tests are run by Jest. They’re located in src/test/javascript/ and can be run with:

npm test

Other tests

Performance tests are run by Gatling and written in Scala. They’re located in src/test/java/gatling/simulations.

You can execute all Gatling tests with

./mvnw gatling:test

For more information, refer to the Running tests page.

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker compose -f src/main/docker/sonar.yml up -d

Note: we have turned off forced authentication redirect for UI in src/main/docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.

You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.

Then, run a Sonar analysis:

./mvnw -Pprod clean verify sonar:sonar -Dsonar.login=admin -Dsonar.password=admin

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvnw initialize sonar:sonar -Dsonar.login=admin -Dsonar.password=admin

Additionally, Instead of passing sonar.password and sonar.login as CLI arguments, these parameters can be configured from sonar-project.properties as shown below:

sonar.login=admin
sonar.password=admin

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a oracle database in a docker container, run:

docker compose -f src/main/docker/oracle.yml up -d

To stop it and remove the container, run:

docker compose -f src/main/docker/oracle.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

npm run java:docker

Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:

npm run java:docker:arm64

Then run:

docker compose -f src/main/docker/app.yml up -d

When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental Use the new Virtualization framework for better processing performance (disk access performance is worse).

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

Edcom by KOSASIH is licensed under Attribution 4.0 International

This site is open source. Improve this page.