Skip to content

Commit

Permalink
revert me - changing the version to differentiate artifacts
Browse files Browse the repository at this point in the history
Signed-off-by: dseurotech <[email protected]>
  • Loading branch information
dseurotech committed Jan 17, 2025
1 parent 52a7160 commit 18153d2
Show file tree
Hide file tree
Showing 263 changed files with 619 additions and 467 deletions.
104 changes: 72 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@
![GitHub Actions CI](https://img.shields.io/github/actions/workflow/status/eclipse/kapua/kapua-ci.yaml) <br/>
![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https:%2F%2Fci.eclipse.org%2Fkapua%2Fjob%2Fdevelop-build&label=Jenkins%20Build&logo=jenkins) <br/>

[Eclipse Kapua&trade;](http://eclipse.org/kapua) is a modular platform providing the services required to manage IoT gateways and smart edge devices. Kapua provides a core integration framework and an
initial set of core IoT services including a device registry, device management services, messaging services, data management, and application enablement.
[Eclipse Kapua&trade;](http://eclipse.org/kapua) is a modular platform providing the
services required to manage IoT gateways and smart edge devices. Kapua provides a core
integration framework and an
initial set of core IoT services including a device registry, device management services,
messaging services, data management, and application enablement.

## Quick Start Guide

Expand All @@ -34,7 +37,8 @@ Two more backend services are required that implement the data tier:
* The SQL database
* The NoSQL datastore

Eclipse Kapua&trade; can be deployed in a variety of modes. A practical way for running a local demo is through Docker containers.
Eclipse Kapua&trade; can be deployed in a variety of modes. A practical way for running a
local demo is through Docker containers.

### Requirements

Expand All @@ -45,31 +49,43 @@ Before starting, check that your environment has the following prerequisites:
* Java VM Version 11
* Docker Version 1.2+
* Swagger CLI 4+ (Installed via NPM or separately)
* Node 16+
* Node 16+
* Internet Access (needed to download the artifacts)

### Demo Setup

The team maintains some docker images in a Docker Hub repository at [Kapua Repository](https://hub.docker.com/r/kapua/). Check the repo to view the list of available images, if you haven't found one
fitting your needs you may create your own. Please refer to the paragraph [More deployment info](#more-deployment-info) to find more about creating your own images and/or alternative demo deployment
The team maintains some docker images in a Docker Hub repository
at [Kapua Repository](https://hub.docker.com/r/kapua/). Check the repo to view the list of
available images, if you haven't found one
fitting your needs you may create your own. Please refer to the
paragraph [More deployment info](#more-deployment-info) to find more about creating your
own images and/or alternative demo deployment
scenarios.

***
**Note:** the Docker Hub repository mentioned above is not the official project repository from Eclipse Foundation.
**Note:** the Docker Hub repository mentioned above is not the official project repository
from Eclipse Foundation.
***

Suppose the target is the current snapshot 2.1.0-SNAPSHOT.
Suppose the target is the current snapshot 2.1.0-FALSE_EXTENSIONS-SNAPSHOT.

* Clone Eclipse Kapua&trade; into a local directory
* Open an OS shell and move to Kapua project root directory
* Start Docker runtime

The Kapua repository mentioned above hosts only images of released versions. It is possible to test different versions of Kapua doing a checkout into
the release branches (for example, "release-1.6.x") and to the tagged commits to select the specific version (for example, the commit tagged as "1.6.7"). Doing so, it is assured
that the following step will pull proper images from the Docker Hub. If, on the other hand, your target is a SNAPSHOT version (for example, the 2.1.0-SNAPSHOT), a local build is required
in order to create the docker images and proceed to the next step. Instructions for building can be found in the building.md file under the path docs/developer-guide.
Assuming that your interest is to deploy a release before 2.0.0 and that you want to pull images from the Docker Hub, it is important to set now the
`IMAGE_VERSION` environment variable with a value equal to the target version. For example, in the case of the 1.6.7
The Kapua repository mentioned above hosts only images of released versions. It is
possible to test different versions of Kapua doing a checkout into
the release branches (for example, "release-1.6.x") and to the tagged commits to select
the specific version (for example, the commit tagged as "1.6.7"). Doing so, it is assured
that the following step will pull proper images from the Docker Hub. If, on the other
hand, your target is a SNAPSHOT version (for example, the
2.1.0-FALSE_EXTENSIONS-SNAPSHOT), a local build is required
in order to create the docker images and proceed to the next step. Instructions for
building can be found in the building.md file under the path docs/developer-guide.
Assuming that your interest is to deploy a release before 2.0.0 and that you want to pull
images from the Docker Hub, it is important to set now the
`IMAGE_VERSION` environment variable with a value equal to the target version. For
example, in the case of the 1.6.7

export IMAGE_VERSION=1.6.7

Expand Down Expand Up @@ -113,31 +129,41 @@ On Windows (PowerShell):

### Access

Once the containers are running, the Kapua services can be accessed. Eclipse Kapua&trade; is a multi tenant
system. The demo installation comes with one default tenant, called _kapua-sys_, which is also the root tenant.
Once the containers are running, the Kapua services can be accessed. Eclipse Kapua&trade;
is a multi tenant
system. The demo installation comes with one default tenant, called _kapua-sys_, which is
also the root tenant.
In Eclipse Kapua&trade; a _tenant_ is commonly referred to as an _account_.

#### The console

The administration console is available at [http://localhost:8080/](http://localhost:8080/).
Copy paste the URL above to a Web browser, as the login screen appears, type the following credentials:
The administration console is available
at [http://localhost:8080/](http://localhost:8080/).
Copy paste the URL above to a Web browser, as the login screen appears, type the following
credentials:

* Username: `kapua-sys`
* Password: `kapua-password`

Press _Login_ button and start working with the console.

**Note**: If you are using Docker on Windows the hostname will most likely not be `localhost` but
**Note**: If you are using Docker on Windows the hostname will most likely not be
`localhost` but
the IP address of your docker instance.

#### RESTful APIs

The documentation of RESTful API is available at [http://localhost:8081/doc/](http://localhost:8081/doc/) while the mount points are available at [http://localhost:8081/v1/](http://localhost:8081/v1/)
The documentation of RESTful API is available
at [http://localhost:8081/doc/](http://localhost:8081/doc/) while the mount points are
available at [http://localhost:8081/v1/](http://localhost:8081/v1/)
.

The documentation is available through Swagger UI which greatly helps testing and exploring the exposed services.
The documentation is available through Swagger UI which greatly helps testing and
exploring the exposed services.

In order to get access a REST resource through an API, an authentication token is needed. Fortunately the token can be easily obtained by executing the authentication API. There are several ways to
In order to get access a REST resource through an API, an authentication token is needed.
Fortunately the token can be easily obtained by executing the authentication API. There
are several ways to
invoke the API, an easy one is by using the Swagger UI:

* Open the URL http://localhost:8081/doc/
Expand All @@ -154,7 +180,8 @@ invoke the API, an easy one is by using the Swagger UI:
}
```

**Note:** as an alternative to the previous, if curl is available on your machine, execute the following from the shell:
**Note:** as an alternative to the previous, if curl is available on your machine, execute
the following from the shell:

```bash
curl -X POST 'http://localhost:8081/v1/authentication/user' --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
Expand All @@ -170,17 +197,24 @@ The system will return a JSON object.
* Copy the value of the field _tokenId_
* Paste the value in the box labelled _api\_key_ at the top of the web page

Swagger will automatically add the authentication token to each subsequent request done using the Swagger UI. You're ready to try executing the documented APIs.
Swagger will automatically add the authentication token to each subsequent request done
using the Swagger UI. You're ready to try executing the documented APIs.

**Note**: If you are using Docker on Windows the hostname will most likely not be `localhost` but
**Note**: If you are using Docker on Windows the hostname will most likely not be
`localhost` but
the IP address of your docker instance.

#### The Broker

The broker container exposes an [Mqtt](http://mqtt.org/) end point at tcp://localhost:1883/.
The broker can be accessed through either [Eclipse Kura&trade;](http://www.eclipse.org/kura/) or a plain Mqtt client like, for example, [Eclipse Paho&trade;](http://www.eclipse.org/paho/).
The broker container exposes an [Mqtt](http://mqtt.org/) end point at tcp://localhost:
1883/.
The broker can be accessed through
either [Eclipse Kura&trade;](http://www.eclipse.org/kura/) or a plain Mqtt client like,
for example, [Eclipse Paho&trade;](http://www.eclipse.org/paho/).

In order for a client to establish a Mqtt connection with the broker, a client must provide a valid identity. The _kapua-sys_ account provides the user named _kapua-broker_ which has been pre-seeded
In order for a client to establish a Mqtt connection with the broker, a client must
provide a valid identity. The _kapua-sys_ account provides the user named _kapua-broker_
which has been pre-seeded
and profiled for the purpose.

The credentials for the user kapua-broker are the following:
Expand All @@ -190,17 +224,22 @@ The credentials for the user kapua-broker are the following:

**Note:** do not use the user `kapua-sys` to establish Mqtt connections.

**Note**: If you are using Docker on Windows the hostname will most likely not be `localhost` but
**Note**: If you are using Docker on Windows the hostname will most likely not be
`localhost` but
the IP address of your docker instance.

#### Simulation

Kapua comes with a framework that you can use to simulate Kura gateways. It can be used to test your Kapua deployments easily. See [Simulator documentation](docs/user-manual/en/simulator.md) for more
Kapua comes with a framework that you can use to simulate Kura gateways. It can be used to
test your Kapua deployments easily.
See [Simulator documentation](docs/user-manual/en/simulator.md) for more
info.

#### More deployment info

Installing and running a demo using Docker is easy, but it's not the only way. There are other scenarios that the users may be interested in. We provide advanced setup scenarios in the following
Installing and running a demo using Docker is easy, but it's not the only way. There are
other scenarios that the users may be interested in. We provide advanced setup scenarios
in the following
guides:

* [Running with Docker](deployment/docker/README.md)
Expand All @@ -216,7 +255,8 @@ They will provide more advanced deployment scenarios.

### Contributing

If you're interested to get involved in IoT and Eclipse Kapua&trade; project, join the community and give your contribution to the project, please
If you're interested to get involved in IoT and Eclipse Kapua&trade; project, join the
community and give your contribution to the project, please
read [how to contribute to Eclipse Kapua&trade;](https://github.com/eclipse/kapua/blob/develop/CONTRIBUTING.md).

### Community
Expand Down
24 changes: 17 additions & 7 deletions UPGRADE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,32 @@
# Upgrade Notes v 2.1.0-SNAPSHOT
# Upgrade Notes v 2.1.0-FALSE_EXTENSIONS-SNAPSHOT

Below are described most important changes, features, additions and bugfixes that needs attention while performing the upgrade from the previous version.
Below are described most important changes, features, additions and bugfixes that needs
attention while performing the upgrade from the previous version.

This report is only partial for Eclipse Kapua release 2.1.0-SNAPSHOT, since we started to maintain it mid-release development.
This report is only partial for Eclipse Kapua release 2.1.0-FALSE_EXTENSIONS-SNAPSHOT,
since we started to maintain it mid-release development.

## Changes

#### Deprecation of `db.pool.size.min` and `db.pool.size.max` sizing options

With [#4112](https://github.com/eclipse/kapua/pull/4112) we deprecated `commons.db.pool.size.min` and `commons.db.pool.size.max` settings, switching to a new `commons.db.pool.size.fixed` setting which will configure the database connection pool to a fixed size with a default value of `5`.
With [#4112](https://github.com/eclipse/kapua/pull/4112) we deprecated
`commons.db.pool.size.min` and `commons.db.pool.size.max` settings, switching to a new
`commons.db.pool.size.fixed` setting which will configure the database connection pool to
a fixed size with a default value of `5`.

Backward compatibility is granted by `db.pool.size.strategy`. Default value is `fixed`, but it can be changed to `range` to continue use of a variable database connection pool. Be aware that at some point `range` strategy will be removed and only fixed size will be available.
Backward compatibility is granted by `db.pool.size.strategy`. Default value is `fixed`,
but it can be changed to `range` to continue use of a variable database connection pool.
Be aware that at some point `range` strategy will be removed and only fixed size will be
available.

## DB Changes

#### New column in MFA Option table

In PR [#4115](https://github.com/eclipse/kapua/pull/4115) a new `has_trust_me` column has been added to the `atht_mfa_option`.
In PR [#4115](https://github.com/eclipse/kapua/pull/4115) a new `has_trust_me` column has
been added to the `atht_mfa_option`.

New column defaults to `null` and doesn't need any migration. The code itself will populate the column accordingly on first update.
New column defaults to `null` and doesn't need any migration. The code itself will
populate the column accordingly on first update.
For large `atht_mfa_option` tables it might take sometime to be added.
2 changes: 1 addition & 1 deletion assembly/api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<artifactId>kapua-assembly</artifactId>
<groupId>org.eclipse.kapua</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/broker-artemis/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/console/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

JAVA_OPTS="${JAVA_OPTS} --add-opens java.base/java.lang=ALL-UNNAMED"

java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-consumer-lifecycle-2.1.0-SNAPSHOT-app.jar
java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-consumer-lifecycle-2.1.0-FALSE_EXTENSIONS-SNAPSHOT-app.jar
2 changes: 1 addition & 1 deletion assembly/consumer/lifecycle/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<artifactId>kapua-assembly-consumer</artifactId>
<groupId>org.eclipse.kapua</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion assembly/consumer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@

JAVA_OPTS="${JAVA_OPTS} --add-opens java.base/java.lang=ALL-UNNAMED"

java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-consumer-telemetry-2.1.0-SNAPSHOT-app.jar
java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-consumer-telemetry-2.1.0-FALSE_EXTENSIONS-SNAPSHOT-app.jar
2 changes: 1 addition & 1 deletion assembly/consumer/telemetry/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>kapua-assembly-consumer</artifactId>
<groupId>org.eclipse.kapua</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion assembly/events-broker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/java-base/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/jetty-base/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/job-engine/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<artifactId>kapua-assembly</artifactId>
<groupId>org.eclipse.kapua</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<artifactId>kapua-assembly-job-engine</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion assembly/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<artifactId>kapua-assembly</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
# Eurotech
################################################################################

java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-service-authentication-2.1.0-SNAPSHOT-app.jar
java ${JAVA_OPTS} ${DEBUG_OPTS} ${JMX_OPTS} -jar kapua-service-authentication-2.1.0-FALSE_EXTENSIONS-SNAPSHOT-app.jar
2 changes: 1 addition & 1 deletion assembly/service/authentication/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<artifactId>kapua-assembly-service</artifactId>
<groupId>org.eclipse.kapua</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion assembly/service/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion assembly/sql/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-assembly</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion broker/artemis/plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<groupId>org.eclipse.kapua</groupId>
<artifactId>kapua-broker-artemis</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0-FALSE_EXTENSIONS-SNAPSHOT</version>
</parent>

<artifactId>kapua-broker-artemis-plugin</artifactId>
Expand Down
Loading

0 comments on commit 18153d2

Please sign in to comment.