ID | IEP-93 |
Author | Mikhail Pochatkin |
Sponsor | Petr Ivanov |
Created |
|
Status | DRAFT |
Currently, Ignite 3 does not have a ready-made mechanism for delivering the required components to the user. The purpose of this IEP is to work out and create all kinds of options for packaging and distributing the required components of Ignite 3 to the user, taking into account the UX of various user platforms and OS.
As ready-made resulting packages, it is planned to make only completely independent parts of Apache Ignite. At the moment only Ignite core part and Ignite CLI can work as standalone applications and these applications should be distributed as OS specific packages for all supported platforms. (Linux, Windows, MacOs). However, we will publish not only compiled packages, there is a need to publish individual parts of Apache Ignite that are not standalone applications, and we need to provide the user with the access to these parts. The prime candidate for this is the ignite-client with all its subparts (JDBC, SQL Api, etc Api). More about this will be described in paragraph Publishing.
Three packages will be provided:
ignite3-cli
— Ignite 3 CLI tool. Used if one wants to manage a remote cluster.ignite3-db
— Ignite 3 core artifacts. Used if one wants to start nodes locally.ignite3
— meta package that includes both ignite3-cli and ignite3-db.Every package will be available as a downloadable ZIP file, and as OS-specific packages (RPM, DEB, Brew …).
This package can only be used to connect to a remote (or local) cluster. Once the package is installed, the user gets access to the Ignite CLI tool via the ignite command.
The package includes:
NOTE: It is possible to build an ignite3-cli executable with GraalVM native-image technology. This approach can provide a significant performance boost during CLI startup. This performance increase can be tested and presented to the community as part of this work.
This package provides an ability to run nodes on the local server. It includes:
Scripts can be used by a user directly, or by OS-level services. Mix-and-match of these two approaches should be disallowed.
This is a meta package that includes everything listed for the other two packages.
The issue of publishing assembled packages should be highlighted in a separate paragraph.
Each package should be published and available to install for all supported platforms by native OS way. It means that the installation process should respect all UX of each OS :
It is also necessary to support the publication of compiled images as zip files for the possibility of installation on those platforms where there are no package managers. For each supported architecture, it is necessary to build and publish a zip file with everything necessary for the application to fully work (except for the third party dependencies, which should be installed as additional packages, but this list should be attached to the REQUIRED.txt file).
Code examples should be moved to a separate Git repository and also provided as a separate ZIP download for every release.
Examples are NOT included in any of the packages described above.
TDB
In the context of packaging work it would be useful to rewrite Apache Ignite to a Gradle build system. This work should be done before all packaging staff, we also need to verify that the build process is correctly working as previously. Also need to adapt all CI scripts for the new build system and scripts.
These several point about what can be improved by Gradle using:
Each installation method will be described here. As described above, each method must fully respect all the features of the user experience of the platform. Because of this, care should be taken in attempting to unify user scripts between different installation methods.
NOTE: All formats and running options MUST provide possibility to run multiple instances of ignite3-db module.
The file includes:
Installation:
Uninstallation v1:
Uninstallation v2:
Upgrade v1:
Upgrade v2:
Also standard approach where we have /opt/ignite folder with ignite versions and /opt/ignite/latest as symlink to current used versions. Upgrading will require downloading archive, unzipping it to /opt/ignite/<version>, making new symlink to /opt/ignite/latest
Upgrade process should not remove data files.
Zip archive can be built with a gradle plugin.
The package includes:
Installation:
rpm -i <package> / apt install <path-to-deb> / dpkg -i <package>
Uninstallation:
rpm -e <package> / dpkg --r <package>
Upgrade:
rpm -U <package> / dpkg -i <package>
NOTE: upgrade process should not remove data files.
RPM/DEB archive can be built by plugin or https://github.com/jreleaser/jreleaser
Apache Ignite should have a RPM/Deb repository with all builded packages.
This is a common approach in the Linux community and is the standard way to install an application on a system.
yum install https://yum-rep-address/repo-info.rpm
add-apt-repository http://repo-address
yum install ignite3
apt install ignite3
NOTE: Also in the future it is necessary to consider the possibility of adding our packages to the standard repositories of common distributions.
Homebrew uses Formula to install the software. Formula is a Ruby class that describes the installation process. Formula should be placed in GitHub and have a link to the zip archive.
There is also a way to create Formula via a gradle plugin https://github.com/jreleaser/jreleaser
Installation:
brew tap apache/ignite-3
brew install <package>
Uninstallation:
brew uninstall ignite3
Upgrade:
brew upgrade ignite3
SDKman is a multiplatform package manager with supported platforms:
A lot of product publishing in SDKMan java, kotlin, scala, maven, gradle, sbt, Scala CLI, Quarkus CLI, Apache ActiveMQ, Flink, Spark, etc.
Installation:
sdk install ignite3 ${version}
Uninstallation:
sdk uninstall ignite3 ${version}
Upgrade:
sdk upgrade ignite3
List:
sdk list ignite3
Publishing process is described here and it's not much different from other package managers.
Also publishing process can be simplified by using https://github.com/jreleaser/jreleaser or https://github.com/sdkman/sdkman-vendor-gradle-plugin
For the ignite3-db module we also should build a Docker image which can be used for easy Apache Ignite startup.
This image should contain ready for use Apache Ignite with all required dependencies. After the image is created Apache Ignite should be started and ready for use. By default all ports of Ignite server should be forwarded as is and no additional changes required.
Also https://jreleaser.org/guide/latest/configuration/packagers/docker.html can simplify the process of docker image building.
As you can see https://github.com/jreleaser/jreleaser can help us with publishing setup infrastructure and cover all cases. This is a good reason to try to use it as the only required dependency to unify how different packages are built.
Also https://jreleaser.org/guide/latest/examples/micronaut-cli-app.html provides native support of Micronaut CLI project which is Apache Ignite CLI.
TDB
// Describe project risks, such as API or binary compatibility issues, major protocol changes, etc.
TDB
// Links or report with relevant JIRA tickets.