Skip to content

Telepresence Annotation SlackBot (aka anno-slackbot)

source code

anno-slackbot is a service that can be spun up for missions that require remote annotation via Slack. It's associated with two slack commands: /dive and /anno

Basic Usage

  1. /dive - Set the current dive being annotated. For example, /dive Doc Ricketts 9999. Any annotations created in slack will be associated with that dive in M3/VARS.
  2. /anno - Creates an annotation. It has three forms:
    1. /anno "<concept>" - e.g. /anno "Nanomia". This form creates an annotation using the provided concept. The concept must be enclosed by single or double quotes. If the concept does not match any existing concepts in the VARS Knowledgebase, it will be added as a comment in the form object | comment | self | <concept>.
    2. /anno <comment text> - Create an annotation using the concept object with the text added as a comment assocation. e.g. /anno This a comment -> object | comment | self | This is a comment
    3. /anno "<concept>" <comment text> Creates an annotation using the provided concept and with a comment association. e.g. /anno "Nanomia" this is a comment => Nanomia | comment | self | This is a comment

Deployment

Currently, only one instance of anno-slackbot should be run at a time. anno-slackbot can be run on any machine that supports Docker. It is recommended that you run them from a shore side server. Each ship has it's own docker image. Note that anno-slackbot must be able to communicate with M3/VARS services running on the ship of interest.

Testing

This docker container talks to services running on http://nexus.shore.mbari.org. If you can't view the home page at that location, it's unlikely this service will work. Annotations created by this service will be stored in the SQL Server databse on fog.shore.mbari.org. Fog runs a testing database, so any annotations created will be wiped within 24 hours. It's a safe place to play and test anno-slackbot without affecting production data.

docker run portal.shore.mbari.org:5000/test/anno-slackbot

Western Flyer

This docker container talks to services running on http://docker-wf.wf.mbari.org. If you can't view the home page at that location, it's unlikely this service will work. Annotations created by this service will be stored in the SQL Server database on alaskanwind.wf.mbari.org

docker run portal.shore.mbari.org:5000/wf/anno-slackbot

Rachel Carson

This docker container talks to services running on http://docker-rc.rc.mbari.org. If you can't view the home page at that location, it's unlikely this service will work. Annotations created by this service will be stored in the SQL Server database on glacierwind.rc.mbari.org

docker run portal.shore.mbari.org:5000/rc/anno-slackbot