Update documentation to reflect Apama plugin changes #1489
Conversation
| - **Description**: apama-thin-edge-support (or something else if you choose) | ||
| - **Device Filter Type**: (leave empty) | ||
| - **Software Type**: apt | ||
| - **Version**: 10.15.1.0-1::apt |
There was a problem hiding this comment.
This is the version from the 10.15.1 branch - it should be 10.15.0.2 in the published version
| 1. Name must be suffixed with `::project` as in `my-demo-project::project` | ||
| 2. Version must be suffixed with `::apama` as in `1.0::apama` or just `::apama` if you don't need a version number. | ||
| 3. The uploaded binary must be a `zip` file that contains the `project` directory. If a directory named `project` is not found at the root level in the zip, it's considered invalid. | ||
| 1. The version must be suffixed with `::Apama` as in `1.0::Apama` or just `::Apama` if no version number is necessary. |
There was a problem hiding this comment.
The earlier version of the tedge-apama-plugin that thin-edge team developed was installing the plugin binary at /etc/tedge/sm-plugins as apama instead of Apama. So, if you'd like to replace the existing installations of the old plugin with the new one, you may also wanna name your plugin binary as apama and that same name needs to be used as the suffix here. Otherwise both will coexist on machines where the older plugin is already installed. But, if the intent was to keep both side-by-side, then this is fine.
There was a problem hiding this comment.
Pretty sure we are using lowercase and this is just a doc issue. The package will force-remove the tedge-apama-plugin when it installs
There was a problem hiding this comment.
The file is lower case. This is a docs error caused by VS code, which I will fix.
|
|
||
| ## Add the Apama thin-edge support package to the tenant software repository and deploy it to thin-edge |
There was a problem hiding this comment.
You might also wanna provide a link to where the user can download this apama thin-edge support package. I also hope that this support package will work even on a machine where apama is already installed, in which case, it will just install the Apama thin-edge plugin only.
There was a problem hiding this comment.
There's not a fixed URL for the package - it depends on the version. The install instructions should be to install the apama-repo package (for which there is a fixed URL) and then install it as here using apt from the repo
Co-authored-by: Albin Suresh <albinsuresh@hotmail.com>
Co-authored-by: Albin Suresh <albinsuresh@hotmail.com>
Co-authored-by: Albin Suresh <albinsuresh@hotmail.com>
Co-authored-by: Albin Suresh <albinsuresh@hotmail.com>
Co-authored-by: Albin Suresh <albinsuresh@hotmail.com>
|
Thank you for these updates |
Proposed changes
The Apama team are taking over responsibility for the Apama plugin.
This pull request updates the Apama plugin documentation following changes to the plugin made by the Apama team.
Types of changes
Checklist
cargo fmtas mentioned in CODING_GUIDELINEScargo clippyas mentioned in CODING_GUIDELINES