Commit 976b89b1 authored by Patrik Meijer's avatar Patrik Meijer
Browse files

Update to renamed submodules

parent f23b7ee3
Loading
Loading
Loading
Loading
Loading
+9 −20
Original line number Diff line number Diff line
@@ -19,12 +19,11 @@ In Depi, these different types of artifacts or _Resources_ are referred to as _T
- `webgme-depi` contains a vscode extension wrapping a webgme instance (and webgme components providing the interface between these two)

## Getting started
For running the back-end services we recommend using docker. For the user interface you can either [install vscode](https://code.visualstudio.com/download) and then install the vscode extensions (search for the extensions from within vscode or simply click on the links in the table above), or use the `caid-front-end` docker image below that is based on [theia](https://theia-ide.org/) and already prepared with the extensions. 

[Install docker](https://docs.docker.com/engine/install/ubuntu/) - this has been tested with `Docker version 25.0.3, build 4debf41` on `Ubuntu 22.04`.
The fasted way to get started is to use the monolithic docker image that contains all the necessary services for the provided example.
If you haven't already, [install docker](https://docs.docker.com/engine/install/ubuntu/) - this has been tested with `Docker version 25.0.3, build 4debf41` on `Ubuntu 22.04`.

### Back-end Services
Start the back-end services first
Start the back-end services first using the monolithic docker-image based on the `Dockerfile` here in this directory.
```
docker run --rm --name caid -p 3000:3000 -p 8888:8888 -p 5150:5150 git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-tools:latest
```
@@ -38,11 +37,14 @@ The following services are running within the monolithic caid-tools container (s
- **gitea** TODO:

### Front-end/User Interface
For the user interface you can either [install vscode](https://code.visualstudio.com/download) and then install the vscode extensions below (click link) or use the `caid-front-end` docker image below that is based on [theia](https://theia-ide.org/) and already prepared with the extensions.

- [Depi Browser](vscode:extension/vu-isis.depi)
- [WebGME Client](vscode:extension/vu-isis.webgme-depi)
- [GSN Editor](vscode:extension/vu-isis.gsn-assurance)
  - This extension requires java 8+

#### Theia based image
Then the theia IDE with the extensions.
```
docker run --rm --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-front-end:latest
@@ -50,6 +52,9 @@ docker run --rm --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt

Once up and running go to: [http://localhost:4000](http://localhost:4000) using your browser (tested with Chrome).

#### VS-Code
To install the extensions you can either [search for them from within vscode](https://code.visualstudio.com/docs/editor/extension-marketplace) or simply click on the links above. Once installed you need to configure the extensions which is [explained here] (examples/README.md#settings), (the monolithic service image only works with `localhost` as host).

### Using the UI

Start out by cloning all the git-repositories that are part of this example. From the terminal in the bottom of the screen invoke the `clone_repos.sh` script. 
@@ -78,23 +83,7 @@ Click on the `Show Dependency Tree` Button under the `State` section and the Dep
dependency chain of the evidences associated with this Solution node.
![Dependency Graph](examples/images/03-dependency-graph.png)

## Developers

### Creating a release

1. update the dependenies edit the `versions` file and run the `./update-sub-modules.sh`.
2. `git commit -am "Release x.x.x"`
3. `git push origin main`
4. `git tag vx.x.x`
5. `git push origin vx.x.x`

### Publishing a release
To be on the safe side, this requires you to clone a fresh copy of the repository.

1. `git clone git@git.isis.vanderbilt.edu:aa-caid/caid-tools.git`
2. `cd caid-tools`
3. `git submodule update --init`
4. `./publish x.x.x`

# Acknowledgements
This work was supported by the DARPA Assured Autonomy program and Air Force Research Laboratory. Any opinions, findings, 
Compare a4b3bc84 to 6489cbd4
Original line number Diff line number Diff line
Subproject commit a4b3bc8493b49227d93e77e78b51838e7d517833
Subproject commit 6489cbd419d44e97665a87674b669e6a8ee45302
+1 −0
Original line number Diff line number Diff line
@@ -120,6 +120,7 @@ IMPORTANT! Replace `<HOST>` with the same host configured for the depi-services.
    "depi.url": "<HOST>:5150",
    "depi.user_name": "demo",
    "webgme-depi.urls": ["http://<HOST>:8888/"],
    "webgme-depi.enableDepi": true,
    "gsnGraph.enableDepi": true
    ...
```
+1 −0
Original line number Diff line number Diff line
@@ -2,5 +2,6 @@
    "depi.url": "localhost:5150",
    "depi.user_name": "demo",
    "webgme-depi.urls": ["http://localhost:8888/?project=guest%2BTestProject"],
    "webgme-depi.enableDepi": true,
    "gsnGraph.enableDepi": true
}
 No newline at end of file
Compare 76767df9 to 3a5d3385
Original line number Diff line number Diff line
Subproject commit 76767df9f99b8a41ae2e1be4cfb2e6a57bf39056
Subproject commit 3a5d33854d598020406504e76e5c27c7136ab96d
Loading