gregandev
/
k3d
mirror of https://github.com/k3d-io/k3d
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Little helper to run CNCF's k3s in Docker
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
330 Commits
25 Branches
165 Tags
70 MiB
 
 
 
 
Tag: Branch: Tree: f2e35a262b
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f2e35a262b'
${ noResults }
k3d/v5.6.2/design/project/index.html

1912 lines
45 KiB
Raw 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="Little helper to run Rancher Lab's k3s in Docker">
<link rel="canonical" href="https://k3d.io/v5.6.2/design/project/">
<link rel="prev" href="../../usage/commands/k3d_version_list/">
<link rel="next" href="../concepts/">
<link rel="icon" href="../../static/img/favicons_black_blue/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.6">
<title>Project Overview - k3d</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.35e1ed30.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.356b1318.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>
<link rel="stylesheet" href="../../static/css/asciinema-player.css">
<link rel="stylesheet" href="../../static/css/extra.css">
<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="black" data-md-color-accent="grey">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<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="#project-overview" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="k3d" class="md-header__button md-logo" aria-label="k3d" data-md-component="logo">
<img src="../../static/img/k3d_logo_black_green.svg" alt="logo">
</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 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></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">
k3d
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Project Overview
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="grey" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="light-blue" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg>
</label>
</form>
<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.516 6.516 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 5Z"/></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.516 6.516 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 5Z"/></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 11h12Z"/></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 12 19 6.41Z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" 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://github.com/k3d-io/k3d" 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 496 512"><!--! Font Awesome Free 6.4.2 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 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
k3d-io/k3d
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Overview
</a>
</li>
<li class="md-tabs__item">
<a href="../../usage/configfile/" class="md-tabs__link">
Guides
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Design
</a>
</li>
<li class="md-tabs__item">
<a href="../../faq/faq/" class="md-tabs__link">
FAQ
</a>
</li>
</ul>
</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 md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="k3d" class="md-nav__button md-logo" aria-label="k3d" data-md-component="logo">
<img src="../../static/img/k3d_logo_black_green.svg" alt="logo">
</a>
k3d
</label>
<div class="md-nav__source">
<a href="https://github.com/k3d-io/k3d" 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 496 512"><!--! Font Awesome Free 6.4.2 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 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
k3d-io/k3d
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../usage/configfile/" class="md-nav__link">
<span class="md-ellipsis">
Using Config Files
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/kubeconfig/" class="md-nav__link">
<span class="md-ellipsis">
Handling Kubeconfigs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/multiserver/" class="md-nav__link">
<span class="md-ellipsis">
Creating multi-server clusters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/registries/" class="md-nav__link">
<span class="md-ellipsis">
Using Image Registries
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/exposing_services/" class="md-nav__link">
<span class="md-ellipsis">
Exposing Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/importing_images/" class="md-nav__link">
<span class="md-ellipsis">
Importing modes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/k3s/" class="md-nav__link">
<span class="md-ellipsis">
K3s Features in k3d
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_8" >
<label class="md-nav__link" for="__nav_2_8" id="__nav_2_8_label" tabindex="0">
<span class="md-ellipsis">
Advanced Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_8">
<span class="md-nav__icon md-icon"></span>
Advanced Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../usage/advanced/calico/" class="md-nav__link">
<span class="md-ellipsis">
Use Calico instead of Flannel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/advanced/cuda/" class="md-nav__link">
<span class="md-ellipsis">
Running CUDA workloads
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/advanced/podman/" class="md-nav__link">
<span class="md-ellipsis">
Using Podman instead of Docker
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_9" >
<label class="md-nav__link" for="__nav_2_9" id="__nav_2_9_label" tabindex="0">
<span class="md-ellipsis">
Commands
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_9">
<span class="md-nav__icon md-icon"></span>
Commands
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../usage/commands/k3d/" class="md-nav__link">
<span class="md-ellipsis">
K3d
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_create/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster create
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_delete/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster delete
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_edit/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster edit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_list/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_start/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_cluster_stop/" class="md-nav__link">
<span class="md-ellipsis">
K3d cluster stop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_completion/" class="md-nav__link">
<span class="md-ellipsis">
K3d completion
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_config/" class="md-nav__link">
<span class="md-ellipsis">
K3d config
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_config_init/" class="md-nav__link">
<span class="md-ellipsis">
K3d config init
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_config_migrate/" class="md-nav__link">
<span class="md-ellipsis">
K3d config migrate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_image/" class="md-nav__link">
<span class="md-ellipsis">
K3d image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_image_import/" class="md-nav__link">
<span class="md-ellipsis">
K3d image import
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_kubeconfig/" class="md-nav__link">
<span class="md-ellipsis">
K3d kubeconfig
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_kubeconfig_get/" class="md-nav__link">
<span class="md-ellipsis">
K3d kubeconfig get
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_kubeconfig_merge/" class="md-nav__link">
<span class="md-ellipsis">
K3d kubeconfig merge
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node/" class="md-nav__link">
<span class="md-ellipsis">
K3d node
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_create/" class="md-nav__link">
<span class="md-ellipsis">
K3d node create
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_delete/" class="md-nav__link">
<span class="md-ellipsis">
K3d node delete
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_edit/" class="md-nav__link">
<span class="md-ellipsis">
K3d node edit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_list/" class="md-nav__link">
<span class="md-ellipsis">
K3d node list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_start/" class="md-nav__link">
<span class="md-ellipsis">
K3d node start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_node_stop/" class="md-nav__link">
<span class="md-ellipsis">
K3d node stop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_registry/" class="md-nav__link">
<span class="md-ellipsis">
K3d registry
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_registry_create/" class="md-nav__link">
<span class="md-ellipsis">
K3d registry create
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_registry_delete/" class="md-nav__link">
<span class="md-ellipsis">
K3d registry delete
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_registry_list/" class="md-nav__link">
<span class="md-ellipsis">
K3d registry list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_version/" class="md-nav__link">
<span class="md-ellipsis">
K3d version
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/commands/k3d_version_list/" class="md-nav__link">
<span class="md-ellipsis">
K3d version list
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Design
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Design
</label>
<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">
Project Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Project Overview
</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="#about-this-page" class="md-nav__link">
About This Page
</a>
</li>
<li class="md-nav__item">
<a href="#directory-overview" class="md-nav__link">
Directory Overview
</a>
</li>
<li class="md-nav__item">
<a href="#packages-overview" class="md-nav__link">
Packages Overview
</a>
</li>
<li class="md-nav__item">
<a href="#anatomy-of-a-cluster" class="md-nav__link">
Anatomy of a Cluster
</a>
</li>
<li class="md-nav__item">
<a href="#automation-ci" class="md-nav__link">
Automation (CI)
</a>
</li>
<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
Documentation
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../concepts/" class="md-nav__link">
<span class="md-ellipsis">
Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../defaults/" class="md-nav__link">
<span class="md-ellipsis">
Defaults
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../networking/" class="md-nav__link">
<span class="md-ellipsis">
Networking
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
FAQ
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
FAQ
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../faq/faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../faq/compatibility/" class="md-nav__link">
<span class="md-ellipsis">
Compatibility
</span>
</a>
</li>
</ul>
</nav>
</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="#about-this-page" class="md-nav__link">
About This Page
</a>
</li>
<li class="md-nav__item">
<a href="#directory-overview" class="md-nav__link">
Directory Overview
</a>
</li>
<li class="md-nav__item">
<a href="#packages-overview" class="md-nav__link">
Packages Overview
</a>
</li>
<li class="md-nav__item">
<a href="#anatomy-of-a-cluster" class="md-nav__link">
Anatomy of a Cluster
</a>
</li>
<li class="md-nav__item">
<a href="#automation-ci" class="md-nav__link">
Automation (CI)
</a>
</li>
<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
Documentation
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="project-overview">Project Overview<a class="headerlink" href="#project-overview" title="Permanent link">&para;</a></h1>
<h2 id="about-this-page">About This Page<a class="headerlink" href="#about-this-page" title="Permanent link">&para;</a></h2>
<p>On this page we&rsquo;ll try to give an overview of all the moving bits and pieces in k3d to ease contributions to the project.</p>
<h2 id="directory-overview">Directory Overview<a class="headerlink" href="#directory-overview" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="https://github.com/k3d-io/k3d/tree/main/.github"><code>.github/</code></a><ul>
<li>templates for issues and pull requests</li>
<li>GitHub Action workflow definitions</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/cmd"><code>cmd/</code></a><ul>
<li>everything related to the actual k3d CLI, like the whole command tree, config initialization, argument parsing, etc.</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/docgen"><code>docgen/</code></a><ul>
<li>sub-module used to auto-generate the documentation for the CLI commands, which ends up in <a href="https://github.com/k3d-io/k3d/tree/main/docs/usage/commands"><code>docs/usage/commands/</code></a></li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/docs"><code>docs/</code></a><ul>
<li>all the resources used to build <a href="https://k3d.io">k3d.io</a> using mkdocs</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg"><code>pkg/</code></a><ul>
<li>the place where the magic happens.. here you find all the main logic of k3d</li>
<li>all function calls within <a href="https://github.com/k3d-io/k3d/tree/main/cmd"><code>cmd/</code></a> that do non-trivial things are imported from here</li>
<li>this (or rather sub-packages) is what other projects would import as a module to work with k3d without using the CLI</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/proxy"><code>proxy/</code></a><ul>
<li>configuration to build the <a href="https://github.com/k3d-io/k3d/pkgs/container/k3d-proxy"><code>k3d-io/k3d-proxy</code></a> container image which is used as a loadbalancer/proxy in front of (almost) every k3d cluster</li>
<li>this is basically just a combination of NGINX with confd and some k3d-specific configuration details</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/tests"><code>tests/</code></a><ul>
<li>a set of bash scripts used for end-to-end (E2E) tests of k3d</li>
<li>mostly used for all the functionality of the k3d CLI which cannot be tested using Go unit tests</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/tools"><code>tools/</code></a><ul>
<li>sub-module used to build the <a href="https://github.com/k3d-io/k3d/pkgs/container/k3d-tools"><code>k3d-io/k3d-tools</code></a> container image which supports some k3d functionality like <code>k3d image import</code></li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/vendor"><code>vendor/</code></a><ul>
<li>result of <code>go mod vendor</code>, which contains all dependencies of k3d</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/version"><code>version/</code></a><ul>
<li>package used to code k3d/k3s versions into releases</li>
<li>this is where <code>go build</code> injects the version tags when building k3d<ul>
<li>that&rsquo;s the output you see when issuing <code>k3d version</code></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="packages-overview">Packages Overview<a class="headerlink" href="#packages-overview" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg"><code>pkg/</code></a><ul>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/actions"><code>actions/</code></a><ul>
<li>hook actions describing actions (commands, etc.) that run at specific stages of the node/cluster lifecycle<ul>
<li>e.g. writing configuration files to the container filesystem just before the node (container) starts</li>
</ul>
</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/client"><code>client/</code></a><ul>
<li>all the top level functionality to work with k3d primitives<ul>
<li>create/retrieve/update/delete/start/stop clusters, nodes, registries, etc. managed by k3d</li>
</ul>
</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/config"><code>config/</code></a><ul>
<li>everything related to the k3d configuration (files), like <code>SimpleConfig</code> and <code>ClusterConfig</code></li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/runtimes"><code>runtimes/</code></a><ul>
<li>interface and implementations of runtimes that power k3d (currently, that&rsquo;s only Docker)</li>
<li>functions in <a href="https://github.com/k3d-io/k3d/tree/main/pkg/client"><code>client/</code></a> eventually call runtime functions to &ldquo;materialize&rdquo; nodes and clusters</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/tools"><code>tools/</code></a><ul>
<li>functions eventually calling the <a href="https://github.com/k3d-io/k3d/pkgs/container/k3d-tools"><code>k3d-tools</code></a> container (see <a href="https://github.com/k3d-io/k3d/tree/main/tools"><code>tools/</code></a> in the repo root)</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/types"><code>types/</code></a><ul>
<li>definition of all k3d primitives and many other details and defaults</li>
<li>e.g. contains the definition of a <code>Node</code> or a <code>Cluster</code> in k3d</li>
</ul>
</li>
<li><a href="https://github.com/k3d-io/k3d/tree/main/pkg/util"><code>util/</code></a><ul>
<li>some helper functions e.g. for string manipulation/generation, regexp or other re-usable usages</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="anatomy-of-a-cluster">Anatomy of a Cluster<a class="headerlink" href="#anatomy-of-a-cluster" title="Permanent link">&para;</a></h2>
<p>By default, every k3d cluster consists of at least 2 containers (nodes):</p>
<ol>
<li>
<p>(optional, but default and strongly recommended) loadbalancer</p>
<ul>
<li>image: <a href="https://github.com/k3d-io/k3d/pkgs/container/k3d-proxy"><code>ghcr.io/k3d-io/k3d-proxy</code></a>, built from <a href="https://github.com/k3d-io/k3d/tree/main/proxy"><code>proxy/</code></a></li>
<li>purpose: proxy and load balance requests from the outside (i.e. most of the times your local host) to the cluster<ul>
<li>by default, it e.g. proxies all the traffic for the Kubernetes API to port <code>6443</code> (default listening port of K3s) to all the server nodes in the cluster</li>
<li>can be used for multiple port-mappings to one or more nodes in your cluster<ul>
<li>that way, port-mappings can also easily be added/removed after the cluster creation, as we can simply re-create the proxy without affecting cluster state</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<p>(required, always present) primary server node</p>
<ul>
<li>image: <a href="https://hub.docker.com/r/rancher/k3s/"><code>rancher/k3s</code></a>, built from <a href="https://github.com/k3s-io/k3s"><code>github.com/k3s-io/k3s</code></a></li>
<li>purpose: (initializing) server (formerly: master) node of the cluster<ul>
<li>runs the K3s executable (which runs containerd, the Kubernetes API Server, etcd/sqlite, etc.): <code>k3s server</code></li>
<li>in a multi-server setup, it initializes the cluster with an embedded etcd database (using the K3s <code>--cluster-init</code> flag)</li>
</ul>
</li>
</ul>
</li>
<li>
<p>(optional) secondary server node(s)</p>
<ul>
<li>image: <a href="https://hub.docker.com/r/rancher/k3s/"><code>rancher/k3s</code></a>, built from <a href="https://github.com/k3s-io/k3s"><code>github.com/k3s-io/k3s</code></a></li>
</ul>
</li>
<li>
<p>(optional) agent node(s)</p>
<ul>
<li>image: <a href="https://hub.docker.com/r/rancher/k3s/"><code>rancher/k3s</code></a>, built from <a href="https://github.com/k3s-io/k3s"><code>github.com/k3s-io/k3s</code></a></li>
<li>purpose: running the K3s agent process (kubelet, etc.): <code>k3s agent</code></li>
</ul>
</li>
</ol>
<h2 id="automation-ci">Automation (CI)<a class="headerlink" href="#automation-ci" title="Permanent link">&para;</a></h2>
<p>The k3d repository mainly leverages the following two CI systems:</p>
<ul>
<li>GitHub Actions<ul>
<li>2 workflows in <a href="https://github.com/k3d-io/k3d/tree/main/.github/workflows">https://github.com/k3d-io/k3d/tree/main/.github/workflows</a> to push the artifact to AUR (Arch Linux User Repository)</li>
<li>logs/history can be seen in the Actions tab: <a href="https://github.com/k3d-io/k3d/actions">https://github.com/k3d-io/k3d/actions</a></li>
<li>static code analysis</li>
<li>build</li>
<li>tests</li>
<li>docker builds + pushes</li>
<li>render + push docs</li>
<li>(pre-) release to GitHub</li>
</ul>
</li>
</ul>
<h2 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h2>
<p>The website <a href="https://k3d.io">k3d.io</a> containing all the documentation for k3d is built using <a href="https://www.mkdocs.org/"><code>mkdocs</code></a>, configured via the <a href="https://github.com/k3d-io/k3d/blob/main/mkdocs.yml"><code>mkdocs.yml</code></a> config file with all the content residing in the <a href="https://github.com/k3d-io/k3d/tree/main/docs"><code>docs/</code></a> directory (Markdown).<br />
Use <code>mkdocs serve</code> in the repository root to build and serve the webpage locally.<br />
Some parts of the documentation are being auto-generated, like <a href="https://github.com/k3d-io/k3d/tree/main/docs/usage/commands"><code>docs/usage/commands/</code></a> is auto-generated using Cobra&rsquo;s command docs generation functionality in <a href="https://github.com/k3d-io/k3d/tree/main/docgen"><code>docgen/</code></a>.</p>
<hr>
<div class="md-source-file">
<small>
Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 24, 2022</span>
</small>
</div>
</article>
</div>
</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 8v12Z"/></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">
<div class="md-copyright__highlight">
Copyright &copy; 2020-2023 k3d Authors
</div>
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">{"base": "../..", "features": ["navigation.top", "search.suggest", "search.highlight", "navigation.expand", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "navigation.path"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "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": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.aecac24b.min.js"></script>
<script src="../../static/js/asciinema-player.js"></script>
</body>
</html>