Getting Up and Running
As we worked to establish iDaaS we wanted to ensure that we could enable complex platforms and systems to
be extended, developed and delivered. It is very important to keep the end user development
experience as simple as possible, our focus is to enable developers to be running in minutes. We have had
developers leverage Macs, Windows (Server and Desktop) OS, Red Hat Enterprise Linux and Ubuntu for development
platforms. We work to support all these technologies and deliver needed scripts (where possible) to try and assist.
Pre-Requisites
These Pre-Requsites are intended to provide the core details of what is needed on any development machine
irrespective of OS. As you read these they are the tooling we have gone with due to several reasons, if you wish to use
different technologies feel free to add those capabilities in, thats's the power of Open Source, we also anticipate adding more
technologies as we continue to progress.
Technology | Purpose and Details |
---|---|
Maven 3.6.x |
Maven is a repository framework where vendors can place their libraries in a public site. iDaaS leverages this to
pull needed upstream files and even has some of their open-iDaaS already in the Maven repository ecosystem.
Maven Site and Installation Link |
MySQL 8 - Optional |
While we list this in required we have also put in the word optional. If you want to persist data from the auditing
components we have developed than we have focused on implementing it with lon standing open source RDBMs technology.
However, if you dont want to output the auditing data to an RDBMS then this is not needed (thus the optionality).
Furthermore, you could implement another RDBMS like Postgres, SQL Server, etc. MySQL Community Site |
Kafka/AMQ-Streams |
The platform is a series of decoupled components and leverages Kafka capabilities to help it move and distribute data.
We have tested it extensively with any version beyond Kafka 2.5 for some of the key features and enhancements they have
implemented upstream.
For ease of usage you can also get the latest Kafka release within the code repository, the
zip file is within the platform-addons directory.
Apache Kafka Download Site Red Hat AM-Q Site and Download |
Java 8 SDK |
Java is what everything is developed in. While we list JDK 8 SDK you can run a Java SDKs from
version 8, 11, 13,14 and 15. We have leveraged all these JDKs and been able to build, compile and run the
code within the community leveraging iDaaS.
We always recommend to consult upstream technologies to ensure these products are certified and will run beyond a developer machine. We have also seen some tweaks needed in POM files for specific Java versions. OpenJDK Download Site |
Java IDE or Editor to Compile and Build |
We always want to recommend that resources pick a code editor or IDE they are comfortable with. While this
is a personal decision we wanted to provide a few common ones numerous resources have used when building, implementing,
contributing to iDaaS. IntelliJ IDEA Site Visual Studio Code Site Eclipse Site Red Hat Developer studio Site |
Containers |
In order to showcase the containers aspect of our capabilities, and since this is running on a developer desktop we
want to ensure we provide some recommendations in line with what other contriubutors and developers use. Docker Desktop Site Code Ready Container Site |
Running iDaaS Code
After meeting all the pre-requisites and ensuring that each product works independently it is now time to put them all together
and clone the code you would like, then build it and then run it.
Happy using and coding!!!!
- Make sure pre-requisites are met
- Pull in the needed repositories or the latest compiled jars from the specific Git Hub site. You can find the latest repositories. It is importsnt to know that ANY code repository you clone and work with could take some time as the required supporting software will be downloaded from Maven repositories.
- Start AMQ-Streams, there are scripts setup in the scripts directory named start-kafka.sh. The script should need some enhancements based on directory where the technology was unzipped to.
- Build the software, the scripts to build are contained within the platform-scripts directory. The script is named build-solution.sh
- Run the built code by using the java command line java -jar jarfilename.jar
Happy using and coding!!!!