Changes between Version 19 and Version 20 of CloudNativeRenew

Timestamp:

Mar 28, 2021, 5:46:59 PM (4 years ago)

Author:

roewekamp

Comment:

--

CloudNativeRenew

@@ -12 +12 @@
 
 == Features ==
-Cloud Native Renew offers the following features.
-It is assumed, that the system is up and running, to do so on your own, follow the [#install installation instructions] further down the page.
+Cloud Native Renew offers the following features.\\
+It is assumed, that the system is up and running, to do so on your own, [#download download] Cloud Native Renew and follow the [#install installation instructions] further down the page.
+
+For all examples it is assumed, that the service is running on localhost on port 8085. If you set it up otherwise than suggested in the [#install installation instructions], please use the corresponding URL you've set up instead.\\
+It is also assumed, that you have a web browser and the command line tool `curl` installed.
+
+For a quick overview over the available (non-health related) endpoints navigate to `http://localhost:8085/swagger-ui.html`.
+
+
+=== Examine Logs from the simulator via Web ===
+To access all system log data from when the cloud native plugin was loaded onwards, open up the URL:\\
+`http://localhost:8085/logs`
+
+=== Upload nets and start a simulation === #upload
+It is possible to use the Cloud Native Renew Plugin to upload net definitions to an HTTP endpoint.
+Renew uses so called shadow net systems to simulate reference nets.
+A shadow net system contains just the bare minimum to run a (non-visual) headless simulation.
+To create a shadow net from a regular Renew .rnw net definition file, you can use Renew user interface.
+To just try functionality you can also just use the supplied `example.sns` file.\\
+To upload a shadow net system and start a simulation follow these steps:\\
+* Create a shadow net system by doing either of these steps:
+ * You either can use the supplied `example.sns` file or
+ * You can also create a shadow net system yourself: Open up a Renew instance (or use the one spawned by the startup earlier), draw a reference net (or multiple), save all of your nets with a specific name each (File -> Save Drawing As...), and hit File -> Export -> Export all drawings (merged file) -> !ShadowNetSystem
+   Close the net drawing(s), but not Renew itself.
+* Assume the shadow net system file is namend `example.sns`: Upload the net using:\\ `curl -F 'snsZipFile=@example.sns' localhost:8085/upload/sns?fileName=example.sns`
+* After uploading you can start a simulation. Assume you named the main net within `example.sns` also `example`.
+ * Use this command: `curl -X POST 'localhost:8085/simulation/start?mainNet=example&sns=example.sns'` \\
+   Note, that shadow net systems do not hold graphical information, therefore you will not be able to see the simulation within the spawned Renew instance, but you should be able to observe the console output generated by the running simulation.
+   Within the intended deployment, that was shown in the figure above, Renew instances are headless anyways and do not have any graphical output.
+
+=== Control a running simulation ===
+It is possible to control a running simulation over HTTP.
+To do you, you need to set up a simulation first.
+The most simple way to do so is to draw (or load) a net, like the supplied `example.rnw` file and start a simulation from within the Renew GUI: `Simulation -> Start Simulation`\\
+You can alternatively use the method described [#upload above] to upload a shadow net system and start a simulation with it remotely.
+As noted earlier, this method will not show graphical feedback, while starting through Renew directly does.
+
+* The simulation can now be controlled by using the following command:\\
+`curl -X POST 'localhost:8085/simulation/control?command=step'`\\
+You can use these keywords instead of `step`:
+ * `run` (To run simulations, that have been paused or only initialized)
+ * `step` (To execute a single step in the simulation)
+ * `stop` or `halt` (To suspend the simulation but do not terminate it)
+ * `term` (To terminate a simulation irreversibly. Subsequent control commands will have no effects until a new simulation is started.)
+
 
 === Extending the simulator on the fly ===
 
-== Download ==
+== Download == #download
 
 The latest version of the cloud native Renew plugin (shown in bold font in the figure) can be downloaded here.
@@ -36 +79 @@
 * Open a web browser and navigate to `http://localhost:8085/swagger-ui.html` to see an API documentation of the service endpoints with their required parameters. Note, that this overview does not cover the /health endpoints, that indicate state of the application and its parts.
 
-* You can for example upload an existing shadown net system .sns.
- * You either can use the supplied `example.sns` file or
- * You can also create a shadow net system yourself: Open up a Renew instance (or use the one spawned by the startup earlier), draw a reference net, save it with a specific name (File -> Save Drawing As...), and hit File -> Export -> Export all drawings (merged file) -> !ShadowNetSystem
- * If you created the net within the here supplied Renew instance with the cloud native plugin, close the net drawing, but not Renew itself.
- * Assume the shadow net system file is namend `example.sns`: Upload the net using: `curl -F 'snsZipFile=@example.sns' localhost:8085/upload/sns?fileName=example.sns`
-* After uploading you can start a simulation. Assume you named the net within `example.sns` also `example`.
- * Use this command: `curl -X POST 'localhost:8085/simulation/start?mainNet=example&sns=example.sns'`
- * The simulation can now be controlled by the endpoint: `curl -X POST 'localhost:8085/simulation/control?command=step'` Use the keywords:
-  * `run` (To run simulations, that have been paused or only initialized)
-  * `step` (To execute a single step in the simulation)
-  * `stop` or `halt` (To suspend the simulation but do not terminate it)
-  * `term` (To terminate a simulation irreversibly. Subsequent control commands will have no effects until a new simulation is started.)
+
+