Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: installers renaming changes #5613

Merged
merged 7 commits into from
Dec 10, 2024
18 changes: 10 additions & 8 deletions docs/getting-started/install-kura.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Eclipse Kura™ is provided using a Debian Linux package. Visit the [Kura do

Several installers can be found on such page, and they fall into one of the following categories:

1. standard installers, like `kura-6.0.0_armhf_installer.deb`; and
2. installers with suffix **nn**, like `kura-6.0.0_armhf-nn_installer.deb`
1. standard **kura** installers, like `kura_6.0.0_arm64.deb`; and
marcellorinaldo marked this conversation as resolved.
Show resolved Hide resolved
2. installers named **kura-nn**, like `kura-nn_6.0.0_arm64.deb`

Profiles of types (1) ship a Kura version with networking functionalities. In particular, they can be installed on targets with [NetworkManager](https://networkmanager.dev), a commonly available tool for managing Linux networking. Kura leverages this tool for networking functionalities. Refer to the [Kura installers](#kura-installers) section for further information.

Expand All @@ -26,10 +26,12 @@ Installers of type (2) with the suffix `nn` are **No Networking** profiles that
A user can deploy Kura on a target system using the installer tailored for the device architecture. The installer file looks like:

```
kura-<kura-version>_<arch>_installer.deb/rpm
kura_<kura-version>_<arch>.deb/rpm
marcellorinaldo marked this conversation as resolved.
Show resolved Hide resolved
```

where `<arch>` is one of the **supported architectures**: *x86_64*, *armhf*, and *aarch64*. Kura can work on systems that have available the dependencies listed in the [Kura dependencies](#kura-dependencies) section, and that have **at least one** physical ethernet interface. Java 17 is required.
where `<arch>` is one of the **supported architectures**: *amd64*, *arm64*, and *armhf*. Kura can work on systems that have available the dependencies listed in the [Kura dependencies](#kura-dependencies) section, and that have **at least one** physical ethernet interface.

From Kura version 6.0.0 the Java 17 runtime is **required** to run the framework correctly.

### Java Heap Memory Assignment

Expand Down Expand Up @@ -108,10 +110,10 @@ Eclipse Kura&trade; has been tested on the following devices and provides full c
| Device | Architecture | OS |
| - | - | - |
| **Raspberry Pi 3/4** | *armhf* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *aarch64* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *aarch64* | Ubuntu 20.04 |
| **ZimaBoard/Blade** | *x86_64* | TBD |
| **NVIDIA Jetson AGX Orin&trade;** | *aarch64* | TBD |
| **Raspberry Pi 3/4** | *arm64* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *arm64* | Ubuntu 20.04 |
| **ZimaBoard/Blade** | *amd64* | TBD |
| **NVIDIA Jetson AGX Orin&trade;** | *arm64* | TBD |

Check out the quick start guides for the detailed installation steps and set-up procedures:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ Eclipse Kura can be started with Java Debug Wire Protocol (JDWP) support, allowi

* Start Kura with Java Debug Wire Protocol (JDWP) typing `sudo /opt/eclipse/kura/bin/start_kura_debug.sh`. This will start Kura and open an OSGi console. It will also start listening for socket connections on port 8000.

!!! warning
Starting from Java 9, the JDWP socket connector accepts only local connections by default (see [here](https://www.oracle.com/java/technologies/javase/9-notes.html#JDK-8041435) for further details). To enable remote debugging on Java 9, the following line in `/opt/eclipse/kura/bin/start_kura_debug.sh`: <br /><br />-Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n &#92;<br><br>has to be replaced with the following one: <br><br>-Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=<b>*:</b>8000,suspend=n &#92;

* Open the tcp port 8000 in the firewall. This can be done through the firewall tab in Kura web interface or using iptables.

* Install your application bundle on the target platform.
Expand Down
Loading