mirror/komodo
1
0
Fork 0
mirror of https://github.com/moghtech/komodo.git synced 2026-05-19 12:48:41 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
a0484efe1488ef9f67e4f74272aab7047b0db5bb
komodo/docs/resources.html
T
mbecker20 a0484efe14 Deploy website - based on 15f9879478
2024-08-16 18:39:30 -04:00

52 lines
19 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-resources" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">Resources | Monitor</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:image" content="https://docs.monitor.dev/img/monitor-lizard.png"><meta data-rh="true" name="twitter:image" content="https://docs.monitor.dev/img/monitor-lizard.png"><meta data-rh="true" property="og:url" content="https://docs.monitor.dev/docs/resources"><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="Resources | Monitor"><meta data-rh="true" name="description" content="Monitor is extendible through the Resource abstraction. Entities like Server, Deployment, and Stack are all Monitor Resources."><meta data-rh="true" property="og:description" content="Monitor is extendible through the Resource abstraction. Entities like Server, Deployment, and Stack are all Monitor Resources."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.monitor.dev/docs/resources"><link data-rh="true" rel="alternate" href="https://docs.monitor.dev/docs/resources" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.monitor.dev/docs/resources" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.e113b30e.css">
<script src="/assets/js/runtime~main.d09bb5a2.js" defer="defer"></script>
<script src="/assets/js/main.e85d907d.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:"light")}(),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_fXgn" 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="/"><div class="navbar__logo"><img src="/img/logo512.png" alt="monitor lizard" class="themedComponent_mlkZ themedComponent--light_NVdE" width="34px"><img src="/img/logo512.png" alt="monitor lizard" class="themedComponent_mlkZ themedComponent--dark_xIcU" width="34px"></div><b class="navbar__title text--truncate">Monitor</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/intro">docs</a></div><div class="navbar__items navbar__items--right"><a href="https://docs.rs/monitor_client/latest/monitor_client/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">docs.rs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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><a href="https://github.com/mbecker20/monitor" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><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="/docs/intro">What is Monitor?</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/resources">Resources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/core-setup">Monitor Core Setup</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/connecting-servers">Connecting Servers</a></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="/docs/build-images">Build Images</a><button aria-label="Expand sidebar category &#x27;Build Images&#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="/docs/deploy-containers">Deploy Containers</a><button aria-label="Expand sidebar category &#x27;Deploy Containers&#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="/docs/sync-resources">Sync Resources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/webhooks">Configuring Webhooks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/permissioning">Permissioning Resources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/version-upgrades">Version Upgrades</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" 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="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><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 breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Resources</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>Resources</h1>
<p>Monitor is extendible through the <strong>Resource</strong> abstraction. Entities like <code>Server</code>, <code>Deployment</code>, and <code>Stack</code> are all <strong>Monitor Resources</strong>.</p>
<p>All resources have common traits, such as a unique <code>name</code> and <code>id</code> amongst all other resources of the same resource type.
All resources can be assigned <code>tags</code>, which can be used to group related resources.</p>
<div class="theme-admonition theme-admonition-note admonition_xJq3 alert alert--secondary"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_BuS1"><p>Many resources need access to git repos / docker registries. There is an in-built token management system (managed in UI or in config file) to give resources access to credentials.
All resources which depend on git repos / docker registries are able to use these credentials to access private repos.</p></div></div>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="server">Server<a class="hash-link" aria-label="Direct link to Server" title="Direct link to Server" href="/docs/resources#server">​</a></h2>
<p>-- Configure the connection to periphery agents.<br>
-- Set alerting thresholds.<br>
-- Can be attached to <strong>Deployments</strong>, <strong>Stacks</strong>, <strong>Repos</strong>, and <strong>Builders</strong>.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="deployment">Deployment<a class="hash-link" aria-label="Direct link to Deployment" title="Direct link to Deployment" href="/docs/resources#deployment">​</a></h2>
<p>-- Deploy a docker container on the attached Server.<br>
-- Manage services at the container level, perform orchestration using <strong>Procedures</strong> and <strong>ResourceSyncs</strong>.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="stack">Stack<a class="hash-link" aria-label="Direct link to Stack" title="Direct link to Stack" href="/docs/resources#stack">​</a></h2>
<p>-- Deploy with docker compose.<br>
-- Provide the compose file in UI, or move the files to a git repo and use a webhook for auto redeploy on push.<br>
-- Supports composing multiple compose files using <code>docker compose -f ... -f ...</code>.<br>
-- Pass environment variables usable within the compose file. Interpolate in app-wide variables / secrets.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="repo">Repo<a class="hash-link" aria-label="Direct link to Repo" title="Direct link to Repo" href="/docs/resources#repo">​</a></h2>
<p>-- Put scripts in git repos, and run them on a Server, or using a Builder.<br>
-- Can build binaries, perform automation, really whatever you can think of.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="build">Build<a class="hash-link" aria-label="Direct link to Build" title="Direct link to Build" href="/docs/resources#build">​</a></h2>
<p>-- Build application source into docker images, and push them to the configured registry.<br>
-- The source can be any git repo containing a Dockerfile.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="builder">Builder<a class="hash-link" aria-label="Direct link to Builder" title="Direct link to Builder" href="/docs/resources#builder">​</a></h2>
<p>-- Either points to a connected server, or holds configuration to launch a single-use AWS instance to build the image.<br>
-- Can be attached to <strong>Builds</strong> and <strong>Repos</strong>.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="procedure">Procedure<a class="hash-link" aria-label="Direct link to Procedure" title="Direct link to Procedure" href="/docs/resources#procedure">​</a></h2>
<p>-- Compose many actions on other resource type, like <code>RunBuild</code> or <code>DeployStack</code>, and run it on button push (or with a webhook).<br>
-- Can run one or more actions in parallel &quot;stages&quot;, and compose a series of parallel stages to run sequentially.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="resourcesync">ResourceSync<a class="hash-link" aria-label="Direct link to ResourceSync" title="Direct link to ResourceSync" href="/docs/resources#resourcesync">​</a></h2>
<p>-- Orchestrate all your configuration declaratively by defining it in <code>toml</code> files, which are checked into a git repo.<br>
-- Can deploy <strong>Deployments</strong> and <strong>Stacks</strong> if changes are suggested.<br>
-- Specify deploy ordering with <code>after</code> array. (like docker compose <code>depends_on</code> but can span across servers.).</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="alerter">Alerter<a class="hash-link" aria-label="Direct link to Alerter" title="Direct link to Alerter" href="/docs/resources#alerter">​</a></h2>
<p>-- Route alerts to various endpoints.<br>
-- Can configure rules on each Alerter, such as resource whitelist, blacklist, or alert type filter.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="servertemplate">ServerTemplate<a class="hash-link" aria-label="Direct link to ServerTemplate" title="Direct link to ServerTemplate" href="/docs/resources#servertemplate">​</a></h2>
<p>-- Easily expand your cloud network by storing cloud server lauch templates on various providers.<br>
-- Auto connect the server to monitor on launch, using <code>User Data</code> launch scripts.</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/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/resources.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_Z9Sw" 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_JAkA"></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="/docs/intro"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">What is Monitor?</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/core-setup"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Monitor Core Setup</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL 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="/docs/resources#server">Server</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#deployment">Deployment</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#stack">Stack</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#repo">Repo</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#build">Build</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#builder">Builder</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#procedure">Procedure</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#resourcesync">ResourceSync</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#alerter">Alerter</a></li><li><a class="table-of-contents__link toc-highlight" href="/docs/resources#servertemplate">ServerTemplate</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Built with Docusaurus</div></div></div></footer></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink