https://opencost.io/assets/js/c377a04b.4ba7046d.js

1"use strict";(globalThis.webpackChunkweb_opencost=globalThis.webpackChunkweb_opencost||[]).push([[3361],{2939(e,n,o){o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"index","title":"Overview","description":"OpenCost is a vendor-neutral open source project for measuring and allocating cloud infrastructure and container costs. It\u2019s built for Kubernetes cost monitoring to power real-time cost monitoring, showback, and chargeback.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"editUrl":"https://github.com/opencost/opencost-website/tree/main/docs/index.md","tags":[],"version":"current","frontMatter":{"slug":"/"},"sidebar":"docsSidebar","next":{"title":"OpenCost Setup","permalink":"/docs/installation/install"}}');var i=o(4848),s=o(8453);const r={slug:"/"},a="Overview",l={},c=[{value:"Choose your setup path",id:"choose-your-setup-path",level:2},{value:"Installation",id:"installation",level:2},{value:"Integrating Cloud Costs and Configuration",id:"integrating-cloud-costs-and-configuration",level:2},{value:"On-Premises",id:"on-premises",level:2},{value:"Specification",id:"specification",level:2},{value:"Using the UI",id:"using-the-ui",level:2},{value:"Stay in the Loop",id:"stay-in-the-loop",level:2}];function d(e){const n={a:"a",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"overview",children:"Overview"})}),"\n",(0,i.jsx)(n.p,{children:"OpenCost is a vendor-neutral open source project for measuring and allocating cloud infrastructure and container costs. It\u2019s built for Kubernetes cost monitoring to power real-time cost monitoring, showback, and chargeback."}),"\n",(0,i.jsx)(n.h2,{id:"choose-your-setup-path",children:"Choose your setup path"}),"\n",(0,i.jsx)(n.p,{children:"Select the guidance that best matches your environment:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["For cloud-provider billing integration, see ",(0,i.jsx)(n.a,{href:"#integrating-cloud-costs-and-configuration",children:"Integrating Cloud Costs and Configuration"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["For on-premises environments, see ",(0,i.jsx)(n.a,{href:"#on-premises",children:"On-Premises"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["To run OpenCost outside Kubernetes, see the ",(0,i.jsx)(n.a,{href:"./installation/docker",children:"Docker installation guide"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Below are common documentation pages for the OpenCost Project:"}),"\n",(0,i.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsxs)(n.p,{children:["Check out our ",(0,i.jsx)(n.a,{href:"installation/install",children:"Installation guide"})," to start monitoring and managing your spend in minutes. Additional documentation is available for ",(0,i.jsx)(n.a,{href:"installation/prometheus",children:"configuring Prometheus"})," and managing your ",(0,i.jsx)(n.a,{href:"installation/helm",children:"OpenCost with Helm"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"integrating-cloud-costs-and-configuration",children:"Integrating Cloud Costs and Configuration"}),"\n",(0,i.jsxs)(n.p,{children:["If you want more accurate results or Cloud Costs from your provider's bill, refer to the ",(0,i.jsx)(n.a,{href:"configuration/",children:"Integrating Cloud Costs and Configuration"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"on-premises",children:"On-Premises"}),"\n",(0,i.jsxs)(n.p,{children:["For on-premises configuration, see ",(0,i.jsx)(n.a,{href:"https://opencost.io/docs/configuration/on-prem/",children:"On Premises"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"specification",children:"Specification"}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"specification",children:"OpenCost Specification"})," describes a vendor-neutral implementation for Kubernetes cost monitoring."]}),"\n",(0,i.jsx)(n.h2,{id:"using-the-ui",children:"Using the UI"}),"\n",(0,i.jsxs)(n.p,{children:["The OpenCost UI provides a visualization of the Kubernetes allocations and the related Cloud Costs. This walkthrough highlights some of the components of the ",(0,i.jsx)(n.a,{href:"installation/ui",children:"OpenCost UI"}),"."]}),"\n",(0,i.jsx)("iframe",{width:"840",height:"472",src:"https://www.youtube.com/embed/lCP4Ci9Kcdg?si=RuDM3e0cKNFgWvpE",title:"OpenCost UI Tour",frameborder:"1",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:!0}),"\n",(0,i.jsx)(n.h2,{id:"stay-in-the-loop",children:"Stay in the Loop"}),"\n",(0,i.jsxs)(n.p,{children:["Join the ",(0,i.jsx)(n.a,{href:"/community",children:"OpenCost Community"})," and follow along other community events using our ",(0,i.jsx)(n.a,{href:"https://calendar.google.com/calendar/u/0/[email protected]&ctz=America/Los_Angeles",children:"calendar"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Join us on ",(0,i.jsx)(n.a,{href:"https://slack.cncf.io/",children:"CNCF Slack"})," in the ",(0,i.jsx)(n.a,{href:"https://cloud-native.slack.com/archives/C03D56FPD4G",children:"#opencost"})," channel if you have questions!"]}),"\n",(0,i.jsxs)(n.p,{children:["Contact us via email (",(0,i.jsx)(n.a,{href:"mailto:[email protected]",children:"[email protected]"}),") if there's anything else you need."]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453(e,n,o){o.d(n,{R:()=>r,x:()=>a});var t=o(6540);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);