Skip to content

Commit

Permalink
updated with latest instructions in prep for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Diaz, Manuel Joel authored and Diaz, Manuel Joel committed Jan 24, 2020
1 parent a071ef6 commit fc9bbc1
Showing 1 changed file with 52 additions and 6 deletions.
58 changes: 52 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@ A vagrant-based virtual machine (VM) for setting up the [Open Model Based Engine
It is intended as a stop-gap solution until a scalable containerized version of the OpenMBEE MMS
server can be developed, e.g., using [Kubernetes][kubernetes].

As of 1.23.2020, this VM does not work as-is with [OpenMBEE MMS Docker Image][docker-image] -- versions 3.3.0 and 3.4.2 have been unsucessfully tested in a local Ubuntu 18.04 server; other versions have not been tested. A future commit will make this VM compatible with those latest versions.
As of 1.24.2020, this VM works with [OpenMBEE MMS Docker Image][docker-image] v3.4.2 (latest) and has been successfully deployed and tested in a local Ubuntu 18.04 server; other versions have not been tested. Additionally, the [Model Development Kit (MDK)][mdk] v4.1.3 plugin for MagicDraw][magicdraw] successfully works with the MMS server this repo provisions.

## Installation

## Prerequisites
1. Install [Vagrant][vagrant].

2. Install [VirtualBox][virtualbox].

3. Clone this repository:

## Installation
1. Clone this repository:
```
git clone https://github.com/sanbales/openmbee-vm.git
git clone https://github.com/MJDiaz89/openmbee-vm.git
```
4. Provision the virtual machine:
2. Provision the virtual machine:
```
cd openmbee-vm
vagrant up
Expand All @@ -30,13 +32,39 @@ As of 1.23.2020, this VM does not work as-is with [OpenMBEE MMS Docker Image][do
## Usage
### Login to Alfresco
http://192.168.1.182:8080/share/page/
using `admin` as both the username and the password.
### Login to View Editor
You can login to the OpenMBEE [View Editor][view-editor] by going to:
http://127.0.0.1:8080/alfresco/mmsapp/mms.html#/login
and using `admin` as both the username and the password.
> View Editor **does not** come with this repo yet -- perhaps coming soon.
### Access REST API
You can access the Swagger UI at
http://127.0.0.1:8080/alfresco/mms/swagger-ui/index.html
### Test MMS via REST
Use the following curl commands to post an initial organization + project:
```
curl -w "\n%{http_code}\n" -H "Content-Type: application/json" -u admin:admin --data '{"orgs": [{"id": "vetestorg", "name": "vetestorg"}]}' -X POST "http://localhost:8080/alfresco/service/orgs"
curl -w "\n%{http_code}\n" -H "Content-Type: application/json" -u admin:admin --data '{"projects": [{"id": "vetestproj","name": "vetestproj","orgId": "vetestorg", "type": "Project"}]}' -X POST "http://localhost:8080/alfresco/service/orgs/vetestorg/projects"
```
Make sure the server accepted them:
````
curl -w "\n%{http_code}\n" -H "Content-Type: application/json" -u admin:admin -X GET "http://localhost:8080/alfresco/service/orgs"
curl -w "\n%{http_code}\n" -H "Content-Type: application/json" -u admin:admin -X GET "http://localhost:8080/alfresco/service/orgs/vetestorg/projects"
````
### Troubleshoot
If that URL is not responding, make sure [Alfresco][alfresco] is running, by going to:
Expand Down Expand Up @@ -70,13 +98,31 @@ If that is not working, checkout the `docker-compose` logs by:
to inspect how the server is handeling requests and responses.
3. Make sure the docker containers are actually running:
```
dc ps
```
For more information on the custom commands, type:
```
commands
```
4. Make sure you can access Tomcat at
```
http://192.168.1.182:8080
```
and that you see all services running at
```
http://192.168.1.182:8080/manager/html/list
```
authenticate with
```
user: admin
password: tomcatadmin
```
### Important Notice
For this server to be useful, you will need to have: [MagicDraw][magicdraw], the
[Model Development Kit (MDK)][mdk] plugin, and a SysML model.
Expand Down

0 comments on commit fc9bbc1

Please sign in to comment.