<!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/kubeconfig/" >
< 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 > Handling Kubeconfigs - 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 = "#handling-kubeconfigs" 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" >
Handling Kubeconfigs
< / 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" >
< a href = "../commands/" class = "md-nav__link" >
Command Tree
< / a >
< / li >
< 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" >
Handling Kubeconfigs
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Handling Kubeconfigs
< / 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-scrollfix >
< li class = "md-nav__item" >
< a href = "#getting-the-kubeconfig-for-a-newly-created-cluster" class = "md-nav__link" >
Getting the kubeconfig for a newly created cluster
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#removing-cluster-details-from-the-kubeconfig" class = "md-nav__link" >
Removing cluster details from the kubeconfig
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#handling-multiple-clusters" class = "md-nav__link" >
Handling multiple clusters
< / a >
< / li >
< / ul >
< / nav >
< / 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" >
< 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-scrollfix >
< li class = "md-nav__item" >
< a href = "#getting-the-kubeconfig-for-a-newly-created-cluster" class = "md-nav__link" >
Getting the kubeconfig for a newly created cluster
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#removing-cluster-details-from-the-kubeconfig" class = "md-nav__link" >
Removing cluster details from the kubeconfig
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#handling-multiple-clusters" class = "md-nav__link" >
Handling multiple clusters
< / a >
< / li >
< / ul >
< / 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/kubeconfig.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 = "handling-kubeconfigs" > Handling Kubeconfigs< a class = "headerlink" href = "#handling-kubeconfigs" title = "Permanent link" > ¶ < / a > < / h1 >
< p > By default, k3d will update your default kubeconfig with your new cluster’ s details and set the current-context to it (can be disabled).
To get a kubeconfig set up for you to connect to a k3d cluster without this automatism, you can go different ways.< / p >
< details class = "question" > < summary > What is the default kubeconfig?< / summary > < p > We determine the path of the used or default kubeconfig in two ways:< / p >
< ol >
< li > Using the < code > KUBECONFIG< / code > environment variable, if it specifies < em > exactly one< / em > file< / li >
< li > Using the default path (e.g. on Linux it’ s < code class = "highlight" > < span class = "nv" > $HOME< / span > /.kube/config< / code > )< / li >
< / ol >
< / details >
< h2 id = "getting-the-kubeconfig-for-a-newly-created-cluster" > Getting the kubeconfig for a newly created cluster< a class = "headerlink" href = "#getting-the-kubeconfig-for-a-newly-created-cluster" title = "Permanent link" > ¶ < / a > < / h2 >
< ol >
< li > Create a new kubeconfig file < strong > after< / strong > cluster creation< ul >
< li > < code class = "highlight" > k3d kubeconfig write mycluster< / code > < / li >
< li > < em > Note:< / em > this will create (or update) the file < code > $HOME/.k3d/kubeconfig-mycluster.yaml< / code > < / li >
< li > < em > Tip:< / em > Use it: < code class = "highlight" > < span class = "nb" > export< / span > < span class = "nv" > KUBECONFIG< / span > < span class = "o" > =< / span > < span class = "k" > $(< / span > k3d kubeconfig write mycluster< span class = "k" > )< / span > < / code > < / li >
< li > < em > Note 2< / em > : alternatively you can use < code class = "highlight" > k3d kubeconfig get mycluster > some-file.yaml< / code > < / li >
< / ul >
< / li >
< li > Update your default kubeconfig < strong > upon< / strong > cluster creation (DEFAULT)< ul >
< li > < code class = "highlight" > k3d cluster create mycluster --kubeconfig-update-default< / code > < ul >
< li > < em > Note:< / em > this won’ t switch the current-context (append < code > --kubeconfig-switch-context< / code > to do so)< / li >
< / ul >
< / li >
< / ul >
< / li >
< li > Update your default kubeconfig < strong > after< / strong > cluster creation< ul >
< li > < code class = "highlight" > k3d kubeconfig merge mycluster --kubeconfig-merge-default< / code > < ul >
< li > < em > Note:< / em > this won’ t switch the current-context (append < code > --kubeconfig-switch-context< / code > to do so)< / li >
< / ul >
< / li >
< / ul >
< / li >
< li > Update a different kubeconfig < strong > after< / strong > cluster creation< ul >
< li > < code class = "highlight" > k3d kubeconfig merge mycluster --output some/other/file.yaml< / code > < ul >
< li > < em > Note:< / em > this won’ t switch the current-context< / li >
< / ul >
< / li >
< li > The file will be created if it doesn’ t exist< / li >
< / ul >
< / li >
< / ol >
< div class = "admonition info" >
< p class = "admonition-title" > Switching the current context< / p >
< p > None of the above options switch the current-context by default.
This is intended to be least intrusive, since the current-context has a global effect.
You can switch the current-context directly with the < code > kubeconfig merge< / code > command by adding the < code > --kubeconfig-switch-context< / code > flag.< / p >
< / div >
< h2 id = "removing-cluster-details-from-the-kubeconfig" > Removing cluster details from the kubeconfig< a class = "headerlink" href = "#removing-cluster-details-from-the-kubeconfig" title = "Permanent link" > ¶ < / a > < / h2 >
< p > < code class = "highlight" > k3d cluster delete mycluster< / code > will always remove the details for < code > mycluster< / code > from the default kubeconfig.
It will also delete the respective kubeconfig file in < code > $HOME/.k3d/< / code > if it exists.< / p >
< h2 id = "handling-multiple-clusters" > Handling multiple clusters< a class = "headerlink" href = "#handling-multiple-clusters" title = "Permanent link" > ¶ < / a > < / h2 >
< p > < code > k3d kubeconfig merge< / code > let’ s you specify one or more clusters via arguments < em > or< / em > all via < code > --all< / code > .
All kubeconfigs will then be merged into a single file if < code > --kubeconfig-merge-default< / code > or < code > --output< / code > is specified.
If none of those two flags was specified, a new file will be created per cluster and the merged path (e.g. < code > $HOME/.k3d/kubeconfig-cluster1.yaml:$HOME/.k3d/cluster2.yaml< / code > ) will be returned.
Note, that with multiple cluster specified, the < code > --kubeconfig-switch-context< / code > flag will change the current context to the cluster which was last in the list.< / p >
< 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 = "../commands/" 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 >
Command Tree
< / div >
< / div >
< / a >
< a href = "../multiserver/" 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 >
Creating multi-server clusters
< / 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 >