tools/staticdocs/docs/getting-started/key_concepts.html in openc3-cosmos-tool-docs-5.17.1 vs tools/staticdocs/docs/getting-started/key_concepts.html in openc3-cosmos-tool-docs-5.18.0

- old
+ new

@@ -1,45 +1,45 @@ <!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/key_concepts" data-has-hydrated="false"> <head> <meta charset="UTF-8"> -<meta name="generator" content="Docusaurus v3.4.0"> -<title data-rh="true">Key Concepts | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Key Concepts | OpenC3 Docs"><meta data-rh="true" name="description" content="Projects"><meta data-rh="true" property="og:description" content="Projects"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css"> -<script src="/tools/staticdocs/assets/js/runtime~main.2bb31799.js" defer="defer"></script> -<script src="/tools/staticdocs/assets/js/main.c2e2b617.js" defer="defer"></script> +<meta name="generator" content="Docusaurus v3.5.2"> +<title data-rh="true">Key Concepts | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Key Concepts | OpenC3 Docs"><meta data-rh="true" name="description" content="Projects"><meta data-rh="true" property="og:description" content="Projects"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css"> +<script src="/tools/staticdocs/assets/js/runtime~main.12d1e41d.js" defer="defer"></script> +<script src="/tools/staticdocs/assets/js/main.b5390098.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> -<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Key Concepts</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><h1 id="openc3-cosmos-key-concepts">OpenC3 COSMOS Key Concepts</h1> -<h2 id="projects">Projects</h2> -<p>The main COSMOS <a href="https://github.com/OpenC3/cosmos">repo</a> contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS <a href="https://github.com/OpenC3/cosmos-project">project</a> to launch COSMOS. The project consists of the <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh">openc3.sh</a> and <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat">openc3.bat</a> files for starting and stopping COSMOS, the <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml">compose.yaml</a> for configuring the COSMOS containers, and the <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env">.env</a> file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik.</p> -<h2 id="containerization">Containerization</h2> -<h3 id="images">Images</h3> -<p>Per <a href="https://docs.docker.com/get-started/overview/#images">Docker</a>, &quot;An image is a read-only template with instructions for creating a Docker container.&quot; The base operating system COSMOS uses is called <a href="https://www.alpinelinux.org/">Alpine Linux</a>. It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a <a href="https://docs.docker.com/engine/reference/builder/">Dockerfile</a> to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend.</p> -<h3 id="containers">Containers</h3> -<p>Per <a href="https://www.docker.com/resources/what-container/">Docker</a>, &quot;a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another.&quot; Also per <a href="https://docs.docker.com/guides/walkthroughs/what-is-a-container/">Docker</a>, &quot;A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.&quot; COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.</p> +<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Key Concepts</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>OpenC3 COSMOS Key Concepts</h1></header> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="projects">Projects<a href="#projects" class="hash-link" aria-label="Direct link to Projects" title="Direct link to Projects">​</a></h2> +<p>The main COSMOS <a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer">repo</a> contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS <a href="https://github.com/OpenC3/cosmos-project" target="_blank" rel="noopener noreferrer">project</a> to launch COSMOS. The project consists of the <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh" target="_blank" rel="noopener noreferrer">openc3.sh</a> and <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat" target="_blank" rel="noopener noreferrer">openc3.bat</a> files for starting and stopping COSMOS, the <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> for configuring the COSMOS containers, and the <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik.</p> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="containerization">Containerization<a href="#containerization" class="hash-link" aria-label="Direct link to Containerization" title="Direct link to Containerization">​</a></h2> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="images">Images<a href="#images" class="hash-link" aria-label="Direct link to Images" title="Direct link to Images">​</a></h3> +<p>Per <a href="https://docs.docker.com/get-started/overview/#images" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;An image is a read-only template with instructions for creating a Docker container.&quot; The base operating system COSMOS uses is called <a href="https://www.alpinelinux.org/" target="_blank" rel="noopener noreferrer">Alpine Linux</a>. It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a <a href="https://docs.docker.com/engine/reference/builder/" target="_blank" rel="noopener noreferrer">Dockerfile</a> to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="containers">Containers<a href="#containers" class="hash-link" aria-label="Direct link to Containers" title="Direct link to Containers">​</a></h3> +<p>Per <a href="https://www.docker.com/resources/what-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another.&quot; Also per <a href="https://docs.docker.com/guides/walkthroughs/what-is-a-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.&quot; COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.</p> <p>The COSMOS Open Source containers consist of the following:</p> -<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-openc3-cosmos-init-1</td><td>Copies files to Minio and configures COSMOS then exits</td></tr><tr><td>cosmos-openc3-operator-1</td><td>Main COSMOS container that runs the interfaces and target mircoservices</td></tr><tr><td>cosmos-openc3-cosmos-cmd-tlm-api-1</td><td>Rails server that provides all the COSMOS API endpoints</td></tr><tr><td>cosmos-openc3-cosmos-script-runner-api-1</td><td>Rails server that provides the Script API endpoints</td></tr><tr><td>cosmos-openc3-redis-1</td><td>Serves the static target configuration</td></tr><tr><td>cosmos-openc3-redis-ephemeral-1</td><td>Serves the <a href="https://redis.io/docs/data-types/streams">streams</a> containing the raw and decomutated data</td></tr><tr><td>cosmos-openc3-minio-1</td><td>Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files</td></tr><tr><td>cosmos-openc3-traefik-1</td><td>Provides a reverse proxy and load balancer with routes to the COSMOS endpoints</td></tr></tbody></table> -<p>The container list for <a href="https://openc3.com/enterprise">Enterprise COSMOS</a> consists of the following:</p> +<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-openc3-cosmos-init-1</td><td>Copies files to Minio and configures COSMOS then exits</td></tr><tr><td>cosmos-openc3-operator-1</td><td>Main COSMOS container that runs the interfaces and target mircoservices</td></tr><tr><td>cosmos-openc3-cosmos-cmd-tlm-api-1</td><td>Rails server that provides all the COSMOS API endpoints</td></tr><tr><td>cosmos-openc3-cosmos-script-runner-api-1</td><td>Rails server that provides the Script API endpoints</td></tr><tr><td>cosmos-openc3-redis-1</td><td>Serves the static target configuration</td></tr><tr><td>cosmos-openc3-redis-ephemeral-1</td><td>Serves the <a href="https://redis.io/docs/data-types/streams" target="_blank" rel="noopener noreferrer">streams</a> containing the raw and decomutated data</td></tr><tr><td>cosmos-openc3-minio-1</td><td>Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files</td></tr><tr><td>cosmos-openc3-traefik-1</td><td>Provides a reverse proxy and load balancer with routes to the COSMOS endpoints</td></tr></tbody></table> +<p>The container list for <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">Enterprise COSMOS</a> consists of the following:</p> <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-enterprise-openc3-metrics-1</td><td>Rails server that provides metrics on COSMOS performance</td></tr><tr><td>cosmos-enterprise-openc3-keycloak-1</td><td>Single-Sign On service for authentication</td></tr><tr><td>cosmos-enterprise-openc3-postgresql-1</td><td>SQL Database for use by Keycloak</td></tr><tr><td>openc3-nfs *</td><td>Network File System pod only for use in Kubernetes to share code libraries between containers</td></tr></tbody></table> -<h3 id="docker-compose">Docker Compose</h3> -<p>Per <a href="https://docs.docker.com/compose/">Docker</a>, &quot;Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application&#x27;s services. Then, with a single command, you create and start all the services from your configuration.&quot; OpenC3 uses compose files to both build and run COSMOS. The <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml">compose.yaml</a> is where ports are exposed and environment variables are used.</p> -<h3 id="environment-file">Environment File</h3> -<p>COSMOS uses an <a href="https://docs.docker.com/compose/environment-variables/env-file/">environment file</a> along with Docker Compose to pass environment variables into the COSMOS runtime. This <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env">.env</a> file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more.</p> -<h3 id="kubernetes">Kubernetes</h3> -<p>Per <a href="https://kubernetes.io/">Kubernetes.io</a>, &quot;Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery.&quot; <a href="https://openc3.com/enterprise">COSMOS Enterprise</a> provides <a href="https://helm.sh/docs/topics/charts/">Helm charts</a> for easy deployment to Kubernetes in various cloud environments.</p> -<p>COSMOS Enterprise also provides <a href="https://www.terraform.io/">Terraform</a> scripts to deploy COSMOS infrastructure on various cloud environments.</p> -<h2 id="frontend">Frontend</h2> -<h3 id="vuejs">Vue.js</h3> -<p>The COSMOS frontend is fully browser native and is implented in the Vue.js framework. Per <a href="https://vuejs.org/guide/introduction.html">Vue.js</a>, &quot;Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex.&quot; COSMOS utilizes Vue.js and the <a href="https://vuetifyjs.com/en/">Vuetify</a> Component Framework UI library to build all the COSMOS tools which run in the browser of your choice.</p> -<h3 id="single-spa">Single-Spa</h3> -<p>While COSMOS itself is written in Vue.js, we utilize a technology called <a href="https://single-spa.js.org/">single-spa</a> to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelt, and Vue.</p> -<h3 id="astro-ux">Astro UX</h3> -<p>Per <a href="https://www.astrouxds.com/">AstroUXDS</a>, &quot;The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices.&quot; COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. <a href="https://www.astrouxds.com/components/clock/">Astro Clock</a>, COSMOS directly incorporates Astro components.</p> -<h2 id="backend">Backend</h2> -<h3 id="redis">Redis</h3> -<p><a href="https://redis.io/">Redis</a> is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our <a href="/docs/getting-started/key_concepts#containers">container list</a> you&#x27;ll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into <a href="https://redis.io/docs/data-types/streams/">Redis streams</a>. The other redis container contains COSMOS configuration that is meant to persist. <a href="https://openc3.com/enterprise">COSMOS Enterprise</a> provides helm charts that setup <a href="https://redis.io/docs/management/scaling/">Redis Cluster</a> to perform horizontal scaling where data is shared across multiple Redis nodes.</p> -<h3 id="minio">MinIO</h3> -<p><a href="https://min.io/">MinIO</a> is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. <a href="https://openc3.com/enterprise">COSMOS Enterprise</a> deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don&#x27;t need to deploy Tomcat or Nginx for example.</p> -<h3 id="ruby-on-rails">Ruby on Rails</h3> -<p>The COSMOS API and Script Runner backends are powered by <a href="https://rubyonrails.org/">Ruby on Rails</a>. Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/key_concepts.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/upgrading"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrading</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/requirements"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Requirements and Design</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#projects">Projects</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#containerization">Containerization</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#images">Images</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#containers">Containers</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#docker-compose">Docker Compose</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#environment-file">Environment File</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#kubernetes">Kubernetes</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#frontend">Frontend</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#vuejs">Vue.js</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#single-spa">Single-Spa</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#astro-ux">Astro UX</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#backend">Backend</a><ul><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#redis">Redis</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#minio">MinIO</a></li><li><a class="table-of-contents__link toc-highlight" href="/tools/staticdocs/docs/getting-started/key_concepts#ruby-on-rails">Ruby on Rails</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="docker-compose">Docker Compose<a href="#docker-compose" class="hash-link" aria-label="Direct link to Docker Compose" title="Direct link to Docker Compose">​</a></h3> +<p>Per <a href="https://docs.docker.com/compose/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application&#x27;s services. Then, with a single command, you create and start all the services from your configuration.&quot; OpenC3 uses compose files to both build and run COSMOS. The <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> is where ports are exposed and environment variables are used.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="environment-file">Environment File<a href="#environment-file" class="hash-link" aria-label="Direct link to Environment File" title="Direct link to Environment File">​</a></h3> +<p>COSMOS uses an <a href="https://docs.docker.com/compose/environment-variables/env-file/" target="_blank" rel="noopener noreferrer">environment file</a> along with Docker Compose to pass environment variables into the COSMOS runtime. This <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="kubernetes">Kubernetes<a href="#kubernetes" class="hash-link" aria-label="Direct link to Kubernetes" title="Direct link to Kubernetes">​</a></h3> +<p>Per <a href="https://kubernetes.io/" target="_blank" rel="noopener noreferrer">Kubernetes.io</a>, &quot;Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery.&quot; <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides <a href="https://helm.sh/docs/topics/charts/" target="_blank" rel="noopener noreferrer">Helm charts</a> for easy deployment to Kubernetes in various cloud environments.</p> +<p>COSMOS Enterprise also provides <a href="https://www.terraform.io/" target="_blank" rel="noopener noreferrer">Terraform</a> scripts to deploy COSMOS infrastructure on various cloud environments.</p> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="frontend">Frontend<a href="#frontend" class="hash-link" aria-label="Direct link to Frontend" title="Direct link to Frontend">​</a></h2> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="vuejs">Vue.js<a href="#vuejs" class="hash-link" aria-label="Direct link to Vue.js" title="Direct link to Vue.js">​</a></h3> +<p>The COSMOS frontend is fully browser native and is implented in the Vue.js framework. Per <a href="https://vuejs.org/guide/introduction.html" target="_blank" rel="noopener noreferrer">Vue.js</a>, &quot;Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex.&quot; COSMOS utilizes Vue.js and the <a href="https://vuetifyjs.com/en/" target="_blank" rel="noopener noreferrer">Vuetify</a> Component Framework UI library to build all the COSMOS tools which run in the browser of your choice.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="single-spa">Single-Spa<a href="#single-spa" class="hash-link" aria-label="Direct link to Single-Spa" title="Direct link to Single-Spa">​</a></h3> +<p>While COSMOS itself is written in Vue.js, we utilize a technology called <a href="https://single-spa.js.org/" target="_blank" rel="noopener noreferrer">single-spa</a> to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelt, and Vue.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="astro-ux">Astro UX<a href="#astro-ux" class="hash-link" aria-label="Direct link to Astro UX" title="Direct link to Astro UX">​</a></h3> +<p>Per <a href="https://www.astrouxds.com/" target="_blank" rel="noopener noreferrer">AstroUXDS</a>, &quot;The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices.&quot; COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. <a href="https://www.astrouxds.com/components/clock/" target="_blank" rel="noopener noreferrer">Astro Clock</a>, COSMOS directly incorporates Astro components.</p> +<h2 class="anchor anchorWithStickyNavbar_fF9Z" id="backend">Backend<a href="#backend" class="hash-link" aria-label="Direct link to Backend" title="Direct link to Backend">​</a></h2> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="redis">Redis<a href="#redis" class="hash-link" aria-label="Direct link to Redis" title="Direct link to Redis">​</a></h3> +<p><a href="https://redis.io/" target="_blank" rel="noopener noreferrer">Redis</a> is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our <a href="/tools/staticdocs/docs/getting-started/key_concepts#containers">container list</a> you&#x27;ll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into <a href="https://redis.io/docs/data-types/streams/" target="_blank" rel="noopener noreferrer">Redis streams</a>. The other redis container contains COSMOS configuration that is meant to persist. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides helm charts that setup <a href="https://redis.io/docs/management/scaling/" target="_blank" rel="noopener noreferrer">Redis Cluster</a> to perform horizontal scaling where data is shared across multiple Redis nodes.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="minio">MinIO<a href="#minio" class="hash-link" aria-label="Direct link to MinIO" title="Direct link to MinIO">​</a></h3> +<p><a href="https://min.io/" target="_blank" rel="noopener noreferrer">MinIO</a> is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don&#x27;t need to deploy Tomcat or Nginx for example.</p> +<h3 class="anchor anchorWithStickyNavbar_fF9Z" id="ruby-on-rails">Ruby on Rails<a href="#ruby-on-rails" class="hash-link" aria-label="Direct link to Ruby on Rails" title="Direct link to Ruby on Rails">​</a></h3> +<p>The COSMOS API and Script Runner backends are powered by <a href="https://rubyonrails.org/" target="_blank" rel="noopener noreferrer">Ruby on Rails</a>. Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/key_concepts.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/upgrading"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrading</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/requirements"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Requirements and Design</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#projects" class="table-of-contents__link toc-highlight">Projects</a></li><li><a href="#containerization" class="table-of-contents__link toc-highlight">Containerization</a><ul><li><a href="#images" class="table-of-contents__link toc-highlight">Images</a></li><li><a href="#containers" class="table-of-contents__link toc-highlight">Containers</a></li><li><a href="#docker-compose" class="table-of-contents__link toc-highlight">Docker Compose</a></li><li><a href="#environment-file" class="table-of-contents__link toc-highlight">Environment File</a></li><li><a href="#kubernetes" class="table-of-contents__link toc-highlight">Kubernetes</a></li></ul></li><li><a href="#frontend" class="table-of-contents__link toc-highlight">Frontend</a><ul><li><a href="#vuejs" class="table-of-contents__link toc-highlight">Vue.js</a></li><li><a href="#single-spa" class="table-of-contents__link toc-highlight">Single-Spa</a></li><li><a href="#astro-ux" class="table-of-contents__link toc-highlight">Astro UX</a></li></ul></li><li><a href="#backend" class="table-of-contents__link toc-highlight">Backend</a><ul><li><a href="#redis" class="table-of-contents__link toc-highlight">Redis</a></li><li><a href="#minio" class="table-of-contents__link toc-highlight">MinIO</a></li><li><a href="#ruby-on-rails" class="table-of-contents__link toc-highlight">Ruby on Rails</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div> </body> </html> \ No newline at end of file