openc3-cosmos-tool-docs 6.9.1 → 6.9.2

data/tools/staticdocs/assets/js/75e64983.180a00e7.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["1885"],{5574:function(e,n,o){o.r(n),o.d(n,{frontMatter:()=>r,toc:()=>l,default:()=>h,metadata:()=>t,assets:()=>a,contentTitle:()=>c});var t=JSON.parse('{"id":"getting-started/upgrading","title":"Upgrading","description":"How to upgrade and migrate COSMOS","source":"@site/docs/getting-started/upgrading.md","sourceDirName":"getting-started","slug":"/getting-started/upgrading","permalink":"/tools/staticdocs/docs/getting-started/upgrading","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Upgrading","description":"How to upgrade and migrate COSMOS","sidebar_custom_props":{"myEmoji":"\u2B06\uFE0F"}},"sidebar":"defaultSidebar","previous":{"title":"Getting Started","permalink":"/tools/staticdocs/docs/getting-started/gettingstarted"},"next":{"title":"Command Line Interface","permalink":"/tools/staticdocs/docs/getting-started/cli"}}'),s=o(7259),i=o(5511);let r={sidebar_position:4,title:"Upgrading",description:"How to upgrade and migrate COSMOS",sidebar_custom_props:{myEmoji:"\u2B06\uFE0F"}},c,a={},l=[{value:"COSMOS Upgrades",id:"cosmos-upgrades",level:2},{value:"Upgrade Migration Process",id:"upgrade-migration-process",level:3},{value:"Migrating From COSMOS 5 to COSMOS 6",id:"migrating-from-cosmos-5-to-cosmos-6",level:2},{value:"Updating Vue",id:"updating-vue",level:3},{value:"The quick and dirty way",id:"the-quick-and-dirty-way",level:4},{value:"Step 1: Vue compat mode",id:"step-1-vue-compat-mode",level:4},{value:"(1.a) Update dependencies",id:"1a-update-dependencies",level:5},{value:"(1.b) Update the Vue config file (<code>vue.config.js</code>)",id:"1b-update-the-vue-config-file-vueconfigjs",level:5},{value:"(1.c) Update the eslint config file (<code>.eslintrc</code>)",id:"1c-update-the-eslint-config-file-eslintrc",level:5},{value:"(1.d) Fix build and runtime warnings and errors",id:"1d-fix-build-and-runtime-warnings-and-errors",level:5},{value:"Step 2: Bump compat mode from 2 to 3",id:"step-2-bump-compat-mode-from-2-to-3",level:4},{value:"Step 3: Update Vuetify",id:"step-3-update-vuetify",level:4},{value:"Step 4: Clean up",id:"step-4-clean-up",level:4},{value:"Migrating to the new OpenC3 common packages",id:"migrating-to-the-new-openc3-common-packages",level:3},{value:"Step 1: Update dependencies",id:"step-1-update-dependencies",level:4},{value:"Step 2: Update imports in your code",id:"step-2-update-imports-in-your-code",level:4},{value:"<code>@openc3/js-common</code>",id:"openc3js-common",level:4},{value:"<code>@openc3/vue-common</code>",id:"openc3vue-common",level:4},{value:"Migrating From COSMOS 4 to COSMOS 5",id:"migrating-from-cosmos-4-to-cosmos-5",level:2},{value:"Configuration Migration Tool",id:"configuration-migration-tool",level:3},{value:"Upgrading Custom Tools",id:"upgrading-custom-tools",level:3}];function d(e){let n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components},{TabItem:o,Tabs:t}=n;return o||p("TabItem",!0),t||p("Tabs",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"cosmos-upgrades",children:"COSMOS Upgrades"}),"\n",(0,s.jsx)(n.p,{children:"OpenC3 releases new versions of COSMOS on a monthy or better cadence. This is done for several reasons: to incorporate new features, fix existing bugs, update dependencies, and close CVEs. We extensively test each release at both the unit level, API level, and system level using Playwright against a deployed COSMOS. Thus we recommend upgrading COSMOS as quickly as possible when new releases become available. While COSMOS itself is tested extensively, we obviously can not test against customer plugins and custom deployments. We recommend having another installation of COSMOS which you can upgrade with your own plugins and verify functionality before upgrading your production environment."}),"\n",(0,s.jsx)(n.p,{children:"COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, apply the upgrade, and run the new release."}),"\n",(0,s.jsx)(n.admonition,{title:"Release Notes",type:"info",children:(0,s.jsxs)(n.p,{children:["Always check the release notes associated with the release on the ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases",children:"releases"})," page. Sometimes there are migration notes. When upgrading older versions, be sure to upgrade to first 5.13.0 and then 6.0.0 before proceeding. See ",(0,s.jsx)(n.a,{href:"https://docs.openc3.com/docs/getting-started/upgrading#upgrade-migration-process",children:"Upgrade Migration Process"})," for more information."]})}),"\n",(0,s.jsxs)(n.p,{children:["This example assumes an existing COSMOS project at ",(0,s.jsx)(n.code,{children:"cosmos-project"}),". This should first be performed on a non-production machine that has the same set of plugins as your production system."]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"Stop the current COSMOS application"}),"\n"]}),"\n",(0,s.jsxs)(t,{groupId:"script-language",children:[(0,s.jsx)(o,{value:"linux",label:"Linux",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cosmos-project % ./openc3.sh stop\n"})})}),(0,s.jsx)(o,{value:"windows",label:"Windows",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat stop\n"})})})]}),"\n",(0,s.jsxs)(n.admonition,{title:"Upgrade is new since v6.7.0",type:"info",children:[(0,s.jsxs)(n.p,{children:["Before version 6.7.0 the COSMOS cli did not have an upgrade option. If you are on a version prior to COSMOS 6.7.0, manually download the ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/scripts/linux/openc3_upgrade.sh",children:(0,s.jsx)(n.code,{children:"openc3_upgrade.sh"})})," or ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-project/blob/main/scripts/windows/openc3_upgrade.bat",children:(0,s.jsx)(n.code,{children:"openc3_upgrade.bat"})})," script and put it at the base of your COSMOS project."]}),(0,s.jsxs)(n.p,{children:["For step by step instructions see our ",(0,s.jsx)(n.a,{href:"https://youtu.be/Z3o1RACKE74?si=ngoo9tmrmB2O2OgC",children:"COSMOS Upgrade"})," video on our ",(0,s.jsx)(n.a,{href:"https://www.youtube.com/@openc3",children:"YouTube Channel"}),"."]}),(0,s.jsxs)(t,{groupId:"script-language",children:[(0,s.jsx)(o,{value:"linux",label:"Linux",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cosmos-project % chmod +x openc3_upgrade.sh\ncosmos-project % ./openc3_upgrade.sh\n"})})}),(0,s.jsx)(o,{value:"windows",label:"Windows",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3_upgrade.bat\n"})})})]})]}),"\n",(0,s.jsxs)(n.ol,{start:"2",children:["\n",(0,s.jsx)(n.li,{children:"Apply the upgrade to version vX.Y.Z (e.g. v6.7.0). Note the 'v' because this is a git tag."}),"\n"]}),"\n",(0,s.jsxs)(t,{groupId:"script-language",children:[(0,s.jsx)(o,{value:"linux",label:"Linux",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cosmos-project % ./openc3.sh upgrade vX.Y.Z\n"})})}),(0,s.jsx)(o,{value:"windows",label:"Windows",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat upgrade vX.Y.Z\n"})})})]}),"\n",(0,s.jsxs)(n.ol,{start:"3",children:["\n",(0,s.jsx)(n.li,{children:"Run the new COSMOS version"}),"\n"]}),"\n",(0,s.jsxs)(t,{groupId:"script-language",children:[(0,s.jsx)(o,{value:"linux",label:"Linux",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cosmos-project % ./openc3.sh run\n"})})}),(0,s.jsx)(o,{value:"windows",label:"Windows",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\cosmos-project> openc3.bat run\n"})})})]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Test the new COSMOS version. Ensure your plugins start without errors. Verify you can graph or export data from before the upgrade. Perhaps run some of your scripts in disconnect mode."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Commit the changes to the project"}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(t,{groupId:"script-language",children:[(0,s.jsx)(o,{value:"linux",label:"Linux",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'cosmos-project % git add .\ncosmos-project % git commit -m "Upgrade to vX.Y.Z"\n'})})}),(0,s.jsx)(o,{value:"windows",label:"Windows",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:'C:\\cosmos-project> git add .\nC:\\cosmos-project> git commit -m "Upgrade to vX.Y.Z"\n'})})})]}),"\n",(0,s.jsxs)(n.ol,{start:"6",children:["\n",(0,s.jsx)(n.li,{children:"Update the production system by stopping, pulling the new changes, and starting."}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"upgrade-migration-process",children:"Upgrade Migration Process"}),"\n",(0,s.jsxs)(n.p,{children:["COSMOS doesn't use strict ",(0,s.jsx)(n.a,{href:"https://semver.org/",children:"semantic versioning"})," for our releases. Our major releases (5.0.0, 6.0.0, etc) are for major architectural changes and backward incompatibilities. Minor releases (6.1.0, 6.2.0, etc) add functionality but can also modify our configuration files. Thus certain minor releases are more important than others when skipping releases."]}),"\n",(0,s.jsx)(n.p,{children:"The following table identifies key release milestones which changed the COSMOS project configuration files (.env, compose.yaml, traefik, etc)."}),"\n",(0,s.jsxs)(n.p,{children:["Versions 5.13.0 and 6.0.0 ",(0,s.jsx)(n.em,{children:"REQUIRE"})," a stop to evaluate the upgrade. Thus if you're currently at 5.9.0 you must first upgrade to 5.13.0, then 6.0.0, then to the latest."]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Version"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Summary"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["*",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v5.13.0",children:"5.13.0"}),"*"]}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["Breaking change to non-root containers and renamed minio volume. Requires running the ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-project/blob/v5.13.0.0/migrate_5_12_to_5_13.sh",children:"Core migration shell script"})," / ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-project/blob/v5.13.0.0/migrate_5_12_to_5_13.bat",children:"Core migration batch file"})," or ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-enterprise-project/blob/v5.13.0.0/migrate_5_12_to_5_13_enterprise.sh",children:"Enterprise migration shell script"})," / ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos-enterprise-project/blob/v5.13.0.0/migrate_5_12_to_5_13_enterprise.bat",children:"Enterprise migration batch file"})," to preserve previous data.",(0,s.jsx)("br",{}),(0,s.jsx)("br",{}),"NOTE: Read the script! The You must set ",(0,s.jsx)(n.code,{children:"GITHUB_PAT"})," in Enterprise or simply comment out the lines with ",(0,s.jsx)(n.code,{children:"GITHUB_PAT"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v5.15.0",children:"5.15.0"})}),(0,s.jsx)(n.td,{style:{textAlign:"left"},children:"The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["*",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v6.0.0",children:"6.0.0"}),"*"]}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["Upgrade to Vue 3 and Vuetify 3 requires custom GUI tools to follow the ",(0,s.jsx)(n.a,{href:"upgrading#migrating-from-cosmos-5-to-cosmos-6",children:"COSMOS 6 migration guide"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v6.1.0",children:"6.1.0"})}),(0,s.jsx)(n.td,{style:{textAlign:"left"},children:"Changed from ActionCable to AnyCable. We also broke apart the COSMOS helm charts from a single chart to 3 charts."})]})]})]}),"\n",(0,s.jsxs)(n.admonition,{title:"Downgrades",type:"warning",children:[(0,s.jsx)(n.p,{children:"Downgrades are not necessarily supported. When upgrading COSMOS we need to upgrade databases and sometimes migrate internal data structures. While we perform a full regression test on every release, we recommend upgrading an individual machine with your specific plugins and do local testing before rolling out the upgrade to your production system."}),(0,s.jsxs)(n.p,{children:["In general, patch releases (x.y.Z) can be downgraded, minor releases (x.Y.z) ",(0,s.jsx)(n.em,{children:"might"})," be able to be downgraded and major releases (X.y.z) are NOT able to be downgraded."]})]}),"\n",(0,s.jsx)(n.h2,{id:"migrating-from-cosmos-5-to-cosmos-6",children:"Migrating From COSMOS 5 to COSMOS 6"}),"\n",(0,s.jsx)(n.admonition,{title:"Developers Only",type:"info",children:(0,s.jsx)(n.p,{children:"If you haven't written any custom tools or widgets, there are no special changes required to upgrade from COSMOS 5 to COSMOS 6 other than updating your traefik configuration file. Simply follow the normal upgrade instructions above."})}),"\n",(0,s.jsxs)(n.p,{children:["COSMOS 6 introduces some breaking changes for custom tools regarding the Vue framework and our common library code. We've upgraded from Vue 2 (EOL December 31, 2023) to Vue 3. These versions of Vue are not compatible with each other, so any tools written with Vue 2 will need to be updated. Additionally, our ",(0,s.jsx)(n.code,{children:"@openc3/tool-common"})," NPM package has been deprecated with its functionality reorganized into two packages: ",(0,s.jsx)(n.code,{children:"@openc3/js-common"})," and ",(0,s.jsx)(n.code,{children:"@openc3/vue-common"}),". This is to provide a better experience for developers who are building COSMOS tools without the Vue framework."]}),"\n",(0,s.jsxs)(n.p,{children:["We also removed a few rarely used ",(0,s.jsx)(n.a,{href:"../guides/scripting-api#migration-from-cosmos-v5-to-v6",children:"API methods"})," in COSMOS 6."]}),"\n",(0,s.jsx)(n.h3,{id:"updating-vue",children:"Updating Vue"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"If your tool was not built with Vue (e.g. it was built without a frontend framework, or it was built with React, Angular, etc.), then you can skip this section."})}),"\n",(0,s.jsx)(n.h4,{id:"the-quick-and-dirty-way",children:"The quick and dirty way"}),"\n",(0,s.jsxs)(n.p,{children:["Tools that are relatively simple can probably be upgraded in one shot by just updating the dependencies and fixing any build errors that arise, and then fixing any runtime errors you find from testing and using your tool. If you're confident in this upgrade path, you can reference ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/pull/1747",children:"this pull request"})," to see what will need to change. Otherwise, the rest of this guide will walk you through a more in-depth and complete migration process."]}),"\n",(0,s.jsx)(n.h4,{id:"step-1-vue-compat-mode",children:"Step 1: Vue compat mode"}),"\n",(0,s.jsx)(n.p,{children:"The Vue team provided a compatibility mode to help with migrating from Vue 2 to Vue 3. This will let you get your tool up and running to make it easier to find the necessary changes."}),"\n",(0,s.jsx)(n.h5,{id:"1a-update-dependencies",children:"(1.a) Update dependencies"}),"\n",(0,s.jsx)(n.p,{children:'Use your package manager or edit the package.json file to update the following dependencies (ignore any packages marked "Update" that you aren\'t using)'}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Remove:"})," ",(0,s.jsx)(n.code,{children:"vue-template-compiler"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"@vue/compat"})," >= 3.5 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compat",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"@vue/compiler-sfc"})," >= 3.5 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compiler-sfc",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"@vue/test-utils"})," >= 2.4 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/@vue/compiler-sfc",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"vue"})," >= 3.5 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/vue",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"vuex"})," >= 4.1 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/vuex",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"vue-router"})," >= 4.4 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/vue-router",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"vuetify"})," >= 3.7 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/vuetify",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Update:"})," ",(0,s.jsx)(n.code,{children:"single-spa-vue"})," >= 3.0 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/single-spa-vue",children:"npmjs.com"}),")"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Eslint will help call out changes you'll need to make to your code for the migration, so it's recommended to include eslint in your project if you haven't already. There are plenty of guides online that will explain how to do that. If you're using eslint, then make the additional changes to your tool's dependencies:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"eslint-plugin-vuetify"})," >= 2.5 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/eslint-plugin-vuetify",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"vue-eslint-parser"})," >= 9.4 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/vue-eslint-parser",children:"npmjs.com"}),")"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["If you modified your package.json file manually, don't forget to ",(0,s.jsx)(n.code,{children:"pnpm install"})," at your project's root to apply the changes."]}),"\n",(0,s.jsxs)(n.h5,{id:"1b-update-the-vue-config-file-vueconfigjs",children:["(1.b) Update the Vue config file (",(0,s.jsx)(n.code,{children:"vue.config.js"}),")"]}),"\n",(0,s.jsxs)(n.p,{children:["You likely have a ",(0,s.jsx)(n.code,{children:"chainWebpack"})," property in the object that's exported by this file which looks something like this (though your contents might vary)"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"chainWebpack: (config) => {\n  config.module\n    .rule('vue')\n    .use('vue-loader')\n    .tap((options) => {\n      return {\n        prettify: false,\n      }\n    })\n},\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Add a resolution alias for ",(0,s.jsx)(n.code,{children:"@vue/compat"})," to the top of this block and set the compiler to use the Vue 2 compat mode:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"chainWebpack: (config) => {\n  config.resolve.alias.set('vue', '@vue/compat') // Add this line\n  config.module\n    .rule('vue')\n    .use('vue-loader')\n    .tap((options) => {\n      return {\n        prettify: false,\n        compilerOptions: { // Add this block\n          compatConfig: {  //\n            MODE: 2,       //\n          },               //\n        },                 // to here\n      }\n    })\n},\n"})}),"\n",(0,s.jsxs)(n.h5,{id:"1c-update-the-eslint-config-file-eslintrc",children:["(1.c) Update the eslint config file (",(0,s.jsx)(n.code,{children:".eslintrc"}),")"]}),"\n",(0,s.jsxs)(n.p,{children:["Find the string ",(0,s.jsx)(n.code,{children:"'plugin:vue/essential'"})," in your ",(0,s.jsx)(n.code,{children:"extends"})," block and change it to ",(0,s.jsx)(n.code,{children:"'plugin:vue/vue3-essential'"}),". If you don't have that plugin in your ",(0,s.jsx)(n.code,{children:"extends"})," block, or you're missing that block entirely, then add this. It will help find breaking changes in how your code is using the Vue API."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"extends: [\n  'plugin:vue/vue3-essential', // change this from plugin:vue/essential\n  'plugin:prettier/recommended',\n  '@vue/prettier',\n],\n"})}),"\n",(0,s.jsx)(n.h5,{id:"1d-fix-build-and-runtime-warnings-and-errors",children:"(1.d) Fix build and runtime warnings and errors"}),"\n",(0,s.jsxs)(n.p,{children:["Run your linting and build scripts (e.g. ",(0,s.jsx)(n.code,{children:"pnpm lint"})," and ",(0,s.jsx)(n.code,{children:"pnpm build"}),"). The eslint plugin and Vue's compat mode will find the first set of code changes you need to address. Fix these lint/build errors until your project builds successfully."]}),"\n",(0,s.jsxs)(n.p,{children:["Once it builds, run your project like you would for development. It's recommended to serve it from a local dev server with ",(0,s.jsx)(n.code,{children:"pnpm serve"})," and add it to the import map overrides in the browser. Test the functionality of your tool and address any Vue errors and warnings that get printed to the browser console in the dev tools. ",(0,s.jsxs)(n.em,{children:["(NOTE: On ",(0,s.jsx)(n.code,{children:"MODE: 2"})," - your first pass through this section - it's ok if your tool doesn't completely work yet. Just address the warnings and errors that are logged to the browser console. You'll get your tool completely working in the next step.)"]})]}),"\n",(0,s.jsxs)(n.p,{children:["From our experience migrating the COSMOS first-party tools, you'll most likely have to make changes to your ",(0,s.jsx)(n.code,{children:"main.js"})," and ",(0,s.jsx)(n.code,{children:"router.js"}),' files at a minimum. You can reference the PR mentioned above in the "The quick and dirty way" section above to see what we changed, or search the internet for Vue 2 -> Vue 3 migration guides if you need help addressing any warnings or errors.']}),"\n",(0,s.jsx)(n.h4,{id:"step-2-bump-compat-mode-from-2-to-3",children:"Step 2: Bump compat mode from 2 to 3"}),"\n",(0,s.jsxs)(n.p,{children:["Change the ",(0,s.jsx)(n.code,{children:"compatConfig"})," you added to your vue config file (",(0,s.jsx)(n.code,{children:"vue.config.js"}),") from ",(0,s.jsx)(n.code,{children:"MODE: 2"})," to ",(0,s.jsx)(n.code,{children:"MODE: 3"}),". This will tell Vue's compat mode that you've addressed the changes in the previous step, and it will find the next set of issues (since this is a multi-step process). Repeat the \"(1.d) Fix build and runtime warnings and errors\" step."]}),"\n",(0,s.jsx)(n.h4,{id:"step-3-update-vuetify",children:"Step 3: Update Vuetify"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"If you're not using Vuetify, you can skip this step."})}),"\n",(0,s.jsxs)(n.p,{children:["Modify your eslint config (",(0,s.jsx)(n.code,{children:".eslintrc"}),") again to add the Vuetify plugin:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"extends: [\n  'plugin:vue/vue3-essential',\n  'plugin:vuetify/base', // Add this line\n  'plugin:prettier/recommended',\n  '@vue/prettier',\n],\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Note:"})," The Vuetify eslint plugin is only designed for migrating projects from Vuetify 2 to Vuetify 3 and can cause linting performance issues, so it should be removed once your tool migration is complete."]}),"\n",(0,s.jsxs)(n.p,{children:["Again in ",(0,s.jsx)(n.code,{children:".eslintrc"}),", find your ",(0,s.jsx)(n.code,{children:"parserOptions"})," block and add the ",(0,s.jsx)(n.code,{children:"parser"})," property above it:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:"parser: 'vue-eslint-parser', // Add this line\nparserOptions: {\n  ...\n},\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Now when you run eslint, it can tell you about any changes you'll need to address regarding how your code is using the Vuetify API. To find these changes, run eslint on your Vue files (e.g. ",(0,s.jsx)(n.code,{children:"pnpm eslint . --ext .vue"}),"). You can address these manually, or if you trust eslint or have good version control, you can have the plugin fix most of them automatically with ",(0,s.jsx)(n.code,{children:"pnpm eslint . --ext .vue --fix"})]}),"\n",(0,s.jsxs)(n.p,{children:["Lastly, if you are using the Astro UXDS icons via Vuetify from COSMOS - or any custom icon packs for that matter - then you'll need to change their pack alias format from ",(0,s.jsx)(n.code,{children:"$packName-"})," to ",(0,s.jsx)(n.code,{children:"packName:"}),". Here's an example for the ",(0,s.jsx)(n.code,{children:"antenna-transmit"})," Astro icon:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-html",children:"\x3c!-- Vue 2 / Vuetify 2 (old) --\x3e\n<v-icon> $astro-antenna-transmit </v-icon>\n\n\x3c!-- Vue 3 / Vuetify 3 (new) --\x3e\n<v-icon> astro:antenna-transmit </v-icon>\n"})}),"\n",(0,s.jsx)(n.h4,{id:"step-4-clean-up",children:"Step 4: Clean up"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Remove the ",(0,s.jsx)(n.code,{children:"@vue/compat"})," and ",(0,s.jsx)(n.code,{children:"eslint-plugin-vuetify"})," dependencies you added in step 1.a"]}),"\n",(0,s.jsxs)(n.li,{children:["Remove the ",(0,s.jsx)(n.code,{children:"compatConfig"})," you added in step 1.b"]}),"\n",(0,s.jsxs)(n.li,{children:["Remove the ",(0,s.jsx)(n.code,{children:"'plugin:vuetify/base'"})," you added in step 3"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"migrating-to-the-new-openc3-common-packages",children:"Migrating to the new OpenC3 common packages"}),"\n",(0,s.jsxs)(n.p,{children:["As mentioned in the first paragraph of this guide, we've deprecated the ",(0,s.jsx)(n.code,{children:"@openc3/tool-common"})," NPM package. All of its functionality has remained the same, but everything is organized differently, so you'll have to update your dependencies and imports."]}),"\n",(0,s.jsx)(n.h4,{id:"step-1-update-dependencies",children:"Step 1: Update dependencies"}),"\n",(0,s.jsx)(n.p,{children:"Use your package manager or edit the package.json file to update the following dependencies"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Remove:"})," ",(0,s.jsx)(n.code,{children:"@openc3/tool-common"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"@openc3/js-common"})," >= 6.0 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/@openc3/js-common",children:"npmjs.com"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Add:"})," ",(0,s.jsx)(n.code,{children:"@openc3/vue-common"})," >= 6.0 (",(0,s.jsx)(n.a,{href:"https://www.npmjs.com/package/@openc3/vue-common",children:"npmjs.com"}),")","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"This is only needed if you are using our Vue stuff (components, plugins, etc.)"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"step-2-update-imports-in-your-code",children:"Step 2: Update imports in your code"}),"\n",(0,s.jsxs)(n.p,{children:["In COSMOS 5, things were imported directly from ",(0,s.jsx)(n.code,{children:"@openc3/tool-common"}),"'s ",(0,s.jsx)(n.code,{children:"src"})," directory and subsequently built into your tool by your build process. Everything in COSMOS 6 is now exported through several top-level exports in our new common packages. In general, the pattern is as follows:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["COSMOS 5: ",(0,s.jsx)(n.code,{children:"import bar from '@openc3/tool-common/src/foo/bar'"})]}),"\n",(0,s.jsxs)(n.li,{children:["COSMOS 6: ",(0,s.jsx)(n.code,{children:"import { bar } from '@openc3/vue-common/foo'"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["This pattern also lets you combine multiple import statements into one (e.g. ",(0,s.jsx)(n.code,{children:"import { bar, baz } from '@openc3/vue-common/foo'"}),")."]}),"\n",(0,s.jsx)(n.p,{children:"There are three exceptions to this pattern:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Widgets are no longer under the ",(0,s.jsx)(n.code,{children:"components"})," directory but instead get their own top-level export","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Old: ",(0,s.jsx)(n.code,{children:"import foo from '@openc3/tool-common/src/components/widgets/Foo"})]}),"\n",(0,s.jsxs)(n.li,{children:["New: ",(0,s.jsx)(n.code,{children:"import { foo } from '@openc3/vue-common/widgets"})]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Icons got the same treatment","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Old: ",(0,s.jsx)(n.code,{children:"import bar from '@openc3/tool-common/src/components/icons/Bar"})]}),"\n",(0,s.jsxs)(n.li,{children:["New: ",(0,s.jsx)(n.code,{children:"import { bar } from '@openc3/vue-common/icons"})]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["The ",(0,s.jsx)(n.code,{children:"TimeFilters"})," mixin was moved from ",(0,s.jsx)(n.code,{children:"tools/base"})," to ",(0,s.jsx)(n.code,{children:"util"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Old: ",(0,s.jsx)(n.code,{children:"import TimeFilters from '@openc3/tool-common/src/tools/base/util/timeFilters"})]}),"\n",(0,s.jsxs)(n.li,{children:["New: ",(0,s.jsx)(n.code,{children:"import { TimeFilters } from '@openc3/vue-common/util"})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openc3js-common",children:(0,s.jsx)(n.code,{children:"@openc3/js-common"})}),"\n",(0,s.jsxs)(n.p,{children:["This package contains things previously under ",(0,s.jsx)(n.code,{children:"@openc3/tool-common/src/services"}),". Anything not from that path will be in the ",(0,s.jsx)(n.code,{children:"vue-common"})," package discussed below."]}),"\n",(0,s.jsx)(n.p,{children:"Update any of your imports from that path accordingly. Here's an example:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'// COSMOS 5 (old)\nimport Api from "@openc3/tool-common/src/services/api";\nimport Cable from "@openc3/tool-common/src/services/cable";\nimport { OpenC3Api } from "@openc3/tool-common/src/services/openc3Api";\n\n// COSMOS 6 (new)\nimport { Api, Cable, OpenC3Api } from "@openc3/js-common/services";\n'})}),"\n",(0,s.jsx)(n.p,{children:"This package also provides a couple more top-level imports which you likely will not need, but they might be useful, so I'll call them out here:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"import { prependBasePath } from '@openc3/js-common/utils"})," provides a function that will prepend the base path (e.g. localhost:2900) to Vue Router ",(0,s.jsx)(n.code,{children:"route"})," objects and their children. This can be useful if you run into certain quirks with single-spa and vue-router 4's routing logic where you need the full path. You can see how we use it ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/src/router.js#L76",children:"here"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"import { devServerPlugin } from '@openc3/js-common/viteDevServerPlugin"}),". This Vite plugin is a temporary hack to run a local dev server for tools when migrating from webpack/vue-cli. It should be replaced with Vite's built-in ",(0,s.jsx)(n.code,{children:"vite dev"})," dev server, but that's currently not working - at least in our first-party COSMOS tools. You can see how we use it ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/blob/f0193f4146e28e1cd383732763a9d27d84b5ca71/openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-cmdtlmserver/vite.config.js#L37",children:"here"}),"."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openc3vue-common",children:(0,s.jsx)(n.code,{children:"@openc3/vue-common"})}),"\n",(0,s.jsxs)(n.p,{children:["This package provides all the shared Vue components we use to build our first-party tools. The main top-level exports are ",(0,s.jsx)(n.code,{children:"components"}),", ",(0,s.jsx)(n.code,{children:"icons"}),", ",(0,s.jsx)(n.code,{children:"plugins"}),", ",(0,s.jsx)(n.code,{children:"util"}),", and ",(0,s.jsx)(n.code,{children:"widgets"}),". There are also some tool-specific exports that we built for code sharing with COSMOS Enterprise, which you might find useful: ",(0,s.jsx)(n.code,{children:"tool/base"}),", ",(0,s.jsx)(n.code,{children:"tool/admin"}),", and ",(0,s.jsx)(n.code,{children:"tool/calendar"}),". Here's an example, but again, reference the pattern mentioned above."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'// COSMOS 5 (old)\nimport DetailsDialog from "@openc3/tool-common/src/components/DetailsDialog";\nimport Graph from "@openc3/tool-common/src/components/Graph";\nimport Notify from "@openc3/tool-common/src/plugins/notify";\nimport TimeFilters from "@openc3/tool-common/src/tools/base/util/timeFilters";\nimport VWidget from "@openc3/tool-common/src/components/widgets/VWidget";\n\n// COSMOS 6 (new)\nimport { DetailsDialog, Graph } from "@openc3/vue-common/components";\nimport { Notify } from "@openc3/vue-common/plugins";\nimport { TimeFilters } from "@openc3/vue-common/util";\nimport { VWidget } from "@openc3/vue-common/widgets";\n'})}),"\n",(0,s.jsx)(n.h2,{id:"migrating-from-cosmos-4-to-cosmos-5",children:"Migrating From COSMOS 4 to COSMOS 5"}),"\n",(0,s.jsx)(n.admonition,{title:"All COSMOS Users",type:"info",children:(0,s.jsx)(n.p,{children:"All COSMOS 4 users must upgrade their configuration to 5. However, the command, telemetry and screen definitions (keywords and syntax) have remained the same."})}),"\n",(0,s.jsxs)(n.p,{children:["COSMOS 5 is a new architecture and treats targets as independent ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/plugins",children:"plugins"}),". Thus the primary effort in porting from COSMOS 4 to COSMOS 5 is converting targets to plugins. We recommend creating plugins for each independent target (with its own interface) but targets which share an interface will need to be part of the same plugin. The reason for independent plugins is it allows the plugin to be versioned separately and more easily shared outside your specific project. If you have very project specific targets (e.g. custom hardware) those can potentially be combined for ease of deployment."]}),"\n",(0,s.jsxs)(n.p,{children:["We also removed and renamed a number of ",(0,s.jsx)(n.a,{href:"../guides/scripting-api#migration-from-cosmos-v4-to-v5",children:"API methods"})," in COSMOS 5."]}),"\n",(0,s.jsx)(n.h3,{id:"configuration-migration-tool",children:"Configuration Migration Tool"}),"\n",(0,s.jsx)(n.p,{children:"COSMOS 5 (but not COSMOS 6) includes a migration tool for converting an existing COSMOS 4 configuration into a COSMOS 5 plugin. This example assumes an existing COSMOS 4 configuration at C:\\COSMOS and a new COSMOS 5 installation at C:\\cosmos-project. Linux users can adjust paths and change from .bat to .sh to follow along."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Change to the existing COSMOS 4 configuration directory. You should see the config, lib, procedures, outputs directory. You can then run the migration tool by specifying the absolute path to the COSMOS 5 installation."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate -a demo\n"})}),"\n",(0,s.jsx)(n.p,{children:"This creates a new COSMOS 5 plugin called openc3-cosmos-demo with a target named DEMO containing the existing lib and procedures files as well as all the existing targets."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-batch",children:"C:\\COSMOS> C:\\cosmos-project\\openc3.bat cli migrate demo-part INST\n"})}),"\n",(0,s.jsx)(n.p,{children:"This would create a new COSMOS 5 plugin called openc3-cosmos-demo-part with a target named DEMO_PART containing the existing lib and procedures files as well as the INST target (but no others)."}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Open the new COSMOS 5 plugin and ensure the ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/plugins#plugintxt-configuration-file",children:"plugin.txt"})," file is correctly configured. The migration tool doesn't create VARIABLEs or MICROSERVICEs or handle target substitution so those features will have to added manually."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Follow the ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/getting-started/gettingstarted#building-your-plugin",children:"building your plugin"})," part of the Getting Started tutorial to build your new plugin and upload it to COSMOS 5."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"upgrading-custom-tools",children:"Upgrading Custom Tools"}),"\n",(0,s.jsxs)(n.p,{children:["COSMOS 4 was a Qt Desktop based application. COSMOS 5 is a completely new architecture which runs natively in the browser using ",(0,s.jsx)(n.a,{href:"https://vuejs.org/",children:"Vue.js"})," as the Javascript framework and ",(0,s.jsx)(n.a,{href:"https://vuetifyjs.com/en/",children:"Vuetify"})," as the GUI library. We utilize ",(0,s.jsx)(n.a,{href:"https://single-spa.js.org/",children:"single-spa"})," to allow you to write COSMOS tool plugins in any language and provide ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3/templates",children:"templates"})," for Vue.js (recommended), Angular, React and Svelte. Any COSMOS 4 custom tools will have to be completely re-written to run in COSMOS 5. We recommend using the native COSMOS ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages",children:"tools"})," and finding GUI concepts and functionality that best match the tool you're trying to re-create."]}),"\n",(0,s.jsxs)(n.p,{children:["If you need custom development get in touch at ",(0,s.jsx)(n.a,{href:"mailto:sales@openc3.com",children:"sales@openc3.com"}),"."]})]})}function h(e={}){let{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}function p(e,n){throw Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},5511:function(e,n,o){o.d(n,{R:()=>r,x:()=>c});var t=o(6363);let s={},i=t.createContext(s);function r(e){let n=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/7724.decf13c5.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["7724"],{1111:function(c,e,o){o.r(e)}}]);

data/tools/staticdocs/assets/js/867640d5.8e389f8a.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["908"],{9493:function(e,n,t){t.r(n),t.d(n,{frontMatter:()=>c,toc:()=>l,default:()=>h,metadata:()=>i,assets:()=>a,contentTitle:()=>r});var i=JSON.parse('{"id":"guides/cfs","title":"COSMOS and NASA cFS","description":"Tutorial for integrating with NASA cFS","source":"@site/docs/guides/cfs.md","sourceDirName":"guides","slug":"/guides/cfs","permalink":"/tools/staticdocs/docs/guides/cfs","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/cfs.md","tags":[],"version":"current","frontMatter":{"title":"COSMOS and NASA cFS","description":"Tutorial for integrating with NASA cFS","sidebar_custom_props":{"myEmoji":"\u{1F680}"}},"sidebar":"defaultSidebar","previous":{"title":"Bridges","permalink":"/tools/staticdocs/docs/guides/bridges"},"next":{"title":"Custom Widgets","permalink":"/tools/staticdocs/docs/guides/custom-widgets"}}'),s=t(7259),o=t(5511);let c={title:"COSMOS and NASA cFS",description:"Tutorial for integrating with NASA cFS",sidebar_custom_props:{myEmoji:"\u{1F680}"}},r,a={},l=[{value:"Working configuration",id:"working-configuration",level:2},{value:"Setting up COSMOS",id:"setting-up-cosmos",level:2},{value:"Configuring COSMOS",id:"configuring-cosmos",level:3},{value:"Setting up cFS",id:"setting-up-cfs",level:2},{value:"Clone cFS",id:"clone-cfs",level:3},{value:"Create Dockerfile in cFS dir",id:"create-dockerfile-in-cfs-dir",level:3},{value:"Build and run cFS",id:"build-and-run-cfs",level:3},{value:"Creating a COSMOS plugin for TM/TC interface with cFS",id:"creating-a-cosmos-plugin-for-tmtc-interface-with-cfs",level:2},{value:"Creating TM/TC definitions",id:"creating-tmtc-definitions",level:2},{value:"Uploading the plugin",id:"uploading-the-plugin",level:2}];function d(e){let n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"working-configuration",children:"Working configuration"}),"\n",(0,s.jsx)(n.p,{children:"This tutorial has been tested using the following components:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["COSMOS v6 release ",(0,s.jsx)(n.a,{href:"https://github.com/OpenC3/cosmos/releases/tag/v6.3.0",children:"6.3.0"})]}),"\n",(0,s.jsx)(n.li,{children:"cFS main-branch commit: 0ba1faa (April 23, 2025)"}),"\n",(0,s.jsx)(n.li,{children:"Docker Desktop 4.40.0 on MacOS"}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Replace all ",(0,s.jsx)(n.code,{children:"<xxxxxx>"})," with your matching paths and names. Example: ",(0,s.jsx)(n.code,{children:"<USERNAME>"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"setting-up-cosmos",children:"Setting up COSMOS"}),"\n",(0,s.jsxs)(n.p,{children:["Install COSMOS according to the official ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/getting-started/installation",children:"installation"})," instructions."]}),"\n",(0,s.jsx)(n.h3,{id:"configuring-cosmos",children:"Configuring COSMOS"}),"\n",(0,s.jsxs)(n.p,{children:["Change the Docker configuration for the interoperability with NASA cFS. For\nsubscribing to the telemetry, you have to append a port binding in the file\n",(0,s.jsx)(n.code,{children:"compose.yaml"})," under the section ",(0,s.jsx)(n.code,{children:"openc3-operator"}),". The port number has to\nmatch with the port number cFS is sending the telemetry on."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:'openc3-operator:\n  ports:\n    - "1235:1235/udp"\n'})}),"\n",(0,s.jsx)(n.p,{children:"Run COSMOS, the first run takes a while (~15 min)."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"openc3.sh start\n"})}),"\n",(0,s.jsxs)(n.p,{children:["When started, connect with a browser to ",(0,s.jsx)(n.a,{href:"http://localhost:2900",children:"http://localhost:2900"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"For shutting down COSMOS:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"openc3.sh stop\n"})}),"\n",(0,s.jsx)(n.h2,{id:"setting-up-cfs",children:"Setting up cFS"}),"\n",(0,s.jsxs)(n.p,{children:["To run ",(0,s.jsx)(n.a,{href:"https://github.com/nasa/cFS",children:"NASA cFS"})," as a Docker container do the following:"]}),"\n",(0,s.jsx)(n.h3,{id:"clone-cfs",children:"Clone cFS"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"git clone --recurse-submodules https://github.com/nasa/cFS.git\n"})}),"\n",(0,s.jsx)(n.h3,{id:"create-dockerfile-in-cfs-dir",children:"Create Dockerfile in cFS dir"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-docker",children:'FROM ubuntu:25.04 AS builder\n\nARG DEBIAN_FRONTEND=noninteractive\nARG SIMULATION=native\nENV SIMULATION=${SIMULATION}\nARG BUILDTYPE=debug\nENV BUILDTYPE=${BUILDTYPE}\nARG OMIT_DEPRECATED=true\nENV OMIT_DEPRECATED=${OMIT_DEPRECATED}\n\nRUN \\\n  apt-get update && \\\n  apt-get -y upgrade && \\\n  apt-get install -y build-essential git cmake && \\\n  rm -rf /var/lib/apt/lists/*\n\nWORKDIR /cFS\nCOPY . .\n\nRUN git submodule init \\\n  && git submodule update \\\n  && cp cfe/cmake/Makefile.sample Makefile \\\n  && cp -r cfe/cmake/sample_defs .\n\nRUN make prep\nRUN make\nRUN make install\n\nFROM ubuntu:25.04\nCOPY --from=builder /cFS/build /cFS/build\nWORKDIR /cFS/build/exe/cpu1\nENTRYPOINT [ "./core-cpu1" ]\n'})}),"\n",(0,s.jsx)(n.h3,{id:"build-and-run-cfs",children:"Build and run cFS"}),"\n",(0,s.jsxs)(n.p,{children:["Note we're connecting to the COSMOS network (",(0,s.jsx)(n.code,{children:"docker network ls"}),") and exposing the cFS ports."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"docker build -t cfs .\ndocker run --cap-add CAP_SYS_RESOURCE --net=cosmos-project_default --name cfs -p1234:1234/udp -p1235:1235 cfs\n"})}),"\n",(0,s.jsx)(n.h2,{id:"creating-a-cosmos-plugin-for-tmtc-interface-with-cfs",children:"Creating a COSMOS plugin for TM/TC interface with cFS"}),"\n",(0,s.jsxs)(n.p,{children:["The detailed instructions how to create a plugin, can be found\n",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/getting-started/gettingstarted",children:"here"}),', in the chapter "Interfacing with Your Hardware".']}),"\n",(0,s.jsxs)(n.p,{children:["Create a new plugin with the name ",(0,s.jsx)(n.code,{children:"CFS"}),". ",(0,s.jsx)(n.code,{children:"CFS"})," is the name of the plugin and\nmust be in capital letters according to the COSMOS documentation. This command\nshould create the plugin structure. Then cd into the plugin to create the target."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"# cd .. to the location of the cfs dir\n$PATH_TO_OPENC3/openc3.sh cli generate plugin CFS\ncd openc3-cosmos-cfs\n$PATH_TO_OPENC3/openc3.sh cli generate target CFS\n"})}),"\n",(0,s.jsxs)(n.p,{children:["In this newly created plugin, change the ",(0,s.jsx)(n.code,{children:"plugin.txt"})," file, so that the\ncommunication happens over UDP. ",(0,s.jsx)(n.code,{children:"port_tm"})," is the port number on which cFS\nsends the telemetry messages. ",(0,s.jsx)(n.code,{children:"port_tc"})," indicates the port on which cFS listens to the\ntelecommands."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ruby",children:"VARIABLE ip 127.0.0.1\nVARIABLE port_tm 1235\nVARIABLE port_tc 1234\nVARIABLE cfs_target_name CFS\n\nTARGET CFS <%= cfs_target_name %>\n# hostname   write_dest_port   read_port   write_src_port   interface_address   ttl   write_timeout   read_timeout   bind_address\nINTERFACE <%= cfs_target_name %>_INT udp_interface.rb <%= ip %> <%= port_tc %> <%= port_tm %> nil nil 128 nil nil\n  MAP_TARGET <%= cfs_target_name %>\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Note that the two arguments to the ",(0,s.jsx)(n.code,{children:"TARGET"})," parameter are:"]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["the physical target name that should match the name of the plugin, i.e. ",(0,s.jsx)(n.code,{children:"CFS"}),".\nThis name must match the folder name in the ",(0,s.jsx)(n.code,{children:"targets"})," folder. Example: for the\n",(0,s.jsx)(n.code,{children:"CFS"})," plugin, the target specifications must be under\n",(0,s.jsx)(n.code,{children:"openc3-cosmos-cfs/targets/CFS"}),". If you don't follow this\nconvention, the server will refuse to install your plugin at the following steps."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"the name of your target and how it is shown in the user interface."}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["In this example, we keep both names to be ",(0,s.jsx)(n.code,{children:"CFS"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"creating-tmtc-definitions",children:"Creating TM/TC definitions"}),"\n",(0,s.jsx)(n.p,{children:"Change to the target folder and remove the existing files and create own files."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd openc3-cosmos-cfs/targets/CFS/cmd_tlm\nrm *\ntouch cfs_cmds.txt\ntouch cfs_tlm.txt\ntouch to_lab_cmds.txt\n"})}),"\n",(0,s.jsx)(n.p,{children:"Open these newly created files in a text editor and fill them with following\ncontent."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"to_lab_cmds.txt"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ruby",children:'COMMAND CFS TO_LAB_ENABLE BIG_ENDIAN "Enable telemetry"\n  #                   NAME      BITS TYPE   min VAL     max VAL    init VAL  DESCRIPTION\n  APPEND_ID_PARAMETER STREAM_ID  16  UINT   0x1880      0x1880     0x1880    "Stream ID"\n    FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER    SEQUENCE   16  UINT   0xC000      MAX_UINT16 0xC000    ""\n    FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER    PKT_LEN    16  UINT   0x0001      0xFFFF     0x0012    "length of the packet"\n  APPEND_PARAMETER    CMD_ID      8  UINT   6           6          6         ""\n  APPEND_PARAMETER    CHECKSUM    8  UINT   MIN_UINT8   MAX_UINT8  0x98      ""\n    FORMAT_STRING "0x%2X"\n  APPEND_PARAMETER    DEST_IP   144  STRING "127.0.0.1"                      "Destination IP, i.e. 172.16.9.112, pc-57"\n'})}),"\n",(0,s.jsx)(n.admonition,{title:"Enabling Telemetry",type:"info",children:(0,s.jsxs)(n.p,{children:["The command ",(0,s.jsx)(n.code,{children:"0x1880"})," is needed to enable telemetry. When the cFS receives\nthis command, it starts sending telemetry to the IP address provided via the\n",(0,s.jsx)(n.code,{children:"DEST_IP"})," field."]})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"cfs_cmds.txt"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ruby",children:'COMMAND CFS NOOP BIG_ENDIAN "NOOP Command"\n  # cFS primary header\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  # cFS CMD secondary header\n  APPEND_PARAMETER       CMD_ID       8   UINT   0           0           0           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n\nCOMMAND CFS RESET BIG_ENDIAN "Reset Counters Command"\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  APPEND_PARAMETER       CMD_ID       8   UINT   1           1           1           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n\nCOMMAND CFS PROCESS BIG_ENDIAN "Process Command"\n  APPEND_ID_PARAMETER    STREAM_ID   16   UINT   0x1882      0x1882      0x1882      "Packet Identification"\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       SEQUENCE    16   UINT   MIN_UINT16  MAX_UINT16  0xC000      ""\n      FORMAT_STRING "0x%04X"\n  APPEND_PARAMETER       PKT_LEN     16   UINT   0x0001      0x0001      0x0001      "Packet length"\n  APPEND_PARAMETER       CMD_ID       8   UINT   2           2           2           ""\n  APPEND_PARAMETER       CHECKSUM     8   UINT   MIN_UINT8   MAX_UINT8   MIN_UINT8   ""\n'})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"cfs_tlm.txt"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ruby",children:'TELEMETRY CFS HK BIG_ENDIAN "housekeeping telemetry"\n  #                NAME       BITS  TYPE    ID      DESCRIPTION\n  APPEND_ID_ITEM   STREAM_ID   16   UINT    0x0883  "Stream ID"\n    FORMAT_STRING "0x%04X"\n  APPEND_ITEM      SEQUENCE    16   UINT            "Packet Sequence"\n    FORMAT_STRING "0x%04X"\n  APPEND_ITEM      PKT_LEN     16   UINT            "Length of the packet"\n  # telemetry secondary header\n  APPEND_ITEM      SECONDS     32   UINT            ""\n        UNITS Seconds sec\n  APPEND_ITEM      SUBSECS     16   UINT            ""\n        UNITS Milliseconds ms\n  # some bytes not known for what\n  APPEND_ITEM      SPARE2ALIGN 32   UINT            "Spares"\n  # payload\n  APPEND_ITEM      CMD_ERRS     8   UINT            "Command Error Counter"\n  APPEND_ITEM      CMD_CNT      8   UINT            "Command Counter"\n  # spare / alignment\n  APPEND_ITEM      SPARE       16   UINT            "Spares"\n'})}),"\n",(0,s.jsx)(n.p,{children:"Build the plugin from the base of your plugin folder:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"# cd openc3-cosmos-cfs\n$PATH_TO_OPENC3/openc3.sh cli rake build VERSION=1.0.0\n"})}),"\n",(0,s.jsx)(n.admonition,{title:"Plugin versioning",type:"info",children:(0,s.jsx)(n.p,{children:"Do not forget to change the version number with every build if you want to\nbetter distinguish between the versions of the plugin. When the version is\nseen in the plugin's .gem file name, it is easier to visualize the existing\nversions and the newly uploaded versions."})}),"\n",(0,s.jsx)(n.admonition,{title:"Plugin parameters",type:"info",children:(0,s.jsxs)(n.p,{children:["Multiple parameters are available for the plugin configuration. See the ",(0,s.jsx)(n.a,{href:"/tools/staticdocs/docs/configuration/plugins",children:"plugin"})," page."]})}),"\n",(0,s.jsx)(n.h2,{id:"uploading-the-plugin",children:"Uploading the plugin"}),"\n",(0,s.jsx)(n.p,{children:"After the plugin has been built, you can import the plugin in the admin area of\nthe page."}),"\n",(0,s.jsxs)(n.p,{children:["Connect with a browser to\n",(0,s.jsx)(n.a,{href:"http://localhost:2900/tools/admin",children:"http://localhost:2900/tools/admin"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:['Click on the "Install From File" button and navigate to where your plugin is stored and select\nthe ',(0,s.jsx)(n.code,{children:"openc3-cosmos-cfs-1.0.0.gem"})," file. Right of the selection line click on ",(0,s.jsx)(n.code,{children:"Install"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"Determine the IP address the cFS container and COSMOS operator container are running at:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'docker network ls\nNETWORK ID     NAME             DRIVER    SCOPE\nd842f813f1c7   cosmos-project_default    bridge    local\n\ndocker network inspect cosmos-project_default \n[\n    {\n        "Name": "cosmos-project_default ",\n        ...\n        "Containers": {\n            "03cb6bf1b27c631fad1366e9342aeaa5b80f458a437195e4a95e674bb5f5983d": {\n                "Name": "cfs",\n                "IPv4Address": "172.20.0.9/16",\n            },\n            "ceb9ea99b00849fd8867dcd1646838fef3471f7d64b69014703dbedbcc8147fc": {\n                "Name": "openc3_openc3-operator_1",\n                "IPv4Address": "172.20.0.8/16",\n            }\n        }\n        ...\n    }\n]\n'})}),"\n",(0,s.jsxs)(n.p,{children:["When using this plugin, make sure to change the ",(0,s.jsx)(n.code,{children:"ip"})," variable during uploading\nto match where cFS is running. In the example above you would set it to 172.20.0.9.\n",(0,s.jsx)(n.code,{children:"port_tm"})," is the port number on which cFS is sending the telemetry messages.\n",(0,s.jsx)(n.code,{children:"port_tc"})," indicates the port on cFS is listening for telecommands."]}),"\n",(0,s.jsxs)(n.p,{children:["Under ",(0,s.jsx)(n.code,{children:"cfs_target_name"})," you can change the target name of this plugin. This\nstep is optional as long as you are fine with your plugin showing up as ",(0,s.jsx)(n.code,{children:"CFS"}),"."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Plugin Variable Settings",src:t(8481).A+"",width:"1183",height:"270"})}),"\n",(0,s.jsx)(n.admonition,{title:"Port subscription",type:"warning",children:(0,s.jsx)(n.p,{children:"The last uploaded plugin on COSMOS will subscribe to TM on port 1235.\nOther plugins will not receive any TM anymore."})}),"\n",(0,s.jsx)(n.admonition,{title:"Typo errors",type:"info",children:(0,s.jsx)(n.p,{children:"Presence of typos in one of the plugin files can cause problems when uploading and installing\nthe plugin's .gem file. Make sure your configuration is typo-free."})}),"\n",(0,s.jsxs)(n.p,{children:["In the example above, the operator image is running at 172.20.0.8. To enable telemetry, go to the browser and connect to\n",(0,s.jsx)(n.a,{href:"http://localhost:2900/tools/cmdsender/CFS/TO_LAB_ENABLE",children:"http://localhost:2900/tools/cmdsender/CFS/TO_LAB_ENABLE"}),". Change the ",(0,s.jsx)(n.code,{children:"DEST_IP"})," to the IP address of the operator image (172.20.0.8) and send the command."]}),"\n",(0,s.jsxs)(n.p,{children:["Under ",(0,s.jsx)(n.a,{href:"http://localhost:2900/tools/cmdtlmserver/tlm-packets",children:"http://localhost:2900/tools/cmdtlmserver/tlm-packets"}),", you should see the incoming packets. Note in the CmdTlmServer you will also see CFS_INT UNKNOWN packets because we did not define the full cFS packet set. That exercise is left to the reader."]})]})}function h(e={}){let{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8481:function(e,n,t){t.d(n,{A:()=>i});let i=t.p+"assets/images/plugin_variables-6904e1d9003a6c8c530bd1f738f7966217beca7d3064b40670e7a4ab7e200927.png"},5511:function(e,n,t){t.d(n,{R:()=>c,x:()=>r});var i=t(6363);let s={},o=i.createContext(s);function c(e){let n=i.useContext(o);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/89e76475.19eee62b.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["8445"],{7564:function(e,t,o){o.r(t),o.d(t,{frontMatter:()=>l,toc:()=>a,default:()=>h,metadata:()=>s,assets:()=>c,contentTitle:()=>r});var s=JSON.parse('{"id":"tools/bucket-explorer","title":"Bucket Explorer","description":"File browser to the COSMOS backend bucket storage system","source":"@site/docs/tools/bucket-explorer.md","sourceDirName":"tools","slug":"/tools/bucket-explorer","permalink":"/tools/staticdocs/docs/tools/bucket-explorer","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/bucket-explorer.md","tags":[],"version":"current","frontMatter":{"title":"Bucket Explorer","description":"File browser to the COSMOS backend bucket storage system","sidebar_custom_props":{"myEmoji":"\u{1FAA3}"}},"sidebar":"defaultSidebar","previous":{"title":"Autonomic (Enterprise)","permalink":"/tools/staticdocs/docs/tools/autonomic"},"next":{"title":"Calendar (Enterprise)","permalink":"/tools/staticdocs/docs/tools/calendar"}}'),n=o(7259),i=o(5511);let l={title:"Bucket Explorer",description:"File browser to the COSMOS backend bucket storage system",sidebar_custom_props:{myEmoji:"\u{1FAA3}"}},r,c={},a=[{value:"Introduction",id:"introduction",level:2},{value:"Browsing Files",id:"browsing-files",level:2},{value:"Upload",id:"upload",level:3},{value:"Download",id:"download",level:3},{value:"Delete",id:"delete",level:3}];function d(e){let t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,n.jsx)(t.p,{children:"Bucket Explorer is a file browser to the COSMOS backend bucket storage system. It allows you to view files in an intuitive file browser hierarchy and download them. Bucket Explorer works both with local installations of COSMOS as well as cloud deployments which utilize cloud storage such as AWS S3 and GCP Cloud Storage."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"Bucket Explorer",src:o(2321).A+"",width:"1271",height:"543"})}),"\n",(0,n.jsx)(t.h2,{id:"browsing-files",children:"Browsing Files"}),"\n",(0,n.jsxs)(t.p,{children:["At the top are the three standard COSMOS buckets: ",(0,n.jsx)(t.code,{children:"config"}),", ",(0,n.jsx)(t.code,{children:"logs"}),", and ",(0,n.jsx)(t.code,{children:"tools"}),". Each bucket contains top level folders named after the scope. In COSMOS Core the only scope is ",(0,n.jsx)(t.code,{children:"DEFAULT"}),". The ",(0,n.jsx)(t.code,{children:"config"})," bucket holds the COSMOS configuration which is populated as plugins are installed. The ",(0,n.jsx)(t.code,{children:"logs"})," bucket holds the COSMOS logs which are generated by the various COSMOS microservices (See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/guides/logging",children:"Logging"})," for more info). These logs are gzipped to save storage space. The ",(0,n.jsx)(t.code,{children:"tools"})," bucket holds the source code for the built-in COSMOS tools as well as user created tools installed as plugins. Note that the search box only searches the current screen worth of files, e.g. it does not search the entire bucket."]}),"\n",(0,n.jsx)(t.admonition,{title:"Tools as Static Website",type:"note",children:(0,n.jsx)(t.p,{children:"Using bucket storage allows COSMOS to directly serve the tools as a static website and thus it must be a public bucket in cloud technology like S3"})}),"\n",(0,n.jsx)(t.h3,{id:"upload",children:"Upload"}),"\n",(0,n.jsxs)(t.p,{children:["Click the Upload icon to bring up a file browser to select a file to upload into the current bucket and path. Note that in ",(0,n.jsx)(t.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," you can only upload files to the config/DEFAULT/targets_modified folder unless you're an Admin."]}),"\n",(0,n.jsx)(t.h3,{id:"download",children:"Download"}),"\n",(0,n.jsx)(t.p,{children:"Click the Download icon to download any of the individual files from any bucket and path."}),"\n",(0,n.jsx)(t.h3,{id:"delete",children:"Delete"}),"\n",(0,n.jsxs)(t.p,{children:["Click the Trash icon to delete an individual file. Note that in ",(0,n.jsx)(t.a,{href:"https://openc3.com/enterprise",children:"COSMOS Enterprise"})," you can only delete files in the config/DEFAULT/targets_modified folder unless you're an Admin."]})]})}function h(e={}){let{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},2321:function(e,t,o){o.d(t,{A:()=>s});let s=o.p+"assets/images/bucket_explorer-ba88a20121198c3441a6af5302ab1a6ad62a171661037e9e3bfd312ca8bdb5ef.png"},5511:function(e,t,o){o.d(t,{R:()=>l,x:()=>r});var s=o(6363);let n={},i=s.createContext(n);function l(e){let t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/8b939c74.695b23ba.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["2053"],{2841:function(e,t,i){i.r(t),i.d(t,{frontMatter:()=>o,toc:()=>d,default:()=>h,metadata:()=>s,assets:()=>l,contentTitle:()=>r});var s=JSON.parse('{"id":"tools/systemhealth","title":"System Health (Enterprise)","description":"Visualization of overall System Health metrics","source":"@site/docs/tools/systemhealth.md","sourceDirName":"tools","slug":"/tools/systemhealth","permalink":"/tools/staticdocs/docs/tools/systemhealth","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/systemhealth.md","tags":[],"version":"current","frontMatter":{"title":"System Health (Enterprise)","description":"Visualization of overall System Health metrics","sidebar_custom_props":{"myEmoji":"\u{1F49A}"}},"sidebar":"defaultSidebar","previous":{"title":"Script Runner","permalink":"/tools/staticdocs/docs/tools/script-runner"},"next":{"title":"Table Manager","permalink":"/tools/staticdocs/docs/tools/table-manager"}}'),n=i(7259),a=i(5511);let o={title:"System Health (Enterprise)",description:"Visualization of overall System Health metrics",sidebar_custom_props:{myEmoji:"\u{1F49A}"}},r,l={},d=[{value:"Introduction",id:"introduction",level:2},{value:"Metrics Displayed",id:"metrics-displayed",level:2},{value:"System Overview Gauges",id:"system-overview-gauges",level:3},{value:"Process Metrics",id:"process-metrics",level:3},{value:"Redis Metrics",id:"redis-metrics",level:3},{value:"Disk Usage",id:"disk-usage",level:3},{value:"Configurations",id:"configurations",level:2},{value:"Refresh Interval",id:"refresh-interval",level:3},{value:"System Health Configurations",id:"system-health-configurations",level:3},{value:"Alerting Mechanism",id:"alerting-mechanism",level:2},{value:"Notification",id:"notification",level:3}];function c(e){let t={code:"code",em:"em",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,n.jsx)(t.p,{children:"System Health visualizes and provides alerting on overall system metrics, including CPU, Memory, and Disk utilization. Alerting frequency and thresholds can be adjusted through the System Health configurations."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"System Health",src:i(2017).A+"",width:"2946",height:"1622"})}),"\n",(0,n.jsx)(t.h2,{id:"metrics-displayed",children:"Metrics Displayed"}),"\n",(0,n.jsx)(t.h3,{id:"system-overview-gauges",children:"System Overview Gauges"}),"\n",(0,n.jsxs)(t.p,{children:["At the top, there are three gauges displayed, which show the ",(0,n.jsx)(t.em,{children:"worst performing"})," nodes in CPU, Memory, and Disk utilization. This is give a quick glance as to how the overall system metrics look like. The gauges will turn green (healthy), yellow (warning), and red (excessive utilization) according to the thresholds defined in the System Health configurations. Below the individual gauges, the node / microservice that is causing the highest utilization is displayed."]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"System Overview Gauges",src:i(3046).A+"",width:"2524",height:"544"})}),"\n",(0,n.jsx)(t.h3,{id:"process-metrics",children:"Process Metrics"}),"\n",(0,n.jsx)(t.p,{children:"The Process Metrics table displays metrics for the various processes. Users can filter on the scope, type of process, and target, as well as search, sort, and paginate on the table. Depending on the process type, the headers of each column will be different, as different processes report different types of metrics. This table can be used to deep-dive into individual process performance."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"Process Metrics",src:i(9823).A+"",width:"2506",height:"586"})}),"\n",(0,n.jsx)(t.h3,{id:"redis-metrics",children:"Redis Metrics"}),"\n",(0,n.jsx)(t.p,{children:"The Redis Metrics table provides in-depth metrics of Redis performance, including IOPS and operation speeds. This table is searchable, sortable, and pageable."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"Redis Metrics",src:i(9257).A+"",width:"2520",height:"1150"})}),"\n",(0,n.jsx)(t.h3,{id:"disk-usage",children:"Disk Usage"}),"\n",(0,n.jsxs)(t.p,{children:["The Disk Usage table provides in-depth metrics of Disk Usage of each node (if deployed to a Kubernetes environment and the ",(0,n.jsx)(t.code,{children:"nodeDiskMetricsDaemonset"})," is enabled) and the ",(0,n.jsx)(t.code,{children:"/gems"}),", ",(0,n.jsx)(t.code,{children:"/plugins"}),", ",(0,n.jsx)(t.code,{children:"/data"}),", and ",(0,n.jsx)(t.code,{children:"/"})," (root) volumes. This table provides metrics on how much disk space is available and used on each of these mount points. This table is searchable, sortable, and pageable."]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"Disk Usage",src:i(4499).A+"",width:"2508",height:"736"})}),"\n",(0,n.jsx)(t.h2,{id:"configurations",children:"Configurations"}),"\n",(0,n.jsx)(t.p,{children:"Configurations are only available for Admins."}),"\n",(0,n.jsx)(t.h3,{id:"refresh-interval",children:"Refresh Interval"}),"\n",(0,n.jsx)(t.p,{children:"The refresh interval sets a timer for how often the page is automatically refreshed to provide the latest metrics on System Health. The default is set to 5 seconds, and can be adjusted from the File -> Options menu."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"Refresh Interval",src:i(8955).A+"",width:"2968",height:"1622"})}),"\n",(0,n.jsx)(t.h3,{id:"system-health-configurations",children:"System Health Configurations"}),"\n",(0,n.jsx)(t.p,{children:"The System Health configurations allow admins to change the yellow/red thresholds, enable/disable notifications, snooze duration, and sustained overload period for CPU, Memory, and Disk Utilization. The default configurations can be adjusted from the File -> Configurations menu."}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:'Yellow Threshold: The percent (%) utilization needed to exceed to trigger a "warning" notification, and sets gauge colors to yellow.'}),"\n",(0,n.jsx)(t.li,{children:'Red Threshold: The percent (%) utilization needed to exceed to trigger an "error" notification, and set gauge colors to red.'}),"\n",(0,n.jsx)(t.li,{children:"Snooze Duration: Number of minutes to snooze notifications after a threshold is hit. (Example: with a 15 minute snooze, if CPU utilization hits 100% consistently for an hour, the notification would get triggered a total of 4 times (every 15 minutes))."}),"\n",(0,n.jsx)(t.li,{children:"Sustained Overload: Number of seconds that the threshold would have to be met by a single service in order for the notification to trigger. This prevents noisy notifications, as CPU / Memory spikes can be normal (while sustained overload is suggests an anomaly)."}),"\n",(0,n.jsx)(t.li,{children:"Enable Alert Notifications: Enable or disable the alert notifications on system health. System Health will continue to be monitored and tracked, but the notifications will not be triggered."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{alt:"System Health Configurations",src:i(2429).A+"",width:"2964",height:"1620"})}),"\n",(0,n.jsx)(t.h2,{id:"alerting-mechanism",children:"Alerting Mechanism"}),"\n",(0,n.jsx)(t.p,{children:"If alert notifications are enabled through the System Health configurations, users of COSMOS will receive notifications if the yellow/red thresholds for CPU/Memory/Disk are met for a specified sustained duration."}),"\n",(0,n.jsx)(t.h3,{id:"notification",children:"Notification"}),"\n",(0,n.jsx)(t.p,{children:"If thresholds are met, users will see the log message indicating the system health issues, as well as be notified through the notification bell."}),"\n",(0,n.jsxs)(t.p,{children:["Logs are displayed if System Health thresholds are met.\n",(0,n.jsx)(t.img,{alt:"System Health Log Notifications",src:i(3148).A+"",width:"2976",height:"1642"})]}),"\n",(0,n.jsxs)(t.p,{children:["The notification bell will also contain the notifications if System Health thresholds are met.\n",(0,n.jsx)(t.img,{alt:"System Health Notification Bell",src:i(8989).A+"",width:"788",height:"898"})]})]})}function h(e={}){let{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},3148:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/alert_logs-8273c6912804a4a16ce15d59cedf266f32d8c0a4ace2ab25fd8d3f149fb7fed2.png"},8989:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/alert_notifications-c68f0ff77eec9c2bc0d31bd6693fce4055d21722f985e418c05533992be71631.png"},4499:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/disk_usage-c91c5ef35de6ec1c4ebcf485c6f74c68daeac6215bf185691ed613b7fd2a95cf.png"},9823:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/process_metrics-534358ca0a064ed4c24ff1a29f48686d1189e331da23e0f7a6625405278b31eb.png"},9257:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/redis_metrics-646d362a7855604a8b6de1b7064f6949914be7b84ad1ab78822990d56d6ebcc1.png"},8955:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/refresh_interval-8673071593ce24cb2bb0adedfd0e7fc4d612496c393c7f3f52ba37db497f9344.png"},2429:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/system_health_configuration-728cde02f1da6b75e606152e113e288b6d949dd1f4183c4691b0f61c4c47b30e.png"},3046:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/system_overview_gauges-3975fb0011287cf4f98af7dfdf9dba681943913c0b47642645cd19b583e35b74.png"},2017:function(e,t,i){i.d(t,{A:()=>s});let s=i.p+"assets/images/systemhealth-fc26a7d9cda6242569255ecd4264d1c91ad47d85a3805b610d3c946e0d10cfbf.png"},5511:function(e,t,i){i.d(t,{R:()=>o,x:()=>r});var s=i(6363);let n={},a=s.createContext(n);function o(e){let t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/8f7843ee.fffd1922.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([["6234"],{9525:function(e,t,o){o.r(t),o.d(t,{frontMatter:()=>r,toc:()=>c,default:()=>g,metadata:()=>s,assets:()=>a,contentTitle:()=>l});var s=JSON.parse('{"id":"guides/logging","title":"Logging","description":"The log files in COSMOS","source":"@site/docs/guides/logging.md","sourceDirName":"guides","slug":"/guides/logging","permalink":"/tools/staticdocs/docs/guides/logging","draft":false,"unlisted":false,"editUrl":"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/logging.md","tags":[],"version":"current","frontMatter":{"title":"Logging","description":"The log files in COSMOS","sidebar_custom_props":{"myEmoji":"\u{1FAB5}"}},"sidebar":"defaultSidebar","previous":{"title":"Local Mode","permalink":"/tools/staticdocs/docs/guides/local-mode"},"next":{"title":"Monitoring","permalink":"/tools/staticdocs/docs/guides/monitoring"}}'),i=o(7259),n=o(5511);let r={title:"Logging",description:"The log files in COSMOS",sidebar_custom_props:{myEmoji:"\u{1FAB5}"}},l,a={},c=[{value:"decom_logs &amp; raw_logs",id:"decom_logs--raw_logs",level:3},{value:"text_logs",id:"text_logs",level:3},{value:"tool_logs",id:"tool_logs",level:3}];function d(e){let t={a:"a",h3:"h3",img:"img",p:"p",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["The COSMOS ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/tools/bucket-explorer",children:"Bucket Explorer"})," tool provides a way to browse the COSMOS bucket storage backend whether you are running locally or in a cloud environment. Browse to ",(0,i.jsx)(t.a,{href:"http://localhost:2900/tools/bucketexplorer",children:"http://localhost:2900/tools/bucketexplorer"})," and you should see the list of buckets at the top:"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"Bucket Explorer",src:o(7713).A+"",width:"1272",height:"570"})}),"\n",(0,i.jsx)(t.p,{children:"Note the config and logs buckets are organized by scopes of which there initially is just one: DEFAULT. Clicking the DEFAULT folder in the logs bucket shows the decom_logs, raw_logs, reduced_xxx_logs, text_logs and tool_logs."}),"\n",(0,i.jsx)(t.h3,{id:"decom_logs--raw_logs",children:"decom_logs & raw_logs"}),"\n",(0,i.jsx)(t.p,{children:"The decom_logs and raw_logs folders contain the decommutated and raw command and telemetry data. Both are further broken down by target, packet, then date. For example, browsing into the DEFAULT/raw_logs/tlm/INST2/<YYYYMMDD>/ directory:"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"raw_tlm_logs",src:o(5516).A+"",width:"1272",height:"557"})}),"\n",(0,i.jsxs)(t.p,{children:["Note the presence of the gzipped .bin files which contain the raw binary data. For more information about the structure of these files see the ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/development/log-structure",children:"Log Structure"})," developer documentation."]}),"\n",(0,i.jsx)(t.p,{children:"The default settings for the Logging microservice is to start a new log file every 10 minutes or 50MB, which ever comes first. In the case of the low data rate demo, the 10 minute mark is hit first."}),"\n",(0,i.jsxs)(t.p,{children:["To change the logging settings add the various CYCLE_TIME ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#target-modifiers",children:"Target Modifiers"})," under the declared ",(0,i.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#target-1",children:"TARGET"})," name in your plugin.txt."]}),"\n",(0,i.jsx)(t.h3,{id:"text_logs",children:"text_logs"}),"\n",(0,i.jsx)(t.p,{children:"The text_logs folder contains openc3_log_messages which contains text files that are again sorted by date and timestamped. These log messages come from the various microservices including the server and the target microservices. Thus these logs contain all the commands sent (in plain text) and telemetry checked. These log messages files are long term records of the messages in the CmdTlmServer Log Messages window:"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"log_messages",src:o(1337).A+"",width:"1266",height:"469"})}),"\n",(0,i.jsx)(t.h3,{id:"tool_logs",children:"tool_logs"}),"\n",(0,i.jsx)(t.p,{children:"The tool_logs directory contains logs from the various COSMOS tools. Note that if you have not yet run any tools you may not see this directory as it is created on demand. Tool sub-directories are also created on demand. For example, after running a script in Script Runner a new 'sr' subdirectory appears which contains the script runner log resulting from running the script. In some cases logs in this directory may also be directly available from the tool itself. In the Script Runner case, the Script Messages pane below the script holds the output messages from the last script. Clicking the Download link allows you to download these messages as a file."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"log_messages",src:o(4382).A+"",width:"1266",height:"599"})})]})}function g(e={}){let{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1337:function(e,t,o){o.d(t,{A:()=>s});let s=o.p+"assets/images/log_messages-6dd20c27f64fc00c8e61ee1062193fd6cb31efa4701130385c9853abfeed8495.png"},7713:function(e,t,o){o.d(t,{A:()=>s});let s=o.p+"assets/images/logs-bfc2ef93f6e60cb3bdf409aaaf0b4315b6e98dc1b9c17bdc171e67b416d884cc.png"},5516:function(e,t,o){o.d(t,{A:()=>s});let s=o.p+"assets/images/raw_tlm_logs-b293435cebbd5d4f04ab8a469ce2b4eb66f4cfd046d7b18ee417893336816b85.png"},4382:function(e,t,o){o.d(t,{A:()=>s});let s=o.p+"assets/images/script_messages-5c30dab8202ae3d18fa1f12cdd43f409967b1d4ac84a4a0e96bf027041ab9a07.png"},5511:function(e,t,o){o.d(t,{R:()=>r,x:()=>l});var s=o(6363);let i={},n=s.createContext(i);function r(e){let t=s.useContext(n);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]);