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

feature/M0081MEJA-2334_sentinel-usage #792

Draft
wants to merge 83 commits into
base: master
Choose a base branch
from

Conversation

apielmicroej
Copy link
Contributor

No description provided.

SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
@jcourcelmicroej jcourcelmicroej marked this pull request as ready for review November 2, 2023 08:21
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
SDKUserGuide/licenses.rst Outdated Show resolved Hide resolved
@frivieremicroej frivieremicroej marked this pull request as draft December 13, 2023 08:33
@frivieremicroej
Copy link
Contributor

Marked as draft as a preview documentation. Will not be merged until we decide to officially support Sentinel as COTS component.

@frivieremicroej
Copy link
Contributor

jcourcelmicroej and others added 19 commits April 18, 2024 08:36
this happened to me because the file is first extracted from windows and then copied to linux
@frivieremicroej frivieremicroej force-pushed the feature/M0081MEJA-2334_sentinel-usage branch from db13347 to e40093a Compare April 18, 2024 06:44
- split system admin vs developer workstation
- add config of the remote server from docs.cross
- update wording / images
Comment on lines +355 to +359
[DEBUG] ===== MicroEJ Dongle Debug Tool =====
[DEBUG] => Detected dongle UID: XXXXXXXX.
[DEBUG] => Dongle UID has valid MicroEJ data: XXXXXXXX (only the first one is listed).
[DEBUG] => Detected MicroEJ License XXXXX-XXXXX-XXXXX-XXXXX - valid until YYYY-MM-DD.
[DEBUG] ===== SUCCESS =====
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include the output for Architecture 8.1+ ?

Suggested change
[DEBUG] ===== MicroEJ Dongle Debug Tool =====
[DEBUG] => Detected dongle UID: XXXXXXXX.
[DEBUG] => Dongle UID has valid MicroEJ data: XXXXXXXX (only the first one is listed).
[DEBUG] => Detected MicroEJ License XXXXX-XXXXX-XXXXX-XXXXX - valid until YYYY-MM-DD.
[DEBUG] ===== SUCCESS =====
[DEBUG] ===== MicroEJ Sentinel Debug Tool =====
[DEBUG] => login failed with feature 1, status=400
[DEBUG] ===== MicroEJ Dongle Debug Tool =====
[DEBUG] => Detected dongle UID: XXXXXXXX.
[DEBUG] => Dongle UID has valid MicroEJ data: XXXXXXXX (only the first one is listed).
[DEBUG] => Detected MicroEJ License XXXXX-XXXXX-XXXXX-XXXXX - valid until YYYY-MM-DD.
[DEBUG] ===== SUCCESS =====

I just had a feedback from customer:

Unsure what that result regarding the MicroEJ Sentinel Debug Tool login failure is indicative of as I have not run across it yet on the doc site

@rlouedec-microej
Copy link
Collaborator

The default settings for RTE installation on a workstation seems weird.
I would expect we should configure Configuration > Network > Network Visibility to None (Local Access Only).
The default All Network Adapters seems only adapted for the installation time of the floating license server.
Also, we should probably document how to restrict access to the administration interface on the floating license server.

@@ -10,6 +10,8 @@ There are two main steps:
#. First, your System Administrator has to :ref:`setup the Sentinel Floating License Server <setup_sentinel_floating_license_server>` on a host machine.
#. Then, on your Developer workstation, proceed with the :ref:`setup of the Sentinel client for the SDK <setup_sentinel_developer_workstation>`.

.. figure:: images/sentinel_architecture.png
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice diagram.

Can we have different arrows for the step1 / step 2 to clarify that those are emails and not actual network connections like other arrows?

Also, I am not sure how relevant it is to document the MicroEJ part. This could be more confusing than helping.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the diagram.

apielmicroej and others added 3 commits September 12, 2024 16:56
* add links to yocto binaries

* Fix yocto links

* rename Platform to VEE Port in ADG

* Add changelog for Architecture maintenance/7.20.5

* remove loadXXXConfiguration tasks and add execTool task in addon-library plugin

* document generateApplicationWrapper task

* Document Application Wrapper

* document how to install tools in a Virtual Device

* fix wrapper class main method

* document the buildApplicationObjectFile task

* document how to use runtime APIs

* Update gradle plugin version to 0.17.0.

* Additional SystemProperties for s3 coverage w/ SDK6

* add source pptx for kifaru diagrams

* remove old version of js_runtime pptx and move new pptx to correct pptx folder

* Add a going further section, clarify wording.

* Fix tables

* Define header in tables and fix typo

* review Security Manager implementation page

* Fix remarks

* Add VEE porting guide link and modify note.

* Fix typo and VEE wear link.

* Fix typo, add Gradle link

* Add a missing word

* Move GUI Software Robot from Tutorials to App Dev Guide / Deve Tools

* Move Detect Text Overflow Documentation to App Dev Guide / MWT Debug

* Move + update Add Emoji to Vector Font doc to App Dev Guide / MicroVG doc

* Move + Update intrument Code for Logging to App Dev Guide / Dev Tools section

* Move + Update Data Serialization Tutorial to App Dev Guide / Libraries

* Move + Update Add IAR to MICROEJ SDK Docker Image to SDK5 How To Guides

* Move + Update setup Build Using Jenkins And Artifactory to SDK5 How To Guides

* Move Run a Testsuite on Device doc to VEE Port Dev Guide / VEE Qualification

* Update rt1170 website link

* Update Architecture changelog with version 8.1.1

Co-authored-by: Frédéric RIVIERE <[email protected]>

* Add troubleshooting for Windows path limit exceeded error

* Update Architecture release notes with version 8.1.1

* Move tutorialCreateCustomPlatform to VEE Porting Guide

* Add Introduction page

* Update KernelDeveloperGuide/applicationSecurityPolicy.rst

Co-authored-by: stinlot-microej <[email protected]>

* reword the introduction of securitymanager implementation

* Update KernelDeveloperGuide/applicationSecurityPolicy.rst

Co-authored-by: stinlot-microej <[email protected]>

* Add mock framework section

* Fix copyright

* Move UI tutorials to UI App Dev Guide

* Move + Update intrument Code for Logging to App Dev Guide / Dev Tools section

* Move + Update Data Serialization Tutorial to App Dev Guide / Libraries

* Remove GUI tutorials modifications

* Revert "Merge branch 'feature/M0127CC-763_move_tutorials_to_AppDevGuide' of github.com:MicroEJ/docs into feature/M0127CC-763_move_tutorials_to_AppDevGuide"

This reverts commit 598bb7d, reversing
changes made to a2f7e19.

* Update rt1170 website link

* Update Architecture changelog with version 8.1.1

Co-authored-by: Frédéric RIVIERE <[email protected]>

* Add troubleshooting for Windows path limit exceeded error

* Update Architecture release notes with version 8.1.1

* Trigger CI build

* Update Mock Framework documentation

* Update ApplicationDeveloperGuide/guiSoftwareRobot.rst

* Detail where the Heap files are dumped

* Apply suggestions from code review

Co-authored-by: emoreac-microej <[email protected]>

* Fix Mock Framework doc following review

* Revert "Move + Update setup Build Using Jenkins And Artifactory to SDK5 How To Guides"

* Update time doc with tzdb support

* Minor typo fix

* Update after review

* set linkcheck to only test microej.com links and inner references

* keep old linkcheck_ignore patterns commented for occasional testing

* include github.com/MicroEJ, nxp.com and facer.io links in linkcheck

* Tzdb provider type is now required in types.list

* Add a reference to the tzdb resource size

* Add link to Mock Framework samples

* Note about Java compliance level settings in Eclipse is SDK 5 specific.

* Highlight "BSP Without GPU" prerequisite in UI Migration Guide

* Clarify how to enable the Flush Visualizer

* Add NLS in NLS page title to improve search results

* Update Flush Visualizer doc following review

* Add VEE Script doc

* Revert "Update Flush Visualizer doc following review"

This reverts commit cdb0ba2.

* Improve VEE Script doc

* Apply fixed from review

* Apply suggestions from code review

Co-authored-by: gharelMicroEJ <[email protected]>

* Fix typo

* Fix title underline

* Fixed typo

* Revert "Move Tutorials Intrument Code for Logging & Data Serialization Tutorial to App Dev Guide"

* Move the following tutorials to the App Dev Guide:�- Instrument Java Code for Logging

- Explore Data Serialization Formats

* Remove unused images

* add SDK 5.9.0 changelog

* Explain how to configure VG Pack.

* Update VG changelog.

* Update VG release notes.

* Fix changelog and identify sections to update.

* fix build

* remove vglite

* introduce the custom extension (image gen and fp vg)

* review the tables in the release notes

* Update the names in vg_llapi_emb.png

* Update the documentation of the CCO MicroUI over NemaGFX

* Update the documentation for the CCO MicroVG over VGLite

* Update the documentation for the CCO MicroVG

* release notes of vg pack

* change the dma2d repository

* ui migration guide: replace "Copy" by "Transmit"

* remove invalid notions of vglite in microvg traces

* fix ui pack min version

* Update the documentation for the CCO MicroUI over VGLite

* simplify sumup of vg llapi (remove font.c)

* harmonize llapi vg matrix with other graphs

* fix llapi vg path

* fix llapi vg gradient

* fix llapi vg bvi

* fix llapi vg font

* fix cco vg

* Add the migration guide for the VG Pack 1.6.0

* Add the UI C module migration guide

* Add a build task

* Add links

* Remove an unreleased version

* Reword the UI migration guide

* Detail how to remove the interrupt mode

* Disable the link check for module repositories

* Update the UI migration guide about MicroUIGraphicsContext.setDrawingLimits

* Update the changelog and migration guide for the VG Pack

* Update the changelog and migration guide for the C Module MicroUI over DMA2D

* Move links to uiReplaces.rst

* Update the UI migration guide

* Fix the UI migration guide

* fix cco vg

* fix links

* Revert "Disable the link check for module repositories"

This reverts commit 9e241b7.

* fix vg changelog

* Explicit steps to use dumps generated by 'VEE memory dump macro script'

* Add bash command to merge .hex files

* Improve Font Loader Documentation

* ui pack 14.0.2

* Add back support of JDK 21 for SDK 6 since M0090IDE-4466 has been fixed

* Apply suggestions from code review

Co-authored-by: microej-sh <[email protected]>

* Fix Inject Application Options For a Specific Test doc

* Update Inject Application Options For a Specific Test doc

* Fix Oracle JDK download link: remove fr

* Update SDK 6 scope page to add the build of a Kernel Application

* Add Serial to Socket Transmitter in SDK 6 documentation

* improve heap dumper documentation for SDK5 on device (#1003)

* M0090IDE-4741 Document how to deploy an Executable without rebuilding it in SDK 6

* M0090IDE-4748 Add new SDK 6 0.18.0 version

* Add Shielded Plug limitations

* Fix rst build issue

* Add an how-to section to disable Ivy descriptor publication with SDK 6.

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: Rémy LOUEDEC <[email protected]>

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: Rémy LOUEDEC <[email protected]>

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: dbedin-microej <[email protected]>

* Fixes after review.

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: dbedin-microej <[email protected]>

* Add a link to Manage Versioning page from SDK 6 publication page.

* Fix typo on limitations

* Fix a link

* Clarify the UI migration guide

* Minimal documentation on howto create and configure a runtime-api project with SDK 6.

* Add runtime-api plugin tasks description.

* Update runtime environment page with SDK 6 runtime-api plugin.

* Add documentation for the motion library.

* add a note about ui traces

* migrate KF specifications to docs

* turn all tables to list-tables

* fix caption and anchors

* fix typos

* add missing images

* remove extra line skips

* fix conversion error

* update the KF header for docs

also synchronize latest KF API version

* fix indices

* remove [jls]

* review section links and footnotes

* add links to javadoc

* fix schemas scale

also remove duplicate png files

* sync shared interfaces specification

remove duplicates and merge content of the shared interface mechanism between ADG (user point of view) and KF spec (underlying runtime semantic)

* fix list & state typos

* sync the stop specification with javadoc

* Adding NET 11.1.0 testsuite versioning.

---------

Co-authored-by: Nicolas Houzé <[email protected]>
Co-authored-by: Benjamin Alix <[email protected]>
Co-authored-by: nhouze-microej <[email protected]>
Co-authored-by: Frédéric RIVIERE <[email protected]>
Co-authored-by: Jerome Leroux <[email protected]>
Co-authored-by: Denis BEDIN <[email protected]>
Co-authored-by: Benoit Guédas <[email protected]>
Co-authored-by: dbedin-microej <[email protected]>
Co-authored-by: acolleux-microej <[email protected]>
Co-authored-by: ntinsalhi <[email protected]>
Co-authored-by: Félix Pinel <[email protected]>
Co-authored-by: Gaëtan Harel <[email protected]>
Co-authored-by: acolleux <[email protected]>
Co-authored-by: Corentin Blanchard <[email protected]>
Co-authored-by: Rémy LOUEDEC <[email protected]>
Co-authored-by: Rémy LOUEDEC <[email protected]>
Co-authored-by: stinlot-microej <[email protected]>
Co-authored-by: Alexis Pineau <[email protected]>
Co-authored-by: Stévann Tinlot <[email protected]>
Co-authored-by: microej-sh <[email protected]>
Co-authored-by: Thomas Delhoménie <[email protected]>
Co-authored-by: emoreac-microej <[email protected]>
Co-authored-by: Thomas Pons <[email protected]>
Co-authored-by: Thomas Pons <[email protected]>
Co-authored-by: Benoit <[email protected]>
Co-authored-by: gbalan-microej <[email protected]>
Co-authored-by: Andy Poudret <[email protected]>
Co-authored-by: Andy Poudret <[email protected]>
Co-authored-by: Sébastien Eon <[email protected]>
Co-authored-by: Anas KHABALI <[email protected]>
Co-authored-by: seonmej <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants