Skip to content

Commit

Permalink
Review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@robertcsakany
robertcsakany committed Mar 18, 2024
1 parent ec707c5 commit 0987c36
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 302 deletions.
32 changes: 12 additions & 20 deletions judo-jsl-fullstack-karaf-project-template-application/src/main/resources/README.adoc.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ After build it can be started
[source,]
----
./judo.sh build
./judo.sh start
----
The commands can be chained:
Expand All @@ -56,7 +56,7 @@ The commands can be chained:
=== Stop the application
After start or reckless, karaf stays, so it have to be stopped when it is not used anymore:
After start or reckless, karaf is not terminated automatically. To stop type:
[source,]
----
Expand All @@ -72,7 +72,7 @@ To check the running instances, use:
----
=== Reckless mode
There are several situation when minimal change performed on model. To decrease the model-to-deploy time the reckless
There are several situations when minimal change performed on model. To decrease the model-to-deploy time the reckless
command can be used. It will enable caching, disabling validation to perform maximum speed. It causes sometimes
errors. On that case it can be fixed with a `build`.
Expand Down Expand Up @@ -141,25 +141,16 @@ Sometimes maven compiling can be slow. In order to investigate what is causing p
`-Dprofile -DprofileFormat=HTML`
After it there will be a HTML report in `.profiler` directory.
Using these flags, maven will generate a HTML report in the `.profiler` directory.
== Layout
=== `model`
The model project.
It creates the intermediate models from PSM model and stores in `/model/target/generated-resources/model/` directory.
It creates the intermediate models from JSL model and stores in `/model/target/generated-resources/model/` directory.
This model is packed as OSGi bundle which is used the JUDO runtime.
It also attach 4 OSGi bundles:
- `script2operation.jar`
+
The generated Java representation of scripts as OSGi services
- `asm2jaxrsapi.jar`
+
CXF based JaxRS implementation which delegates operations as REST.
It is the server side definitions of OpenAPI specified functions.
It also attach am OSGi bundles:
=== `schema`
Expand Down Expand Up @@ -191,7 +182,7 @@ It aggregates bundle definitions and configurations for the backend service in `
=== `karaf-offline`
The assembled karaf service which can be deployed.
The `run-offline.sh` script running it.
We can use the `run-offline.sh` script to run it
=== `docker`
Expand All @@ -204,12 +195,13 @@ mvn clean install -DcreateDocker
== Run service
After the compilation every artifact is created to run karaf service.
Keycloak service have to be accessed by backend.
After the project compilation every artifact is created to be able to start karaf service.
Keycloak service have to be accessed by backend for all apps.
=== Keycloak
The service uses keycloak to authenticate, to be able to run, keycloak can be started before.
By default JUDO apps integrate with keycloak in order to provide authentication and authorization features.
Keycloak must be running in order for applications to start up.
It is accessible in port 8080 by default, so in browser:
Expand All @@ -218,5 +210,5 @@ It is accessible in port 8080 by default, so in browser:
== Settings
Settings can be set up as `judo-documentation` describes.
Settings can be set up as https://documentation.judo.technology/getting-started/introduction.html[judo-documentation] describes.
57 changes: 0 additions & 57 deletions ...ck-karaf-project-template-application/src/main/resources/frontend-react/model/pom.xml.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,6 @@

<build>
<plugins>
<!--
<plugin>
<groupId>hu.blackbelt</groupId>
<artifactId>unpack-artifact-maven-plugin</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<id>copy-files-from-jar</id>
<phase>generate-sources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<outDirectory>${basedir}/src/main</outDirectory>
<artifacts>
<artifact>
<groupId>{{ groupId }}</groupId>
<artifactId>{{ lowerCase model.name }}{{ projectPostfix }}-model</artifactId>
<version>${project.version}</version>
<resources>
<resource>
<source>model/${model-name}-ui.model</source>
<destination>${basedir}</destination>
</resource>
</resources>
</artifact>
</artifacts>
</configuration>
</execution>
</executions>
</plugin>
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
Expand Down Expand Up @@ -72,30 +39,6 @@
</execution>
</executions>
</plugin>

<!--
<plugin>
<groupId>hu.blackbelt.judo.tatami</groupId>
<artifactId>judo-tatami-client-workflow-maven-plugin</artifactId>
<version>${judo-tatami-client-version}</version>
<executions>
<execution>
<id>execute-ui-transformation</id>
<phase>compile</phase>
<goals>
<goal>default-workflow</goal>
</goals>
<configuration>
<esm>{{# if esmModel }}{{ esmModel }}{{ else }}${maven.multiModuleProjectDirectory}/model/${model-name}.model{{/ if}}</esm>
<destination>${basedir}</destination>
<validateModels>${validateModels}</validateModels>
<saveModels>true</saveModels>
<useCache>${useCache}</useCache>
</configuration>
</execution>
</executions>
</plugin>
-->
</plugins>
</build>
</project>
2 changes: 1 addition & 1 deletion ...-jsl-fullstack-karaf-project-template-application/src/main/resources/internal/pom.xml.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<artifactId>{{ lowerCase model.name }}{{ projectPostfix }}-internal</artifactId>
<name>{{ model.name }} SDK Internal</name>
<description>{{ model.name }} - SDK Internal is the bridge the implemented app functions and runtime</description>
<description>{{ model.name }} - SDK Internal is the bridge between the implemented app functions and runtime</description>

<packaging>bundle</packaging>

Expand Down
34 changes: 0 additions & 34 deletions judo-jsl-fullstack-karaf-project-template-application/src/main/resources/model/pom.xml.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,6 @@

<build>
<plugins>
<!--
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>copy-resources</id>
<phase>compile</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${basedir}/target/generated-resources/model</outputDirectory>
<resources>
<resource>
<directory>${project.basedir}/target/generated-resources/model</directory>
<filtering>true</filtering>
<includes>
<include>**/*.model</include>
<include>**/*.yaml</include>
<include>**/*.json</include>
<include>**/*.changelog.xml</include>
</includes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
-->

<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
Expand Down Expand Up @@ -85,9 +54,6 @@
<goal>default-model-workflow</goal>
</goals>
<configuration>
<!--
<jslModel>{{# if jslModel }}{{ jslModel }}{{ else }}${maven.multiModuleProjectDirectory}/target/clasees/model/${model-name}-jsl.model{{/ if}}</jslModel>
-->
<sources>{{# if modelDirectory }}{{ modelDirectory }}{{ else }}${maven.multiModuleProjectDirectory}/src/main/model{{/ if}}</sources>
<modelVersion>${model-version}</modelVersion>
<destination>${project.basedir}/target/generated-resources/model</destination>
Expand Down
19 changes: 0 additions & 19 deletions judo-jsl-fullstack-karaf-project-template-application/src/main/resources/pom.xml.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,25 +195,6 @@
</execution>
</executions>
</plugin>

<!-- Report active profiles on console. -->
<!--
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-help-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>show-profiles</id>
<phase>initialize</phase>
<goals>
<goal>active-profiles</goal>
</goals>
<inherited>false</inherited>
</execution>
</executions>
</plugin>
-->
{{> pom.xml.extra-plugins.fragment.hbs }}
</plugins>
</build>
Expand Down
2 changes: 1 addition & 1 deletion judo-jsl-fullstack-karaf-project-template-root/src/main/resources/mvn/jvm.config
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
-Dfile.encoding=UTF-8 --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED -Dtycho.disableP2Mirrors=true -Djansi.force=true
-Dfile.encoding=UTF-8 --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED -Dtycho.disableP2Mirrors=true -Djansi.force=true
Loading

0 comments on commit 0987c36

Please sign in to comment.