Forte/launchpad
6
0
Fork 0
Code Issues Pull Requests Actions Packages Wiki Activity
Files
gitea-pages
launchpad/index.html
gitea-actions 8812b02458 Deploy docs
2026-04-18 18:39:51 +00:00

1667 lines
58 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for the GitOps-managed Kubernetes cluster">
<link rel="next" href="GITOPS-ARCHITECTURE/">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
<title>K8s Launchpad</title>
<link rel="stylesheet" href="assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#kubernetes-cluster-documentation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="K8s Launchpad" class="md-header__button md-logo" aria-label="K8s Launchpad" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
K8s Launchpad
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Home
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.forteapps.net/Forte/launchpad" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
Forte/launchpad
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="K8s Launchpad" class="md-nav__button md-logo" aria-label="K8s Launchpad" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
K8s Launchpad
</label>
<div class="md-nav__source">
<a href="https://git.forteapps.net/Forte/launchpad" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
Forte/launchpad
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Home
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-index" class="md-nav__link">
<span class="md-ellipsis">
📚 Documentation Index
</span>
</a>
<nav class="md-nav" aria-label="📚 Documentation Index">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-gitops-architecture-repository-guide" class="md-nav__link">
<span class="md-ellipsis">
1. GitOps Architecture &amp; Repository Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-developer-onboarding-guide" class="md-nav__link">
<span class="md-ellipsis">
2. Developer Onboarding Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-operations-runbook" class="md-nav__link">
<span class="md-ellipsis">
3. Operations Runbook
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-technical-reference" class="md-nav__link">
<span class="md-ellipsis">
4. Technical Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
🚀 Quick Start
</span>
</a>
<nav class="md-nav" aria-label="🚀 Quick Start">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-developers" class="md-nav__link">
<span class="md-ellipsis">
For New Developers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-platform-engineers" class="md-nav__link">
<span class="md-ellipsis">
For Platform Engineers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
For Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-map" class="md-nav__link">
<span class="md-ellipsis">
🗺️ Documentation Map
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reading-paths" class="md-nav__link">
<span class="md-ellipsis">
📖 Reading Paths
</span>
</a>
<nav class="md-nav" aria-label="📖 Reading Paths">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#path-1-new-developer-no-k8s-experience" class="md-nav__link">
<span class="md-ellipsis">
Path 1: New Developer (No K8s Experience)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-2-experienced-developer-has-k8s-experience" class="md-nav__link">
<span class="md-ellipsis">
Path 2: Experienced Developer (Has K8s Experience)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-3-platform-engineer-sre" class="md-nav__link">
<span class="md-ellipsis">
Path 3: Platform Engineer / SRE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-4-quick-reference" class="md-nav__link">
<span class="md-ellipsis">
Path 4: Quick Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#finding-information" class="md-nav__link">
<span class="md-ellipsis">
🔍 Finding Information
</span>
</a>
<nav class="md-nav" aria-label="🔍 Finding Information">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#how-do-i" class="md-nav__link">
<span class="md-ellipsis">
How do I...?
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#system-overview" class="md-nav__link">
<span class="md-ellipsis">
📊 System Overview
</span>
</a>
<nav class="md-nav" aria-label="📊 System Overview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cluster-architecture" class="md-nav__link">
<span class="md-ellipsis">
Cluster Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#key-technologies" class="md-nav__link">
<span class="md-ellipsis">
Key Technologies
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-tasks" class="md-nav__link">
<span class="md-ellipsis">
🛠️ Common Tasks
</span>
</a>
<nav class="md-nav" aria-label="🛠️ Common Tasks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#development-tasks" class="md-nav__link">
<span class="md-ellipsis">
Development Tasks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#operations-tasks" class="md-nav__link">
<span class="md-ellipsis">
Operations Tasks
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
🆘 Getting Help
</span>
</a>
<nav class="md-nav" aria-label="🆘 Getting Help">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#documentation-search-order" class="md-nav__link">
<span class="md-ellipsis">
Documentation Search Order
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-channels" class="md-nav__link">
<span class="md-ellipsis">
Support Channels
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#document-maintenance" class="md-nav__link">
<span class="md-ellipsis">
📝 Document Maintenance
</span>
</a>
<nav class="md-nav" aria-label="📝 Document Maintenance">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#updating-documentation" class="md-nav__link">
<span class="md-ellipsis">
Updating Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-structure" class="md-nav__link">
<span class="md-ellipsis">
Documentation Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-versions" class="md-nav__link">
<span class="md-ellipsis">
🔄 Documentation Versions
</span>
</a>
<nav class="md-nav" aria-label="🔄 Documentation Versions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#changelog" class="md-nav__link">
<span class="md-ellipsis">
Changelog
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
🎯 Next Steps
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="GITOPS-ARCHITECTURE/" class="md-nav__link">
<span class="md-ellipsis">
GitOps Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="DEVELOPER-GUIDE/" class="md-nav__link">
<span class="md-ellipsis">
Developer Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="OPERATIONS-RUNBOOK/" class="md-nav__link">
<span class="md-ellipsis">
Operations Runbook
</span>
</a>
</li>
<li class="md-nav__item">
<a href="REFERENCE/" class="md-nav__link">
<span class="md-ellipsis">
Technical Reference
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#documentation-index" class="md-nav__link">
<span class="md-ellipsis">
📚 Documentation Index
</span>
</a>
<nav class="md-nav" aria-label="📚 Documentation Index">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-gitops-architecture-repository-guide" class="md-nav__link">
<span class="md-ellipsis">
1. GitOps Architecture &amp; Repository Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-developer-onboarding-guide" class="md-nav__link">
<span class="md-ellipsis">
2. Developer Onboarding Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-operations-runbook" class="md-nav__link">
<span class="md-ellipsis">
3. Operations Runbook
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-technical-reference" class="md-nav__link">
<span class="md-ellipsis">
4. Technical Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
🚀 Quick Start
</span>
</a>
<nav class="md-nav" aria-label="🚀 Quick Start">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-developers" class="md-nav__link">
<span class="md-ellipsis">
For New Developers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-platform-engineers" class="md-nav__link">
<span class="md-ellipsis">
For Platform Engineers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
For Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-map" class="md-nav__link">
<span class="md-ellipsis">
🗺️ Documentation Map
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reading-paths" class="md-nav__link">
<span class="md-ellipsis">
📖 Reading Paths
</span>
</a>
<nav class="md-nav" aria-label="📖 Reading Paths">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#path-1-new-developer-no-k8s-experience" class="md-nav__link">
<span class="md-ellipsis">
Path 1: New Developer (No K8s Experience)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-2-experienced-developer-has-k8s-experience" class="md-nav__link">
<span class="md-ellipsis">
Path 2: Experienced Developer (Has K8s Experience)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-3-platform-engineer-sre" class="md-nav__link">
<span class="md-ellipsis">
Path 3: Platform Engineer / SRE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-4-quick-reference" class="md-nav__link">
<span class="md-ellipsis">
Path 4: Quick Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#finding-information" class="md-nav__link">
<span class="md-ellipsis">
🔍 Finding Information
</span>
</a>
<nav class="md-nav" aria-label="🔍 Finding Information">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#how-do-i" class="md-nav__link">
<span class="md-ellipsis">
How do I...?
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#system-overview" class="md-nav__link">
<span class="md-ellipsis">
📊 System Overview
</span>
</a>
<nav class="md-nav" aria-label="📊 System Overview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cluster-architecture" class="md-nav__link">
<span class="md-ellipsis">
Cluster Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#key-technologies" class="md-nav__link">
<span class="md-ellipsis">
Key Technologies
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-tasks" class="md-nav__link">
<span class="md-ellipsis">
🛠️ Common Tasks
</span>
</a>
<nav class="md-nav" aria-label="🛠️ Common Tasks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#development-tasks" class="md-nav__link">
<span class="md-ellipsis">
Development Tasks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#operations-tasks" class="md-nav__link">
<span class="md-ellipsis">
Operations Tasks
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
🆘 Getting Help
</span>
</a>
<nav class="md-nav" aria-label="🆘 Getting Help">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#documentation-search-order" class="md-nav__link">
<span class="md-ellipsis">
Documentation Search Order
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-channels" class="md-nav__link">
<span class="md-ellipsis">
Support Channels
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#document-maintenance" class="md-nav__link">
<span class="md-ellipsis">
📝 Document Maintenance
</span>
</a>
<nav class="md-nav" aria-label="📝 Document Maintenance">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#updating-documentation" class="md-nav__link">
<span class="md-ellipsis">
Updating Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-structure" class="md-nav__link">
<span class="md-ellipsis">
Documentation Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-versions" class="md-nav__link">
<span class="md-ellipsis">
🔄 Documentation Versions
</span>
</a>
<nav class="md-nav" aria-label="🔄 Documentation Versions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#changelog" class="md-nav__link">
<span class="md-ellipsis">
Changelog
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
🎯 Next Steps
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="kubernetes-cluster-documentation">Kubernetes Cluster Documentation<a class="headerlink" href="#kubernetes-cluster-documentation" title="Permanent link">&para;</a></h1>
<p>Welcome to the comprehensive documentation for our Kubernetes cluster GitOps setup. This documentation covers architecture, development workflows, operations, and technical references.</p>
<h2 id="documentation-index">📚 Documentation Index<a class="headerlink" href="#documentation-index" title="Permanent link">&para;</a></h2>
<h3 id="1-gitops-architecture-repository-guide">1. <a href="GITOPS-ARCHITECTURE/">GitOps Architecture &amp; Repository Guide</a><a class="headerlink" href="#1-gitops-architecture-repository-guide" title="Permanent link">&para;</a></h3>
<p><strong>Start here to understand the system</strong></p>
<p>Learn about:
- Overall architecture and design decisions
- Repository structure and relationships
- GitOps workflow and deployment patterns
- CI/CD pipeline integration
- Security model and best practices</p>
<p><strong>Best for</strong>: Understanding how everything fits together, architectural decisions, and the big picture.</p>
<hr />
<h3 id="2-developer-onboarding-guide">2. <a href="DEVELOPER-GUIDE/">Developer Onboarding Guide</a><a class="headerlink" href="#2-developer-onboarding-guide" title="Permanent link">&para;</a></h3>
<p><strong>For developers deploying and maintaining applications</strong></p>
<p>Learn how to:
- Set up your local development environment
- Deploy your first application
- Update existing applications
- Manage secrets securely
- Troubleshoot common issues
- Follow development best practices</p>
<p><strong>Best for</strong>: New developers joining the team, deploying applications, day-to-day development workflows.</p>
<hr />
<h3 id="3-operations-runbook">3. <a href="OPERATIONS-RUNBOOK/">Operations Runbook</a><a class="headerlink" href="#3-operations-runbook" title="Permanent link">&para;</a></h3>
<p><strong>For platform engineers and operators</strong></p>
<p>Learn how to:
- Bootstrap a new cluster
- Monitor and maintain applications
- Manage infrastructure components
- Handle secrets and credentials
- Troubleshoot production issues
- Perform disaster recovery
- Execute maintenance procedures</p>
<p><strong>Best for</strong>: Platform team members, SRE tasks, incident response, cluster maintenance.</p>
<hr />
<h3 id="4-technical-reference">4. <a href="REFERENCE/">Technical Reference</a><a class="headerlink" href="#4-technical-reference" title="Permanent link">&para;</a></h3>
<p><strong>Detailed technical specifications</strong></p>
<p>Reference for:
- Component specifications and versions
- Helm chart templates and values
- ArgoCD configuration options
- Kyverno policy definitions
- API endpoints and interfaces
- Configuration schemas
- Complete glossary</p>
<p><strong>Best for</strong>: Looking up specific configuration options, understanding component details, API references.</p>
<hr />
<h2 id="quick-start">🚀 Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
<h3 id="for-new-developers">For New Developers<a class="headerlink" href="#for-new-developers" title="Permanent link">&para;</a></h3>
<ol>
<li>Read <a href="GITOPS-ARCHITECTURE/#overview">GitOps Architecture</a> to understand the system</li>
<li>Follow <a href="DEVELOPER-GUIDE/#prerequisites">Developer Guide - Prerequisites</a> to set up your environment</li>
<li>Deploy your first application using <a href="DEVELOPER-GUIDE/#deploying-your-first-application">Deploying Your First Application</a></li>
</ol>
<h3 id="for-platform-engineers">For Platform Engineers<a class="headerlink" href="#for-platform-engineers" title="Permanent link">&para;</a></h3>
<ol>
<li>Understand the architecture in <a href="GITOPS-ARCHITECTURE/">GitOps Architecture</a></li>
<li>Learn cluster bootstrap in <a href="OPERATIONS-RUNBOOK/#cluster-bootstrap">Operations Runbook - Cluster Bootstrap</a></li>
<li>Review <a href="OPERATIONS-RUNBOOK/#day-to-day-operations">Day-to-Day Operations</a> procedures</li>
</ol>
<h3 id="for-troubleshooting">For Troubleshooting<a class="headerlink" href="#for-troubleshooting" title="Permanent link">&para;</a></h3>
<ol>
<li>Check <a href="DEVELOPER-GUIDE/#troubleshooting">Developer Guide - Troubleshooting</a> for common developer issues</li>
<li>Check <a href="OPERATIONS-RUNBOOK/#troubleshooting">Operations Runbook - Troubleshooting</a> for operational issues</li>
<li>Consult <a href="REFERENCE/">Technical Reference</a> for configuration details</li>
</ol>
<hr />
<h2 id="documentation-map">🗺️ Documentation Map<a class="headerlink" href="#documentation-map" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>┌─────────────────────────────────────────────────────────────┐
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>│ GITOPS ARCHITECTURE │
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>│ (System Overview, Repositories, Workflows, Security) │
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>└─────────────────────────────────────────────────────────────┘
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> │
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> ┌───────────┴───────────┐
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> │ │
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> ▼ ▼
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> ┌──────────────────┐ ┌──────────────────────┐
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> │ DEVELOPER GUIDE │ │ OPERATIONS RUNBOOK │
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> │ (Development) │ │ (Operations) │
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> └──────────────────┘ └──────────────────────┘
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> │ │
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> └───────────┬───────────┘
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> ▼
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> ┌────────────────────┐
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> │ TECHNICAL REFERENCE│
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> │ (Specifications) │
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> └────────────────────┘
</code></pre></div>
<hr />
<h2 id="reading-paths">📖 Reading Paths<a class="headerlink" href="#reading-paths" title="Permanent link">&para;</a></h2>
<h3 id="path-1-new-developer-no-k8s-experience">Path 1: New Developer (No K8s Experience)<a class="headerlink" href="#path-1-new-developer-no-k8s-experience" title="Permanent link">&para;</a></h3>
<ol>
<li><a href="GITOPS-ARCHITECTURE/#overview">GitOps Architecture - Overview</a></li>
<li><a href="GITOPS-ARCHITECTURE/#gitops-workflow">GitOps Architecture - GitOps Workflow</a></li>
<li><a href="DEVELOPER-GUIDE/#understanding-the-workflow">Developer Guide - Understanding the Workflow</a></li>
<li><a href="DEVELOPER-GUIDE/#deploying-your-first-application">Developer Guide - Deploying Your First Application</a></li>
<li><a href="DEVELOPER-GUIDE/#troubleshooting">Developer Guide - Troubleshooting</a></li>
</ol>
<h3 id="path-2-experienced-developer-has-k8s-experience">Path 2: Experienced Developer (Has K8s Experience)<a class="headerlink" href="#path-2-experienced-developer-has-k8s-experience" title="Permanent link">&para;</a></h3>
<ol>
<li><a href="GITOPS-ARCHITECTURE/#repository-structure">GitOps Architecture - Repository Structure</a></li>
<li><a href="DEVELOPER-GUIDE/#local-development-setup">Developer Guide - Local Development Setup</a></li>
<li><a href="DEVELOPER-GUIDE/#deploying-your-first-application">Developer Guide - Deploying Your First Application</a></li>
<li><a href="REFERENCE/#helm-chart-reference">Technical Reference - Helm Chart Reference</a></li>
</ol>
<h3 id="path-3-platform-engineer-sre">Path 3: Platform Engineer / SRE<a class="headerlink" href="#path-3-platform-engineer-sre" title="Permanent link">&para;</a></h3>
<ol>
<li><a href="GITOPS-ARCHITECTURE/">GitOps Architecture</a> (entire document)</li>
<li><a href="OPERATIONS-RUNBOOK/#cluster-bootstrap">Operations Runbook - Cluster Bootstrap</a></li>
<li><a href="OPERATIONS-RUNBOOK/#day-to-day-operations">Operations Runbook - Day-to-Day Operations</a></li>
<li><a href="OPERATIONS-RUNBOOK/#troubleshooting">Operations Runbook - Troubleshooting</a></li>
<li><a href="REFERENCE/">Technical Reference</a> (as needed)</li>
</ol>
<h3 id="path-4-quick-reference">Path 4: Quick Reference<a class="headerlink" href="#path-4-quick-reference" title="Permanent link">&para;</a></h3>
<ol>
<li><a href="DEVELOPER-GUIDE/#quick-reference">Developer Guide - Quick Reference</a></li>
<li><a href="REFERENCE/#configuration-reference">Technical Reference - Configuration Reference</a></li>
<li><a href="REFERENCE/#glossary">Technical Reference - Glossary</a></li>
</ol>
<hr />
<h2 id="finding-information">🔍 Finding Information<a class="headerlink" href="#finding-information" title="Permanent link">&para;</a></h2>
<h3 id="how-do-i">How do I...?<a class="headerlink" href="#how-do-i" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Task</th>
<th>Documentation</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Deploy a new application</strong></td>
<td><a href="DEVELOPER-GUIDE/#deploying-your-first-application">Developer Guide - Deploying Your First Application</a></td>
</tr>
<tr>
<td><strong>Update an existing application</strong></td>
<td><a href="DEVELOPER-GUIDE/#updating-an-existing-application">Developer Guide - Updating an Existing Application</a></td>
</tr>
<tr>
<td><strong>Create and seal secrets</strong></td>
<td><a href="DEVELOPER-GUIDE/#working-with-secrets">Developer Guide - Working with Secrets</a></td>
</tr>
<tr>
<td><strong>Troubleshoot deployment issues</strong></td>
<td><a href="DEVELOPER-GUIDE/#troubleshooting">Developer Guide - Troubleshooting</a></td>
</tr>
<tr>
<td><strong>Bootstrap a new cluster</strong></td>
<td><a href="OPERATIONS-RUNBOOK/#cluster-bootstrap">Operations Runbook - Cluster Bootstrap</a></td>
</tr>
<tr>
<td><strong>Scale an application</strong></td>
<td><a href="OPERATIONS-RUNBOOK/#scaling-applications">Operations Runbook - Scaling Applications</a></td>
</tr>
<tr>
<td><strong>Roll back a deployment</strong></td>
<td><a href="OPERATIONS-RUNBOOK/#rolling-back-deployments">Operations Runbook - Rolling Back Deployments</a></td>
</tr>
<tr>
<td><strong>Manage monitoring</strong></td>
<td><a href="OPERATIONS-RUNBOOK/#monitoring--alerting">Operations Runbook - Monitoring &amp; Alerting</a></td>
</tr>
<tr>
<td><strong>Understand ArgoCD config</strong></td>
<td><a href="REFERENCE/#argocd-configuration">Technical Reference - ArgoCD Configuration</a></td>
</tr>
<tr>
<td><strong>Look up Helm values</strong></td>
<td><a href="REFERENCE/#helm-chart-reference">Technical Reference - Helm Chart Reference</a></td>
</tr>
<tr>
<td><strong>Find component versions</strong></td>
<td><a href="REFERENCE/#version-matrix">Technical Reference - Version Matrix</a></td>
</tr>
</tbody>
</table>
<hr />
<h2 id="system-overview">📊 System Overview<a class="headerlink" href="#system-overview" title="Permanent link">&para;</a></h2>
<h3 id="cluster-architecture">Cluster Architecture<a class="headerlink" href="#cluster-architecture" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>┌──────────────────────────────────────────────────────────────┐
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>│ GitHub Repositories │
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>│ ┌────────────┐ ┌────────────┐ ┌────────────────────────┐ │
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>│ │ Config │ │ Charts │ │ Values │ │
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>│ │ (ArgoCD) │ │ (Templates)│ │ (Environment Config) │ │
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>│ └────────────┘ └────────────┘ └────────────────────────┘ │
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>└──────────────────────────────────────────────────────────────┘
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a> │
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a> ▼
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>┌──────────────────────────────────────────────────────────────┐
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>│ ArgoCD (GitOps Engine) │
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>│ Sync every 60 seconds │
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>└──────────────────────────────────────────────────────────────┘
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a> │
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a> ▼
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>┌──────────────────────────────────────────────────────────────┐
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>│ Kubernetes Clusters (UpCloud: upc-dev, upc-prod) │
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>│ ┌──────────────────────────────────────────────────────┐ │
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>│ │ Infrastructure: Traefik, Cert-Manager, Kyverno │ │
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a>│ ├──────────────────────────────────────────────────────┤ │
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>│ │ Monitoring: Prometheus, Grafana, Loki, Fluent-Bit │ │
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a>│ ├──────────────────────────────────────────────────────┤ │
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a>│ │ Applications: mcp10x, musicman, dot-ai-stack │ │
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a>│ └──────────────────────────────────────────────────────┘ │
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>└──────────────────────────────────────────────────────────────┘
</code></pre></div>
<h3 id="key-technologies">Key Technologies<a class="headerlink" href="#key-technologies" title="Permanent link">&para;</a></h3>
<ul>
<li><strong>GitOps</strong>: ArgoCD</li>
<li><strong>Kubernetes</strong>: UpCloud Managed Kubernetes (multi-cluster: upc-dev, upc-prod)</li>
<li><strong>Ingress</strong>: Traefik v2</li>
<li><strong>Certificates</strong>: Cert-Manager + Let's Encrypt</li>
<li><strong>Policies</strong>: Kyverno</li>
<li><strong>Secrets</strong>: Sealed Secrets</li>
<li><strong>Monitoring</strong>: Prometheus + Grafana</li>
<li><strong>Logging</strong>: Loki + Fluent-Bit</li>
</ul>
<hr />
<h2 id="common-tasks">🛠️ Common Tasks<a class="headerlink" href="#common-tasks" title="Permanent link">&para;</a></h2>
<h3 id="development-tasks">Development Tasks<a class="headerlink" href="#development-tasks" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Deploy new application</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nb">cd</span><span class="w"> </span>~/dev/k8s/launchpad
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="c1"># Create apps/myapp.yaml and helm-prod-values/myapp/values.yaml</span>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>git<span class="w"> </span>add<span class="w"> </span>apps/myapp.yaml
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;Add myapp&quot;</span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>git<span class="w"> </span>push
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="c1"># Update application</span>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="nb">cd</span><span class="w"> </span>~/dev/k8s/helm-prod-values
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>vim<span class="w"> </span>myapp/values.yaml
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>git<span class="w"> </span>commit<span class="w"> </span>-am<span class="w"> </span><span class="s2">&quot;Update myapp config&quot;</span>
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>git<span class="w"> </span>push
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="c1"># Create secret</span>
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>kubeseal<span class="w"> </span>--format<span class="o">=</span>yaml<span class="w"> </span>--cert<span class="o">=</span>pub-cert.pem<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="w"> </span>&lt;<span class="w"> </span>private/secret.yaml<span class="w"> </span>&gt;<span class="w"> </span>secrets/secret-sealed.yaml
<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a>git<span class="w"> </span>add<span class="w"> </span>secrets/secret-sealed.yaml
<a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a>git<span class="w"> </span>push
</code></pre></div>
<h3 id="operations-tasks">Operations Tasks<a class="headerlink" href="#operations-tasks" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Check application status</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>kubectl<span class="w"> </span>get<span class="w"> </span>applications<span class="w"> </span>-n<span class="w"> </span>argocd
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="c1"># View application details</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>kubectl<span class="w"> </span>describe<span class="w"> </span>application<span class="w"> </span>myapp<span class="w"> </span>-n<span class="w"> </span>argocd
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1"># Force sync</span>
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>kubectl<span class="w"> </span>patch<span class="w"> </span>application<span class="w"> </span>myapp<span class="w"> </span>-n<span class="w"> </span>argocd<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span>--type<span class="w"> </span>merge<span class="w"> </span>-p<span class="w"> </span><span class="s1">&#39;{&quot;metadata&quot;:{&quot;annotations&quot;:{&quot;argocd.argoproj.io/refresh&quot;:&quot;hard&quot;}}}&#39;</span>
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a>
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="c1"># Check pod logs</span>
<a id="__codelineno-3-12" name="__codelineno-3-12" href="#__codelineno-3-12"></a>kubectl<span class="w"> </span>logs<span class="w"> </span>-n<span class="w"> </span>myapp<span class="w"> </span>&lt;pod-name&gt;
<a id="__codelineno-3-13" name="__codelineno-3-13" href="#__codelineno-3-13"></a>
<a id="__codelineno-3-14" name="__codelineno-3-14" href="#__codelineno-3-14"></a><span class="c1"># Restart deployment</span>
<a id="__codelineno-3-15" name="__codelineno-3-15" href="#__codelineno-3-15"></a>kubectl<span class="w"> </span>rollout<span class="w"> </span>restart<span class="w"> </span>deployment<span class="w"> </span>myapp<span class="w"> </span>-n<span class="w"> </span>myapp
</code></pre></div>
<hr />
<h2 id="getting-help">🆘 Getting Help<a class="headerlink" href="#getting-help" title="Permanent link">&para;</a></h2>
<h3 id="documentation-search-order">Documentation Search Order<a class="headerlink" href="#documentation-search-order" title="Permanent link">&para;</a></h3>
<ol>
<li><strong>Quick Reference</strong>: <a href="DEVELOPER-GUIDE/#quick-reference">Developer Guide - Quick Reference</a></li>
<li><strong>Troubleshooting</strong>: <a href="DEVELOPER-GUIDE/#troubleshooting">Developer Guide - Troubleshooting</a> or <a href="OPERATIONS-RUNBOOK/#troubleshooting">Operations Runbook - Troubleshooting</a></li>
<li><strong>Technical Details</strong>: <a href="REFERENCE/">Technical Reference</a></li>
<li><strong>Architecture Context</strong>: <a href="GITOPS-ARCHITECTURE/">GitOps Architecture</a></li>
</ol>
<h3 id="support-channels">Support Channels<a class="headerlink" href="#support-channels" title="Permanent link">&para;</a></h3>
<ul>
<li><strong>Slack</strong>: #platform-support</li>
<li><strong>Issues</strong>: Platform team</li>
<li><strong>Emergencies</strong>: Escalate via Slack</li>
</ul>
<hr />
<h2 id="document-maintenance">📝 Document Maintenance<a class="headerlink" href="#document-maintenance" title="Permanent link">&para;</a></h2>
<h3 id="updating-documentation">Updating Documentation<a class="headerlink" href="#updating-documentation" title="Permanent link">&para;</a></h3>
<p>If you find:
- Outdated information
- Missing procedures
- Errors or typos
- Areas needing clarification</p>
<p>Please:
1. Create an issue or PR in the repository
2. Notify the platform team
3. Update the relevant documentation file</p>
<h3 id="documentation-structure">Documentation Structure<a class="headerlink" href="#documentation-structure" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>docs/
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>├── README.md # This file (index)
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>├── GITOPS-ARCHITECTURE.md # Architecture overview
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>├── DEVELOPER-GUIDE.md # Developer workflows
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>├── OPERATIONS-RUNBOOK.md # Operations procedures
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>└── REFERENCE.md # Technical specifications
</code></pre></div>
<hr />
<h2 id="documentation-versions">🔄 Documentation Versions<a class="headerlink" href="#documentation-versions" title="Permanent link">&para;</a></h2>
<p><strong>Current Version</strong>: 1.0.0
<strong>Last Updated</strong>: 2026-03-16
<strong>Maintained By</strong>: Platform Team</p>
<h3 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h3>
<ul>
<li><strong>v1.0.0 (2026-03-16)</strong>: Initial comprehensive documentation release</li>
<li>GitOps Architecture guide</li>
<li>Developer Onboarding guide</li>
<li>Operations Runbook</li>
<li>Technical Reference</li>
<li>Documentation index</li>
</ul>
<hr />
<h2 id="next-steps">🎯 Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<p>Choose your path:</p>
<ul>
<li>👨‍💻 <strong>New Developer?</strong> Start with <a href="DEVELOPER-GUIDE/">Developer Guide</a></li>
<li>🔧 <strong>Platform Engineer?</strong> Read <a href="OPERATIONS-RUNBOOK/">Operations Runbook</a></li>
<li>🏗️ <strong>Architect?</strong> Explore <a href="GITOPS-ARCHITECTURE/">GitOps Architecture</a></li>
<li>🔍 <strong>Need Details?</strong> Check <a href="REFERENCE/">Technical Reference</a></li>
</ul>
<hr />
<p><strong>Welcome to the team! 🚀</strong></p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": ".", "features": ["navigation.instant", "navigation.sections", "navigation.top", "search.highlight", "content.code.copy"], "search": "assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink