Skip to content

Update README docs around LDDs #255

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.

Sign up for GitHub

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

Merged
JohnKallies merged 1 commit into from
Nov 14, 2022
Merged

Update README docs around LDDs #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The Spring profiles in OSMT can be conceptually grouped as:
| reindex | Runs the Elasticsearch re-index process.<br>This process terminates when complete, and does not expose API endpoints; no Security profile is needed. |

## Running from the Command Line
See [Using the OSMT development utility](../README.md#using-the-osmt-development-utility-osmt_devsh) in the project [README.md](/../README.md) for using `osmt_cli.sh` to start and stop the Development Docker services and the Spring API application. `osmt_cli.sh` automatically sources the environment variables from `api/osmt-dev-stack.env`.
See [Using the OSMT development utility](../README.md#using-the-osmt-cli-utility-osmt_clish) in the project [README.md](../README.md) for using `osmt_cli.sh` to start and stop the Development Docker services and the Spring API application. `osmt_cli.sh` automatically sources the environment variables from `api/osmt-dev-stack.env`.

* You are not required to use the `osmt_cli.sh` utility. Many will prefer to run `mvn` and `java -jar` commands against the jars in the api/target directory _(this workflow assumes you know how to use `mvn clean package` to create jars)_. Examples are given below. You will probably need to use a configuration profile (i.e., `dev`) and at least one application component profile (i.e., `apiserver`).
* To override specific properties with JVM arguments when developing with Maven, pass the JVM arguments as the value to `-Dspring-boot.run.jvmArguments=`
Expand Down
15 changes: 15 additions & 0 deletions docs/arch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

This document serves to explain some nuances in the Logical Deployment Diagrams in [osmt-model.mdj](osmt-model.mdj)

## OSMT Conceptual Deployment Diagram
This diagram outlines the basic dependencies for OSMT with being prescriptive of how they are satisfied. In this regard, it is more abstract than an LDD. It serves to inform a more proper implementation of a given LDD.

As-is, it expresses the docker-compose stack used in the local [Development configuration](../../README.md#development-configuration).

[<img src="./osmt-conceptual-ldd.png" width="800" alt="OSMT Conceptual Deployment Diagram" />](./osmt-conceptual-ldd.png)

## OSMT SDLC Deployment Diagram
This diagram provides a starting point for deploying an ephemeral SDLC instance of OSMT in AWS. This kind of instance would not have any redundancy or load balancing, and would be deployed when commits are pushed to relevant branches.

[<img src="./osmt-sdlc-dev-ldd.png" width="800" alt="OSMT SDLC Deployment Diagram" />](./osmt-sdlc-dev-ldd.png)