Commit 3f6025e2 authored by hengwen's avatar hengwen

Typos

parent a9c86711
Pipeline #140458 canceled with stage
in 7 seconds
This is the simulation server module. It provide a set of RESTful APIs for setting up, running simulation and also
This is the simulation server module. It provides a set of RESTful APIs for setting up, running simulation and also
retrieving the results.
## Install
......@@ -21,7 +21,7 @@ To start a simulation, the following services must be started at first:
- RMIModelServer
- RPC server
The RMIModelServer and RPC server depend on ZooKeeper, so before starting them, make
The RMIModelServer and RPC server depends on ZooKeeper, so before starting them, make
sure ZooKeeper is running.
The following instructions enables the server to run a simulation task
......@@ -29,18 +29,18 @@ with arbitrary maps and scenarios.
### ZooKeeper
Checkout the installation guide [here](https://zookeeper.apache.org/doc/r3.1.2/zookeeperStarted.html#ch_GettingStarted).
After installation, start the ZooKeeper server, it should be listening on **localhost:2181** by default.
After installation, start the ZooKeeper server. By default, it should be listening at **localhost:2181**.
### RMIModelServer
Please refer to [RMIModelServer](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/RMIModelServer) for installation guide.
After installation, start at least one rmiserver, by default it should be listening on **localhost:10101**.
After installation, start at least one rmiserver By default, it should be listening at **localhost:10101**.
### RPC Server
Go to the rpc module for installation guid.
Start at least one RPC server on **localhost:6000**
Go to the rpc module for installation guid.
Start at least one RPC server at **localhost:6000**.
After all services are up, there are some simple scenarios and maps for testing purpose
available in `restful/src/test/resources`.
There are some simple scenarios and maps for testing purpose
available in directory `restful/src/test/resources`.
## Configuration
The configuration file are located at `restful/src/main/resources/config.properties`.
......@@ -65,12 +65,10 @@ $ ./build.sh
```
## Development with Docker
It could involve multiple RMIModelServer/RPC server in the development.
By using docker you can easily start and scale all services.
`dev.yml` configures the restful server to run in debug mode, the JVM listens for debugging request
The development always involves debugging, with docker, debugging has to be done via remote debugger.
`dev.yml` already configured the restful server to run in debug mode, the JVM listens for debugging request
at **localhost:8787**.
To debug restful server, simply configure a remote debugger in the IDE and start debugging.
To debug restful server, create a remote debugger in the IDE and start debugging.
The development workflow with should be:
1. code
......@@ -79,7 +77,7 @@ The development workflow with should be:
4. start a remote debugger to debug the server
5. goto 1
If you need to debug rpc server, add a new service into `dev.yml`:
If you need to debug the rpc server, add a new service into `dev.yml`:
```yaml
rpc-server-debugger:
image: rpc-server
......@@ -106,7 +104,7 @@ $ ./run_test.sh
```
## Visualization
By default, visualization is not enabled on the server.
By default, visualization is not enabled in the server.
To enable visualization, put the static files under `restful/src/main/resources/resources`.
Aa an example, to use the visualization provided in [visualization repo](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/visualization),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment