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
2 changes: 1 addition & 1 deletion docs/connect-field-devices/sensehat-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The driver-specific channel configuration contains a single parameter, **resourc

**Note about running on OpenJDK**

If some exceptions reporting `Locked by other application` are visible in the log and the driver fails to start, try switching to the Oracle JVM by installing the `oracle-java8-jdk` package.
If some exceptions reporting `Locked by other application` are visible in the log and the driver fails to start, try switching to the Oracle JVM by installing the `oracle-java17-jdk` package.
For more information on the problem, please see [this](https://github.com/eclipse/kura/issues/2098) GitHub issue.

## Installation
Expand Down
17 changes: 10 additions & 7 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_generic-arm32_installer.deb`; and
2. installers with suffix **nn**, like `kura-6.0.0_generic-arm32-nn_installer.deb`
1. standard **kura** installers, like `kura_6.0.0_arm64.deb`
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,12 +26,15 @@ 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>_generic-<arch>_installer.deb/rpm
kura_<kura-version>_<arch>.deb
```

where `<arch>` is one of the **supported architectures**: *x86_64*, *arm32*, and *arm64*. 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.
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

The Eclipse Kura&trade;'s installer incorporates an adaptive Heap Memory allocation system during installation. The allocation follows a formula based on your gateway's available memory. If your gateway has less than 1024MB of RAM, Kura will set -Xms and -Xmx to 256MB. For gateways with more than 1024MB, one quarter of the total RAM will be assigned to -Xms and -Xmx.

### Initial network configuration
Expand Down Expand Up @@ -97,7 +100,7 @@ To have all the Kura features working, the following dependencies are required:
- Logs: `logrotate`.
- Gps: `gpsd`.
- Python: `python3`.
- Java: `openjdk-17-jre-headless` or `temurin-17-jdk` or `openjdk-8-jre-headless` or `temurin-8-jdk`.
- Java: `openjdk-17-jre-headless` or `temurin-17-jdk`.
- Others: `dos2unix`

### Reference devices
Expand All @@ -106,10 +109,10 @@ Eclipse Kura&trade; has been tested on the following devices and provides full c

| Device | Architecture | OS |
| - | - | - |
| **Raspberry Pi 3/4** | *arm32* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *armhf* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *arm64* | Raspberry Pi OS "Bookworm" |
| **Raspberry Pi 3/4** | *arm64* | Ubuntu 20.04 |
| **ZimaBoard/Blade** | *x86_64* | TBD |
| **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
4 changes: 2 additions & 2 deletions docs/getting-started/raspberry-pi-raspberryos-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ following steps:
4. Download the Kura package with:

```
wget http://download.eclipse.org/kura/releases/<version>/kura-<kura-version>_generic-<arch>_installer.deb
wget http://download.eclipse.org/kura/releases/<version>/kura-<kura-version>_<arch>.deb
```

Note: replace `<version>` in the URL above with the version number of the latest release (e.g. 5.5.0) and `<arch>` with your device architecture

5. Install Kura with: 

```
sudo apt-get install ./kura-<kura-version>_generic-<arch>_installer.deb
sudo apt-get install ./kura-<kura-version>_<arch>.deb
```

6. For a correct configuration of the Wlan interface, it is necessary to set the **Locale** and the **WLAN Country** through the `raspi-config` command:
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/raspberry-pi-ubuntu-20-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ following steps:
4. Download the Kura package with:

```
wget http://download.eclipse.org/kura/releases/<version>/kura-<kura-version>_generic-<arch>_installer.deb
wget http://download.eclipse.org/kura/releases/<version>/kura-<kura-version>_<arch>.deb
```

Note: replace `<version>` in the URL above with the version number of the latest release (e.g. 5.5.0) and `<arch>` with your device architecture
Expand All @@ -68,7 +68,7 @@ following steps:
5. Install Kura with:

```
sudo apt install ./kura-<kura-version>_generic-<arch>_installer.deb
sudo apt install ./kura-<kura-version>_<arch>_installer.deb
```

All the required dependencies will be downloaded and installed.
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
4 changes: 2 additions & 2 deletions docs/references/rest-apis/rest-system-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Identities with `rest.system` permissions can access these APIs.
"kura.command.user": "kura",
"kura.device.name": "raspberry",
"kura.partNumber": "raspberry",
"kura.project": "generic-arm32",
"kura.project": "aarch64",
"kura.company": "EUROTECH",
"java.home": "/usr/lib/jvm/java-8-openjdk-armhf/jre",
"version": "5.4.0-SNAPSHOT",
Expand Down Expand Up @@ -297,7 +297,7 @@ Identities with `rest.system` permissions can access these APIs.
"java.vm.info": "mixed mode",
"java.vm.version": "25.312-b07",
"dpa.connection.timeout": "60000",
"build.number": "generic-arm32-buildNumber",
"build.number": "aarch64-buildNumber",
"ccs.status.notification.url": "ccs:log"
}
}
Expand Down
Loading