Skip to content

Commit

Permalink
docs(apama): drop usage of software type suffix
Browse files Browse the repository at this point in the history
Signed-off-by: Reuben Miller <[email protected]>
  • Loading branch information
reubenmiller committed Jan 30, 2024
1 parent 50f1522 commit a24193a
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/src/operate/c8y/apama_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Further details about this can be found in the %%te%% documentation at [Manage t
- **Description**: apama-repo (or something else if you choose)
- **Device Filter Type**: (leave empty)
- **Software Type**: apt
- **Version**: 2022::apt
- **Version**: 2022
- **SOFTWARE FILE**: check the *Provide a file path* option and enter the URL: https://downloads.apamacommunity.com/debian/apama-repo_2022_all.deb

4. Click the **Add Software** button.
5. Now select the **Devices** menu option and then select **All devices**.
6. In the list of devices, select the %%te%% device installed previously.
7. In the sub-menu for the device, select the **Software** option.
8. Click the **Install software** button in the bottom left; the apama-repo should be listed.
9. Click the drop-down arrow on the right and check the `2022::apt` radio button, then click **Install**.
9. Click the drop-down arrow on the right and check the `2022` radio button, then click **Install**.
10. Finally, click the **Apply changes** button in the lower right of the panel.

#### Add the Apama thin-edge support package to the tenant software repository and deploy it to thin-edge
Expand All @@ -39,14 +39,14 @@ Further details about this can be found in the %%te%% documentation at [Manage t
- **Description**: apama-thin-edge-support (or something else if you choose)
- **Device Filter Type**: (leave empty)
- **Software Type**: apt
- **Version**: latest::apt
- **Version**: latest
- **SOFTWARE FILE**: select the **Provide a file path** option and give an **empty space** (' ').
4. Click the **Add Software** button.
5. Now return to the **Devices** menu option and then select **All devices**.
6. In the list of devices, select the %%te%% device installed previously.
7. In the sub-menu for the device, select the **Software** option.
8. Click the **Install software** button in the bottom left; the apama-thin-edge-support should be listed.
9. Click the drop-down arrow on the right and check the `latest::apt` radio button, then click **Install**.
9. Click the drop-down arrow on the right and check the `latest` radio button, then click **Install**.
10. Finally, click the **Apply changes** button in the lower right of the panel.

After installation of the support for Apama onto the %%te%% device, the correlator will attempt to start, but will fail initially because there is not yet an Apama project installed. Instructions are given below for installing an Apama project on the device.
Expand All @@ -59,8 +59,7 @@ There is a naming convention that you need to follow while creating software ent

For Apama projects:

1. The version must be suffixed with `::apama` as in `1.0::apama` or just `::apama` if no version number is necessary.
2. The uploaded binary must be a `zip` file that contains the `project` directory. If a directory named `project` is not found by the plugin at the root level in the zip, it is considered invalid.
1. The uploaded binary must be a `zip` file that contains the `project` directory. If a directory named `project` is not found by the plugin at the root level in the zip, it is considered invalid.

<p align="center">
<img
Expand Down

0 comments on commit a24193a

Please sign in to comment.