mirror of https://github.com/k3d-io/k3d
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.
1561 lines
48 KiB
1561 lines
48 KiB
|
|
<!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.3.0/usage/configfile/">
|
|
|
|
<link rel="icon" href="../../static/img/favicons_black_blue/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-7.3.6">
|
|
|
|
|
|
|
|
<title>Using Config Files - k3d</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.a57b2b03.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.3f5d1f46.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../static/css/asciinema-player.css">
|
|
|
|
<link rel="stylesheet" href="../../static/css/extra.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="grey">
|
|
|
|
|
|
<script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
|
|
|
|
<script>var palette=__get("__palette");if(null!==palette&&"object"==typeof palette.color)for(var key in 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="#using-config-files" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<header class="md-header" 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">
|
|
|
|
Using Config Files
|
|
|
|
</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="" 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" 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"></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"><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>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
<div class="md-tabs__inner 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="./" class="md-tabs__link md-tabs__link--active">
|
|
Guides
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../design/project/" 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>
|
|
|
|
|
|
|
|
<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"><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">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2">
|
|
Guides
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Guides" data-md-level="1">
|
|
<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 md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
Using Config Files
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
Using Config Files
|
|
</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="#introduction" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#usage" class="md-nav__link">
|
|
Usage
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#required-fields" class="md-nav__link">
|
|
Required Fields
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config-options" class="md-nav__link">
|
|
Config Options
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Config Options">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#all-options-example" class="md-nav__link">
|
|
All Options: Example
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tips" class="md-nav__link">
|
|
Tips
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config-file-vs-cli-flags" class="md-nav__link">
|
|
Config File vs. CLI Flags
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#references" class="md-nav__link">
|
|
References
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../kubeconfig/" class="md-nav__link">
|
|
Handling Kubeconfigs
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../multiserver/" class="md-nav__link">
|
|
Creating multi-server clusters
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../registries/" class="md-nav__link">
|
|
Using Image Registries
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../exposing_services/" class="md-nav__link">
|
|
Exposing Services
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../importing_images/" class="md-nav__link">
|
|
Importing modes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../k3s/" class="md-nav__link">
|
|
K3s Features in k3d
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_8" data-md-state="indeterminate" type="checkbox" id="__nav_2_8" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_8">
|
|
Advanced Guides
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Advanced Guides" data-md-level="2">
|
|
<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="../advanced/calico/" class="md-nav__link">
|
|
Use Calico instead of Flannel
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../advanced/cuda/" class="md-nav__link">
|
|
Running CUDA workloads
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_9" data-md-state="indeterminate" type="checkbox" id="__nav_2_9" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_9">
|
|
Commands
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Commands" data-md-level="2">
|
|
<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="../commands/k3d/" class="md-nav__link">
|
|
K3d
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster/" class="md-nav__link">
|
|
K3d cluster
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_create/" class="md-nav__link">
|
|
K3d cluster create
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_delete/" class="md-nav__link">
|
|
K3d cluster delete
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_edit/" class="md-nav__link">
|
|
K3d cluster edit
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_list/" class="md-nav__link">
|
|
K3d cluster list
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_start/" class="md-nav__link">
|
|
K3d cluster start
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_cluster_stop/" class="md-nav__link">
|
|
K3d cluster stop
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_completion/" class="md-nav__link">
|
|
K3d completion
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_config/" class="md-nav__link">
|
|
K3d config
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_config_init/" class="md-nav__link">
|
|
K3d config init
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_config_migrate/" class="md-nav__link">
|
|
K3d config migrate
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_image/" class="md-nav__link">
|
|
K3d image
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_image_import/" class="md-nav__link">
|
|
K3d image import
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_kubeconfig/" class="md-nav__link">
|
|
K3d kubeconfig
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_kubeconfig_get/" class="md-nav__link">
|
|
K3d kubeconfig get
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_kubeconfig_merge/" class="md-nav__link">
|
|
K3d kubeconfig merge
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node/" class="md-nav__link">
|
|
K3d node
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_create/" class="md-nav__link">
|
|
K3d node create
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_delete/" class="md-nav__link">
|
|
K3d node delete
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_edit/" class="md-nav__link">
|
|
K3d node edit
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_list/" class="md-nav__link">
|
|
K3d node list
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_start/" class="md-nav__link">
|
|
K3d node start
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_node_stop/" class="md-nav__link">
|
|
K3d node stop
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_registry/" class="md-nav__link">
|
|
K3d registry
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_registry_create/" class="md-nav__link">
|
|
K3d registry create
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_registry_delete/" class="md-nav__link">
|
|
K3d registry delete
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_registry_list/" class="md-nav__link">
|
|
K3d registry list
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_version/" class="md-nav__link">
|
|
K3d version
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../commands/k3d_version_list/" class="md-nav__link">
|
|
K3d version list
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3">
|
|
Design
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Design" data-md-level="1">
|
|
<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">
|
|
<a href="../../design/project/" class="md-nav__link">
|
|
Project Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../design/concepts/" class="md-nav__link">
|
|
Concepts
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../design/defaults/" class="md-nav__link">
|
|
Defaults
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../design/networking/" class="md-nav__link">
|
|
Networking
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4">
|
|
FAQ
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="FAQ" data-md-level="1">
|
|
<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">
|
|
FAQ
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../faq/compatibility/" class="md-nav__link">
|
|
Compatibility
|
|
</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="#introduction" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#usage" class="md-nav__link">
|
|
Usage
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#required-fields" class="md-nav__link">
|
|
Required Fields
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config-options" class="md-nav__link">
|
|
Config Options
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Config Options">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#all-options-example" class="md-nav__link">
|
|
All Options: Example
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tips" class="md-nav__link">
|
|
Tips
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config-file-vs-cli-flags" class="md-nav__link">
|
|
Config File vs. CLI Flags
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#references" class="md-nav__link">
|
|
References
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/k3d-io/k3d/edit/main/docs/usage/configfile.md" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
</a>
|
|
|
|
|
|
<h1 id="using-config-files">Using Config Files<a class="headerlink" href="#using-config-files" title="Permanent link">¶</a></h1>
|
|
<p>The config file feature is <strong>available as of k3d v4.0.0</strong></p>
|
|
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h2>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">Syntax & Semantics</p>
|
|
<p>The options defined in the config file are not 100% the same as the CLI flags.<br />
|
|
This concerns naming and style/usage/structure, e.g.</p>
|
|
<ul>
|
|
<li><code>--api-port</code> is split up into a field named <code>kubeAPI</code> that has 3 different “child fields” (<code>host</code>, <code>hostIP</code> and <code>hostPort</code>)</li>
|
|
<li>k3d options are bundled in a scope named <code>options.k3d</code>, where <code>--no-rollback</code> is defined as <code>options.k3d.disableRollback</code></li>
|
|
<li>repeatable flags (like <code>--port</code>) are reflected as YAML lists</li>
|
|
</ul>
|
|
</div>
|
|
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
|
|
<p>Using a config file is as easy as putting it in a well-known place in your file system and then referencing it via flag:</p>
|
|
<ul>
|
|
<li>All options in config file: <code>k3d cluster create --config /home/me/my-awesome-config.yaml</code> (must be <code>.yaml</code>/<code>.yml</code>)</li>
|
|
<li>With CLI override (name): <code>k3d cluster create somename --config /home/me/my-awesome-config.yaml</code></li>
|
|
<li>With CLI override (extra volume): <code>k3d cluster create --config /home/me/my-awesome-config.yaml --volume '/some/path:/some:path@server:0'</code></li>
|
|
</ul>
|
|
<h2 id="required-fields">Required Fields<a class="headerlink" href="#required-fields" title="Permanent link">¶</a></h2>
|
|
<p>As of the time of writing this documentation, the config file only <strong>requires</strong> you to define two fields:</p>
|
|
<ul>
|
|
<li><code>apiVersion</code> to match the version of the config file that you want to use (at this time it would be <code>apiVersion: k3d.io/v1alpha4</code>)</li>
|
|
<li><code>kind</code> to define the kind of config file that you want to use (currently we only have the <code>Simple</code> config)</li>
|
|
</ul>
|
|
<p>So this would be the minimal config file, which configures absolutely nothing:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">k3d.io/v1alpha4</span>
|
|
<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Simple</span>
|
|
</code></pre></div>
|
|
<h2 id="config-options">Config Options<a class="headerlink" href="#config-options" title="Permanent link">¶</a></h2>
|
|
<p>The configuration options for k3d are continuously evolving and so is the config file (syntax) itself.<br />
|
|
Currently, the config file is still in an Alpha-State, meaning, that it is subject to change anytime (though we try to keep breaking changes low).</p>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">Validation via JSON-Schema</p>
|
|
<p>k3d uses a <a href="https://json-schema.org/">JSON-Schema</a> to describe the expected format and fields of the configuration file.<br />
|
|
This schema is also used to <a href="https://github.com/xeipuuv/gojsonschema#validation">validate</a> a user-given config file.<br />
|
|
This JSON-Schema can be found in the specific config version sub-directory in the repository (e.g. <a href="https://github.com/k3d-io/k3d/blob/main/pkg/config/v1alpha4/schema.json">here for <code>v1alpha4</code></a>) and could be used to lookup supported fields or by linters to validate the config file, e.g. in your code editor. </p>
|
|
</div>
|
|
<h3 id="all-options-example">All Options: Example<a class="headerlink" href="#all-options-example" title="Permanent link">¶</a></h3>
|
|
<p>Since the config options and the config file are changing quite a bit, it’s hard to keep track of all the supported config file settings, so here’s an example showing all of them as of the time of writing:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># k3d configuration file, saved as e.g. /home/me/myk3dcluster.yaml</span>
|
|
<span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">k3d.io/v1alpha4</span> <span class="c1"># this will change in the future as we make everything more stable</span>
|
|
<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Simple</span> <span class="c1"># internally, we also have a Cluster config, which is not yet available externally</span>
|
|
<span class="nt">metadata</span><span class="p">:</span>
|
|
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">mycluster</span> <span class="c1"># name that you want to give to your cluster (will still be prefixed with `k3d-`)</span>
|
|
<span class="nt">servers</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1</span> <span class="c1"># same as `--servers 1`</span>
|
|
<span class="nt">agents</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">2</span> <span class="c1"># same as `--agents 2`</span>
|
|
<span class="nt">kubeAPI</span><span class="p">:</span> <span class="c1"># same as `--api-port myhost.my.domain:6445` (where the name would resolve to 127.0.0.1)</span>
|
|
<span class="nt">host</span><span class="p">:</span> <span class="s">"myhost.my.domain"</span> <span class="c1"># important for the `server` setting in the kubeconfig</span>
|
|
<span class="nt">hostIP</span><span class="p">:</span> <span class="s">"127.0.0.1"</span> <span class="c1"># where the Kubernetes API will be listening on</span>
|
|
<span class="nt">hostPort</span><span class="p">:</span> <span class="s">"6445"</span> <span class="c1"># where the Kubernetes API listening port will be mapped to on your host system</span>
|
|
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">rancher/k3s:v1.20.4-k3s1</span> <span class="c1"># same as `--image rancher/k3s:v1.20.4-k3s1`</span>
|
|
<span class="nt">network</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">my-custom-net</span> <span class="c1"># same as `--network my-custom-net`</span>
|
|
<span class="nt">subnet</span><span class="p">:</span> <span class="s">"172.28.0.0/16"</span> <span class="c1"># same as `--subnet 172.28.0.0/16`</span>
|
|
<span class="nt">token</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">superSecretToken</span> <span class="c1"># same as `--token superSecretToken`</span>
|
|
<span class="nt">volumes</span><span class="p">:</span> <span class="c1"># repeatable flags are represented as YAML lists</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">volume</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">/my/host/path:/path/in/node</span> <span class="c1"># same as `--volume '/my/host/path:/path/in/node@server:0;agent:*'`</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">server:0</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">agent:*</span>
|
|
<span class="nt">ports</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">port</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">8080:80</span> <span class="c1"># same as `--port '8080:80@loadbalancer'`</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">loadbalancer</span>
|
|
<span class="nt">env</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">envVar</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bar=baz</span> <span class="c1"># same as `--env 'bar=baz@server:0'`</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">server:0</span>
|
|
<span class="nt">registries</span><span class="p">:</span> <span class="c1"># define how registries should be created or used</span>
|
|
<span class="nt">create</span><span class="p">:</span> <span class="c1"># creates a default registry to be used with the cluster; same as `--registry-create registry.localhost`</span>
|
|
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">registry.localhost</span>
|
|
<span class="nt">host</span><span class="p">:</span> <span class="s">"0.0.0.0"</span>
|
|
<span class="nt">hostPort</span><span class="p">:</span> <span class="s">"5000"</span>
|
|
<span class="nt">use</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">k3d-myotherregistry:5000</span> <span class="c1"># some other k3d-managed registry; same as `--registry-use 'k3d-myotherregistry:5000'`</span>
|
|
<span class="nt">config</span><span class="p">:</span> <span class="p p-Indicator">|</span> <span class="c1"># define contents of the `registries.yaml` file (or reference a file); same as `--registry-config /path/to/config.yaml`</span>
|
|
<span class="no">mirrors:</span>
|
|
<span class="no">"my.company.registry":</span>
|
|
<span class="no">endpoint:</span>
|
|
<span class="no">- http://my.company.registry:5000</span>
|
|
<span class="nt">options</span><span class="p">:</span>
|
|
<span class="nt">k3d</span><span class="p">:</span> <span class="c1"># k3d runtime settings</span>
|
|
<span class="nt">wait</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span> <span class="c1"># wait for cluster to be usable before returining; same as `--wait` (default: true)</span>
|
|
<span class="nt">timeout</span><span class="p">:</span> <span class="s">"60s"</span> <span class="c1"># wait timeout before aborting; same as `--timeout 60s`</span>
|
|
<span class="nt">disableLoadbalancer</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">false</span> <span class="c1"># same as `--no-lb`</span>
|
|
<span class="nt">disableImageVolume</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">false</span> <span class="c1"># same as `--no-image-volume`</span>
|
|
<span class="nt">disableRollback</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">false</span> <span class="c1"># same as `--no-Rollback`</span>
|
|
<span class="nt">loadbalancer</span><span class="p">:</span>
|
|
<span class="nt">configOverrides</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">settings.workerConnections=2048</span>
|
|
<span class="nt">k3s</span><span class="p">:</span> <span class="c1"># options passed on to K3s itself</span>
|
|
<span class="nt">extraArgs</span><span class="p">:</span> <span class="c1"># additional arguments passed to the `k3s server|agent` command; same as `--k3s-arg`</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">arg</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">--tls-san=my.host.domain</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">server:*</span>
|
|
<span class="nt">nodeLabels</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">label</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">foo=bar</span> <span class="c1"># same as `--k3s-node-label 'foo=bar@agent:1'` -> this results in a Kubernetes node label</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">agent:1</span>
|
|
<span class="nt">kubeconfig</span><span class="p">:</span>
|
|
<span class="nt">updateDefaultKubeconfig</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span> <span class="c1"># add new cluster to your default Kubeconfig; same as `--kubeconfig-update-default` (default: true)</span>
|
|
<span class="nt">switchCurrentContext</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span> <span class="c1"># also set current-context to the new cluster's context; same as `--kubeconfig-switch-context` (default: true)</span>
|
|
<span class="nt">runtime</span><span class="p">:</span> <span class="c1"># runtime (docker) specific options</span>
|
|
<span class="nt">gpuRequest</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">all</span> <span class="c1"># same as `--gpus all`</span>
|
|
<span class="nt">labels</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="nt">label</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bar=baz</span> <span class="c1"># same as `--runtime-label 'bar=baz@agent:1'` -> this results in a runtime (docker) container label</span>
|
|
<span class="nt">nodeFilters</span><span class="p">:</span>
|
|
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">agent:1</span>
|
|
</code></pre></div>
|
|
<h2 id="tips">Tips<a class="headerlink" href="#tips" title="Permanent link">¶</a></h2>
|
|
<ul>
|
|
<li>k3d <a href="https://pkg.go.dev/os#ExpandEnv">expands environment variables</a> (<code>$VAR</code> or <code>${VAR}</code>) unconditionally in the config file, even before processing it in any way. </li>
|
|
</ul>
|
|
<h2 id="config-file-vs-cli-flags">Config File vs. CLI Flags<a class="headerlink" href="#config-file-vs-cli-flags" title="Permanent link">¶</a></h2>
|
|
<p>k3d uses <a href="https://github.com/spf13/cobra"><code>Cobra</code></a> and <a href="https://github.com/spf13/viper"><code>Viper</code></a> for CLI and general config handling respectively.<br />
|
|
This automatically introduces a “config option order of priority” (<a href="https://github.com/spf13/viper#why-viper">precedence order</a>):</p>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">Config Precedence Order</p>
|
|
<p>Source: <a href="https://github.com/spf13/viper#why-viper">spf13/viper#why-viper</a> </p>
|
|
<blockquote>
|
|
<p>Internal Setting > <strong>CLI Flag</strong> > Environment Variable > <strong>Config File</strong> > (k/v store >) Defaults</p>
|
|
</blockquote>
|
|
</div>
|
|
<p>This means, that you can define e.g. a “base configuration file” with settings that you share across different clusters and override only the fields that differ between those clusters in your CLI flags/arguments.<br />
|
|
For example, you use the same config file to create three clusters which only have different names and <code>kubeAPI</code> (<code>--api-port</code>) settings.</p>
|
|
<h2 id="references">References<a class="headerlink" href="#references" title="Permanent link">¶</a></h2>
|
|
<ul>
|
|
<li>k3d demo repository: <a href="https://github.com/iwilltry42/k3d-demo/blob/main/README.md#config-file-support">https://github.com/iwilltry42/k3d-demo/blob/main/README.md#config-file-support</a></li>
|
|
<li>SUSE Blog: <a href="https://www.suse.com/c/introduction-k3d-run-k3s-docker-src/">https://www.suse.com/c/introduction-k3d-run-k3s-docker-src/</a> (Search for <code>The “Configuration as Code” Way</code>)</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
<div class="md-source-date">
|
|
<small>
|
|
|
|
Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 22, 2022</span>
|
|
|
|
|
|
</small>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
|
|
<a href="#" class="md-top md-icon" data-md-component="top" data-md-state="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
|
|
</a>
|
|
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
|
|
|
|
<a href="../.." class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview" rel="prev">
|
|
<div class="md-footer__button md-icon">
|
|
<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>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
Overview
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="../kubeconfig/" class="md-footer__link md-footer__link--next" aria-label="Next: Handling Kubeconfigs" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
Handling Kubeconfigs
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
<div class="md-footer-copyright__highlight">
|
|
Copyright © 2020-2022 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"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.fcfe8b6d.min.js", "version": {"provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.b1047164.min.js"></script>
|
|
|
|
<script src="../../static/js/asciinema-player.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |