Skip to content

scottbell/openmct-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Aug 20, 2024
73360a4 · Aug 20, 2024

History

36 Commits
Jan 19, 2024
Dec 8, 2023
Jan 25, 2024
Aug 20, 2024
Aug 20, 2024
Jun 20, 2023
Jan 8, 2024
Nov 13, 2023

Repository files navigation

Open MCT QuickStart

This repository contains a quick way to get started with Open MCT, integrated with:

Prerequisites

Getting Started

  1. Clone this repository
  2. cd to the repository directory (usually openmct-quickstart)
  3. Run docker compose up
  4. Wait a bit for the containers to start ⏱️
  5. Open a browser to http://localhost:8040
  6. Enter the username/password testuser/NasaIsCool!

Nuts and Bolts

The docker-compose.yml file in this repository defines a set of containers that work together to provide a complete Open MCT environment. The containers are:

  • openmct - Builds the Open MCT web application into a shared volume (and quits)
  • couchdb - The CouchDB database used by Open MCT to persist objects created by the operator.
  • yamcs - The YAMCS telemetry & commanding server used by Open MCT to retrieve telemetry data.
  • simulator - A simple python simulator that generates telemetry data for YAMCS to serve.
  • apache - The Apache HTTP server used to serve the Open MCT web application, and to proxy requests to YAMCS and CouchDB.

Hosted websites are available at the following URLs:

Diagram

Loading
graph TD
    A[Apache HTTP Server] -- serves --> B[Open MCT Web Application]
    A -- proxies --> C[CouchDB Database]
    A -- proxies --> D[YAMCS Telemetry & Commanding Server]
    E[Python Simulator] -- generates telemetry data --> D
    F[Docker Compose] -- orchestrates --> A
    F -- orchestrates --> B
    F -- orchestrates --> C
    F -- orchestrates --> D
    F -- orchestrates --> E

    B -- "HTTP Traffic & JSON Storage" --> C
    D -- "HTTP Traffic & JSON Storage" --> B

    click B "http://localhost:8040" "OpenMCT Web Application"
    click C "http://localhost:8040/couchdb/_utils" "CouchDB"
    click D "http://localhost:8040/yamcs" "YAMCS"
    click A "http://localhost:8040/server-status" "Apache Server Status"