You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
= How-To run the light `model-server` in MPS as plugin
2
+
:navtitle: mps-model-server-plugin
3
+
4
+
5
+
You can run a *light version* of the `model-server` directly in MPS via the dedicated *MPS as Modelix Model Server Plugin*, which is published over at the https://plugins.jetbrains.com/plugin/22834-mps-as-modelix-model-server[JetBrains Marketplace^].
6
+
It always supports the latest MPS versions.
7
+
8
+
NOTE: More information on the component in general can be found in the xref:core:reference/component-mps-model-server-plugin.adoc[corresponding component reference].
9
+
10
+
[IMPORTANT]
11
+
====
12
+
A light model-server does not provide the full features as an independent `model-server` instance will.
13
+
More *advanced features* will not work with this light version (e.g. modelix specific repositories/branches, or the xref:howto/metrics.adoc[metrics]).
14
+
15
+
If you want the full capabilities of the `model-server`, check out xref:howto/usage-model-api-gen-gradle.adoc[how to start it standalone].
16
+
====
17
+
18
+
19
+
== How to Install the Plugin
20
+
21
+
In MPS navigate to File -> Settings -> Plugins (left) -> Marketplace (top) -> Search for "modelix model server" -> Press *Install* -> Press *Restart IDE*.
22
+
23
+
image::model-server-plugin-marketplace.png[Installing the MPS model-server plugin]
Once you restart MPS, the light `model-server` will start automatically with MPS.
32
+
There are no graphical user interfaces, but to verify you can check the MPS log for
33
+
34
+
[source,bash]
35
+
--
36
+
starting modelix server
37
+
--
38
+
39
+
The `model-server` will run by default on port `48305`.
40
+
You can check the health status over at http://127.0.0.1:48305/health[^].
41
+
42
+
If you want to find out how connect a client and send queries to the plugin, have a look at the xref:howto/modelql.adoc[ModelQL documentation] or the xref:core:reference/component-mps-model-server-plugin.adoc[component reference].
Copy file name to clipboardExpand all lines: docs/global/modules/core/pages/howto/usage-model-server.adoc
+7-26Lines changed: 7 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,8 @@
3
3
4
4
NOTE: If you are interested in a more practical usage of what is presented here, check out the https://github.com/modelix/modelix.samples[samples project^]
5
5
6
+
NOTE: To run a light version of the `model-sever`, check out xref:core:howto/mps-model-server-plugin.adoc[]
7
+
6
8
== Backends: In Memory vs. Database
7
9
8
10
The `model-server` will by default require a database backend.
@@ -19,7 +21,7 @@ The following list gives an overview of the many ways to run a `model-server`:
19
21
20
22
=== 1. Docker
21
23
22
-
We publish a docker container of the `model-server` over on https://hub.docker.com/r/modelix/model-server/tags[docker hub].
24
+
We publish a docker container of the `model-server` over on https://hub.docker.com/r/modelix/model-server/tags[Docker Hub^].
23
25
To run the model-server container with the in memory backend, simply call the following.
24
26
[source, shell]
25
27
--
@@ -51,9 +53,7 @@ Run using `docker-compose` via:
51
53
$ docker-compose up
52
54
--
53
55
54
-
NOTE: For more integrated examples, have a look at the
55
-
xref:samples:monitoring.adoc[model server]
56
-
monitoring setup in the samples, which starts the `model-server` using `docker-compose`.
56
+
NOTE: For more integrated examples, have a look at the xref:core:howto/metrics.adoc[metrics and monitoring] capabilities, which shows how to start the `model-server` using `docker-compose`.
57
57
58
58
For more complex setups, which require a database backend, you can use the following:
59
59
@@ -192,29 +192,10 @@ To give arguments to the gradle run command, you have to add them via the `--arg
192
192
====
193
193
194
194
195
-
=== 5. MPS
196
-
197
-
You can run a *light version* of the `model-server` directly in MPS via the dedicated *MPS as Modelix Model Server Plugin*, which is published over at the https://plugins.jetbrains.com/plugin/22834-mps-as-modelix-model-server[JetBrains Marketplace].
198
-
199
-
200
-
[IMPORTANT]
201
-
====
202
-
A light model-server does not provide the full features as an independent `model-server` instance will.
203
-
More *advanced features* (e.g. xref:core:howto/modelql-writing.adoc[ModelQL], or the xref:core:howto/metrics.adoc[metrics]) and *advanced clients* (e.g. xref:core:howto/modelql.adoc[ModelQLClient]) will not work.
204
-
====
205
-
206
-
In MPS navigate to File -> Settings -> Plugins (left) -> Marketplace (top) -> search for "modelix model server" -> press install.
207
-
208
-
image::model-server-plugin-marketplace.png[Installing the MPS model-server plugin]
* https://github.com/modelix/modelix.core/blob/main/mps-model-server-plugin/src/main/kotlin/org/modelix/model/server/mps/MPSModelServer.kt#L77C22-L77C38[`MPSModelServer.kt` (Implementation of the 'MPS as Modelix Model Server' plugin)]
0 commit comments