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.
706 lines
27 KiB
706 lines
27 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/usage/commands/">
|
|
|
|
<link rel="shortcut icon" href="../../static/img/favicons_black_blue/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.5">
|
|
|
|
|
|
|
|
<title>Command Tree - k3d</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.15aa0b43.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.75751829.min.css">
|
|
|
|
|
|
|
|
<meta name="theme-color" content="#000000">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</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="" data-md-color-primary="black" data-md-color-accent="grey">
|
|
|
|
|
|
|
|
<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="#command-tree" 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-nav md-grid" aria-label="Header">
|
|
<a href="https://k3d.io/" title="k3d" class="md-header-nav__button md-logo" aria-label="k3d">
|
|
|
|
<img src="../../static/img/k3d_logo_black_green.svg" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header-nav__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-nav__title" data-md-component="header-title">
|
|
<div class="md-header-nav__ellipsis">
|
|
<div class="md-header-nav__topic">
|
|
<span class="md-ellipsis">
|
|
k3d
|
|
</span>
|
|
</div>
|
|
<div class="md-header-nav__topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Command Tree
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<label class="md-header-nav__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 0116 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 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.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" data-md-state="active" 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 0116 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 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.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>
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
|
|
</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-nav__source">
|
|
|
|
<a href="https://github.com/rancher/k3d/" title="Go to repository" class="md-source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
rancher/k3d
|
|
</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="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="https://k3d.io/" title="k3d" class="md-nav__button md-logo" aria-label="k3d">
|
|
|
|
<img src="../../static/img/k3d_logo_black_green.svg" alt="logo">
|
|
|
|
</a>
|
|
k3d
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
<a href="https://github.com/rancher/k3d/" title="Go to repository" class="md-source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
rancher/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">
|
|
Usage
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Usage" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Usage
|
|
</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">
|
|
|
|
|
|
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
Command Tree
|
|
</a>
|
|
|
|
</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 md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-4" type="checkbox" id="nav-2-4" >
|
|
|
|
<label class="md-nav__link" for="nav-2-4">
|
|
Guides
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Guides" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-2-4">
|
|
<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="../guides/exposing_services/" class="md-nav__link">
|
|
Exposing Services
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../guides/registries/" class="md-nav__link">
|
|
Registries
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../guides/calico/" class="md-nav__link">
|
|
Use Calico instead of Flannel
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../guides/cuda/" class="md-nav__link">
|
|
Running CUDA workloads
|
|
</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" type="checkbox" id="nav-3" >
|
|
|
|
<label class="md-nav__link" for="nav-3">
|
|
Internals
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
<nav class="md-nav" aria-label="Internals" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Internals
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../internals/defaults/" class="md-nav__link">
|
|
Defaults
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../internals/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" type="checkbox" id="nav-4" >
|
|
|
|
<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 / Nice to know
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../faq/v1vsv3-comparison/" class="md-nav__link">
|
|
Feature Comparison: v1 vs. v3
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/rancher/k3d/edit/master/docs/usage/commands.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="command-tree">Command Tree<a class="headerlink" href="#command-tree" title="Permanent link">¶</a></h1>
|
|
<div class="highlight"><pre><span></span><code>k3d
|
|
--verbose <span class="c1"># GLOBAL: enable verbose (debug) logging (default: false)</span>
|
|
--trace <span class="c1"># GLOBAL: enable super verbose logging (trace logging) (default: false)</span>
|
|
--version <span class="c1"># show k3d and k3s version</span>
|
|
-h, --help <span class="c1"># GLOBAL: show help text</span>
|
|
|
|
cluster <span class="o">[</span>CLUSTERNAME<span class="o">]</span> <span class="c1"># default cluster name is 'k3s-default'</span>
|
|
create
|
|
-a, --agents <span class="c1"># specify how many agent nodes you want to create (integer, default: 0)</span>
|
|
--api-port <span class="c1"># specify the port on which the cluster will be accessible (format '[HOST:]HOSTPORT', default: random)</span>
|
|
-c, --config <span class="c1"># use a config file (format 'PATH')</span>
|
|
-e, --env <span class="c1"># add environment variables to the nodes (quoted string, format: 'KEY[=VALUE][@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
|
|
--gpus <span class="c1"># [from docker CLI] add GPU devices to the node containers (string, e.g. 'all')</span>
|
|
-i, --image <span class="c1"># specify which k3s image should be used for the nodes (string, default: 'docker.io/rancher/k3s:v1.20.0-k3s2', tag changes per build)</span>
|
|
--k3s-agent-arg <span class="c1"># add additional arguments to the k3s agent (quoted string, use flag multiple times) (see https://rancher.com/docs/k3s/latest/en/installation/install-options/agent-config/#k3s-agent-cli-help)</span>
|
|
--k3s-server-arg <span class="c1"># add additional arguments to the k3s server (quoted string, use flag multiple times) (see https://rancher.com/docs/k3s/latest/en/installation/install-options/server-config/#k3s-server-cli-help)</span>
|
|
--kubeconfig-switch-context <span class="c1"># (implies --kubeconfig-update-default) automatically sets the current-context of your default kubeconfig to the new cluster's context (default: true)</span>
|
|
--kubeconfig-update-default <span class="c1"># enable the automated update of the default kubeconfig with the details of the newly created cluster (also sets '--wait=true') (default: true)</span>
|
|
-l, --label <span class="c1"># add (docker) labels to the node containers (format: 'KEY[=VALUE][@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
|
|
--network <span class="c1"># specify an existing (docker) network you want to connect to (string)</span>
|
|
--no-hostip <span class="c1"># disable the automatic injection of the Host IP as 'host.k3d.internal' into the containers and CoreDNS (default: false)</span>
|
|
--no-image-volume <span class="c1"># disable the creation of a volume for storing images (used for the 'k3d image import' command) (default: false)</span>
|
|
--no-lb <span class="c1"># disable the creation of a load balancer in front of the server nodes (default: false)</span>
|
|
--no-rollback <span class="c1"># disable the automatic rollback actions, if anything goes wrong (default: false)</span>
|
|
-p, --port <span class="c1"># add some more port mappings (format: '[HOST:][HOSTPORT:]CONTAINERPORT[/PROTOCOL][@NODEFILTER]', use flag multiple times)</span>
|
|
--registry-create <span class="c1"># create a new (docker) registry dedicated for this cluster (default: false)</span>
|
|
--registry-use <span class="c1"># use an existing local (docker) registry with this cluster (string, use multiple times)</span>
|
|
-s, --servers <span class="c1"># specify how many server nodes you want to create (integer, default: 1)</span>
|
|
--token <span class="c1"># specify a cluster token (string, default: auto-generated)</span>
|
|
--timeout <span class="c1"># specify a timeout, after which the cluster creation will be interrupted and changes rolled back (duration, e.g. '10s')</span>
|
|
-v, --volume <span class="c1"># specify additional bind-mounts (format: '[SOURCE:]DEST[@NODEFILTER[;NODEFILTER...]]', use flag multiple times)</span>
|
|
--wait <span class="c1"># enable waiting for all server nodes to be ready before returning (default: true)</span>
|
|
start CLUSTERNAME <span class="c1"># start a (stopped) cluster</span>
|
|
-a, --all <span class="c1"># start all clusters (default: false)</span>
|
|
--wait <span class="c1"># wait for all servers and server-loadbalancer to be up before returning (default: true)</span>
|
|
--timeout <span class="c1"># maximum waiting time for '--wait' before canceling/returning (duration, e.g. '10s')</span>
|
|
stop CLUSTERNAME <span class="c1"># stop a cluster</span>
|
|
-a, --all <span class="c1"># stop all clusters (default: false)</span>
|
|
delete CLUSTERNAME <span class="c1"># delete an existing cluster</span>
|
|
-a, --all <span class="c1"># delete all existing clusters (default: false)</span>
|
|
list <span class="o">[</span>CLUSTERNAME <span class="o">[</span>CLUSTERNAME ...<span class="o">]]</span>
|
|
--no-headers <span class="c1"># do not print headers (default: false)</span>
|
|
--token <span class="c1"># show column with cluster tokens (default: false)</span>
|
|
-o, --output <span class="c1"># format the output (format: 'json|yaml')</span>
|
|
completion <span class="o">[</span>bash <span class="p">|</span> zsh <span class="p">|</span> fish <span class="p">|</span> <span class="o">(</span>psh <span class="p">|</span> powershell<span class="o">)]</span> <span class="c1"># generate completion scripts for common shells</span>
|
|
config
|
|
init <span class="c1"># write a default k3d config (as a starting point)</span>
|
|
-f, --force <span class="c1"># force overwrite target file (default: false)</span>
|
|
-o, --output <span class="c1"># file to write to (string, default "k3d-default.yaml")</span>
|
|
<span class="nb">help</span> <span class="o">[</span>COMMAND<span class="o">]</span> <span class="c1"># show help text for any command</span>
|
|
image
|
|
import <span class="o">[</span>IMAGE <span class="p">|</span> ARCHIVE <span class="o">[</span>IMAGE <span class="p">|</span> ARCHIVE ...<span class="o">]]</span> <span class="c1"># Load one or more images from the local runtime environment or tar-archives into k3d clusters</span>
|
|
-c, --cluster <span class="c1"># clusters to load the image into (string, use flag multiple times, default: k3s-default)</span>
|
|
-k, --keep-tarball <span class="c1"># do not delete the image tarball from the shared volume after completion (default: false)</span>
|
|
kubeconfig
|
|
get <span class="o">(</span>CLUSTERNAME <span class="o">[</span>CLUSTERNAME ...<span class="o">]</span> <span class="p">|</span> --all<span class="o">)</span> <span class="c1"># get kubeconfig from cluster(s) and write it to stdout</span>
|
|
-a, --all <span class="c1"># get kubeconfigs from all clusters (default: false)</span>
|
|
merge <span class="p">|</span> write <span class="o">(</span>CLUSTERNAME <span class="o">[</span>CLUSTERNAME ...<span class="o">]</span> <span class="p">|</span> --all<span class="o">)</span> <span class="c1"># get kubeconfig from cluster(s) and merge it/them into a (kubeconfig-)file</span>
|
|
-a, --all <span class="c1"># get kubeconfigs from all clusters (default: false)</span>
|
|
-s, --kubeconfig-switch-context <span class="c1"># switch current-context in kubeconfig to the new context (default: true)</span>
|
|
-d, --kubeconfig-merge-default <span class="c1"># update the default kubeconfig (usually $KUBECONFIG or $HOME/.kube/config)</span>
|
|
-o, --output <span class="c1"># specify the output file where the kubeconfig should be written to (string)</span>
|
|
--overwrite <span class="c1"># [Careful!] forcefully overwrite the output file, ignoring existing contents (default: false)</span>
|
|
-u, --update <span class="c1"># update conflicting fields in existing kubeconfig (default: true)</span>
|
|
node
|
|
create NODENAME <span class="c1"># Create new nodes (and add them to existing clusters)</span>
|
|
-c, --cluster <span class="c1"># specify the cluster that the node shall connect to (string, default: k3s-default)</span>
|
|
-i, --image <span class="c1"># specify which k3s image should be used for the node(s) (string, default: 'docker.io/rancher/k3s:v1.20.0-k3s2', tag changes per build)</span>
|
|
--replicas <span class="c1"># specify how many replicas you want to create with this spec (integer, default: 1)</span>
|
|
--role <span class="c1"># specify the node role (string, format: 'agent|server', default: agent)</span>
|
|
--timeout <span class="c1"># specify a timeout duration, after which the node creation will be interrupted, if not done yet (duration, e.g. '10s')</span>
|
|
--wait <span class="c1"># wait for the node to be up and running before returning (default: true)</span>
|
|
start NODENAME <span class="c1"># start a (stopped) node</span>
|
|
stop NODENAME <span class="c1"># stop a node</span>
|
|
delete NODENAME <span class="c1"># delete an existing node</span>
|
|
-a, --all <span class="c1"># delete all existing nodes (default: false)</span>
|
|
list NODENAME
|
|
--no-headers <span class="c1"># do not print headers (default: false)</span>
|
|
registry
|
|
create REGISTRYNAME
|
|
-i, --image <span class="c1"># specify image used for the registry (string, default: "docker.io/library/registry:2")</span>
|
|
-p, --port <span class="c1"># select host port to map to (format: '[HOST:]HOSTPORT', default: 'random')</span>
|
|
delete REGISTRYNAME
|
|
-a, --all <span class="c1"># delete all existing registries (default: false)</span>
|
|
list <span class="o">[</span>NAME <span class="o">[</span>NAME...<span class="o">]]</span>
|
|
--no-headers <span class="c1"># disable table headers (default: false)</span>
|
|
version <span class="c1"># show k3d and k3s version</span>
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
<div class="md-source-date">
|
|
<small>
|
|
|
|
Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 5, 2021</span>
|
|
|
|
</small>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
|
|
|
|
<a href="../.." class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
<div class="md-footer-nav__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-nav__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Previous
|
|
</span>
|
|
Overview
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../kubeconfig/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
<div class="md-footer-nav__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Next
|
|
</span>
|
|
Handling Kubeconfigs
|
|
</div>
|
|
</div>
|
|
<div class="md-footer-nav__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>
|
|
|
|
<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 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>
|
|
|
|
<script src="../../assets/javascripts/vendor.93c04032.min.js"></script>
|
|
<script src="../../assets/javascripts/bundle.83e5331e.min.js"></script><script id="__lang" type="application/json">{"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"}</script>
|
|
|
|
<script>
|
|
app = initialize({
|
|
base: "../..",
|
|
features: ['tabs'],
|
|
search: Object.assign({
|
|
worker: "../../assets/javascripts/worker/search.8c7e0a7e.min.js"
|
|
}, typeof search !== "undefined" && search)
|
|
})
|
|
</script>
|
|
|
|
<script src="../../static/js/asciinema-player.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |