2022-01-14 06:55:54 +08:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "lang:clipboard.copy" content = "Copy to clipboard" >
< meta name = "lang:clipboard.copied" content = "Copied to clipboard" >
< meta name = "lang:search.language" content = "en" >
< meta name = "lang:search.pipeline.stopwords" content = "True" >
< meta name = "lang:search.pipeline.trimmer" content = "True" >
< meta name = "lang:search.result.none" content = "No matching documents" >
< meta name = "lang:search.result.one" content = "1 matching document" >
< meta name = "lang:search.result.other" content = "# matching documents" >
< meta name = "lang:search.tokenizer" content = "[\s\-]+" >
< link href = "https://fonts.gstatic.com/" rel = "preconnect" crossorigin >
< link href = "https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel = "stylesheet" >
< style >
body,
input {
font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif
}
code,
kbd,
pre {
font-family: "Roboto Mono", "Courier New", Courier, monospace
}
< / style >
< link rel = "stylesheet" href = "_static/stylesheets/application.css" / >
< link rel = "stylesheet" href = "_static/stylesheets/application-palette.css" / >
< link rel = "stylesheet" href = "_static/stylesheets/application-fixes.css" / >
< link rel = "stylesheet" href = "_static/fonts/material-icons.css" / >
< meta name = "theme-color" content = "#3f51b5" >
< script src = "_static/javascripts/modernizr.js" > < / script >
2022-02-09 22:11:01 +08:00
< title > Upgrades — Netmaker 0.10.0 documentation< / title >
2022-01-14 06:55:54 +08:00
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "_static/material.css" / >
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< link rel = "author" title = "About these documents" href = "about.html" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Troubleshooting" href = "troubleshoot.html" / >
< link rel = "prev" title = "API Reference" href = "api.html" / >
< / head >
< body dir = ltr
data-md-color-primary=indigo data-md-color-accent=light-blue>
< svg class = "md-svg" >
< defs data-children-count = "0" >
< svg xmlns = "http://www.w3.org/2000/svg" width = "416" height = "448" viewBox = "0 0 416 448" id = "__github" > < path fill = "currentColor" d = "M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z" / > < / svg >
< / defs >
< / svg >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" >
< label class = "md-overlay" data-md-component = "overlay" for = "__drawer" > < / label >
< a href = "#upgrades" tabindex = "1" class = "md-skip" > Skip to content < / a >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header-nav md-grid" >
< div class = "md-flex navheader" >
< div class = "md-flex__cell md-flex__cell--shrink" >
2022-02-09 22:11:01 +08:00
< a href = "index.html" title = "Netmaker 0.10.0 documentation"
2022-01-14 06:55:54 +08:00
class="md-header-nav__button md-logo">
< i class = "md-icon" > & #xe869< / i >
< / a >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< label class = "md-icon md-icon--menu md-header-nav__button" for = "__drawer" > < / label >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch" >
< div class = "md-flex__ellipsis md-header-nav__title" data-md-component = "title" >
< span class = "md-header-nav__topic" > Netmaker Docs< / span >
< span class = "md-header-nav__topic" > Upgrades < / span >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< label class = "md-icon md-icon--search md-header-nav__button" for = "__search" > < / 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" action = "search.html" method = "get" name = "search" >
< input type = "text" class = "md-search__input" name = "q" placeholder = "Search"
autocapitalize="off" autocomplete="off" spellcheck="false"
data-md-component="query" data-md-state="active">
< label class = "md-icon md-search__icon" for = "__search" > < / label >
< button type = "reset" class = "md-icon md-search__icon" data-md-component = "reset" tabindex = "-1" >

< / button >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "result" >
< div class = "md-search-result__meta" >
Type to start searching
< / div >
< ol class = "md-search-result__list" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" >
< div class = "md-header-nav__source" >
< a href = "https://github.com/gravitl/netmaker/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "0 0 24 24" width = "28" height = "28" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
Netmaker
< / div >
< / a >
< / div >
< / div >
< script src = "_static/javascripts/version_dropdown.js" > < / script >
< script >
var json_loc = ""versions.json"",
target_loc = "../",
text = "Versions";
$( document ).ready( add_version_dropdown(json_loc, target_loc, text));
< / script >
< / div >
< / nav >
< / header >
< div class = "md-container" >
< nav class = "md-tabs" data-md-component = "tabs" >
< div class = "md-tabs__inner md-grid" >
< ul class = "md-tabs__list" >
2022-02-09 22:11:01 +08:00
< li class = "md-tabs__item" > < a href = "index.html" class = "md-tabs__link" > Netmaker 0.10.0 documentation< / a > < / li >
2022-01-14 06:55:54 +08:00
< / ul >
< / div >
< / nav >
< main class = "md-main" >
< div class = "md-main__inner md-grid" data-md-component = "container" >
< 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" data-md-level = "0" >
< label class = "md-nav__title md-nav__title--site" for = "__drawer" >
2022-02-09 22:11:01 +08:00
< a href = "index.html" title = "Netmaker 0.10.0 documentation" class = "md-nav__button md-logo" >
2022-01-14 06:55:54 +08:00
< i class = "md-icon" > & #xe869< / i >
< / a >
< a href = "index.html"
2022-02-09 22:11:01 +08:00
title="Netmaker 0.10.0 documentation">Netmaker Docs< / a >
2022-01-14 06:55:54 +08:00
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/gravitl/netmaker/" title = "Go to repository" class = "md-source" data-md-source = "github" >
< div class = "md-source__icon" >
< svg xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" viewBox = "0 0 24 24" width = "28" height = "28" >
< use xlink:href = "#__github" width = "24" height = "24" > < / use >
< / svg >
< / div >
< div class = "md-source__repository" >
Netmaker
< / div >
< / a >
< / div >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "about.html" class = "md-nav__link" > About< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
< a href = "architecture.html" class = "md-nav__link" > Architecture< / a >
< / li >
< li class = "md-nav__item" >
< a href = "install.html" class = "md-nav__link" > Install< / a >
< / li >
< li class = "md-nav__item" >
< a href = "quick-start.html" class = "md-nav__link" > Quick Install< / a >
< / li >
< li class = "md-nav__item" >
< a href = "getting-started.html" class = "md-nav__link" > Getting Started< / a >
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "external-clients.html" class = "md-nav__link" > Ingress + External Clients< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "egress-gateway.html" class = "md-nav__link" > Egress Gateway< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "relay-server.html" class = "md-nav__link" > Relay Servers< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-18 00:28:28 +08:00
< a href = "https://k8s.netmaker.org" class = "md-nav__link" > Kubernetes< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "server-installation.html" class = "md-nav__link" > Advanced Server Installation< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "client-installation.html" class = "md-nav__link" > Advanced Client Installation< / a >
< / li >
< li class = "md-nav__item" >
< a href = "oauth.html" class = "md-nav__link" > Integrating OAuth< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-01-16 23:09:19 +08:00
< a href = "usage.html" class = "md-nav__link" > External Guides< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
< a href = "ui-reference.html" class = "md-nav__link" > UI Reference< / a >
< / li >
< li class = "md-nav__item" >
< a href = "api.html" class = "md-nav__link" > API Reference< / a >
< / li >
< li class = "md-nav__item" >
< input class = "md-toggle md-nav__toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" > Upgrades < / label >
< a href = "#" class = "md-nav__link md-nav__link--active" > Upgrades< / a >
< nav class = "md-nav md-nav--secondary" >
< label class = "md-nav__title" for = "__toc" > Contents< / label >
< ul class = "md-nav__list" data-md-scrollfix = "" >
< li class = "md-nav__item" > < a href = "#upgrades--page-root" class = "md-nav__link" > Upgrades< / a > < nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" > < a href = "#introduction" class = "md-nav__link" > Introduction< / a >
< / li >
2022-02-09 22:11:01 +08:00
< li class = "md-nav__item" > < a href = "#critical-notes-for-0-10-0" class = "md-nav__link" > Critical Notes for 0.10.0< / a >
2022-01-14 06:55:54 +08:00
< / li >
2022-02-09 22:11:01 +08:00
< li class = "md-nav__item" > < a href = "#upgrade-the-server-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Server (prior to 0.10.0)< / a >
< / li >
< li class = "md-nav__item" > < a href = "#upgrade-the-clients-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Clients (prior to 0.10.0)< / a >
2022-01-14 06:55:54 +08:00
< / li > < / ul >
< / nav >
< / li >
< / ul >
< / nav >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#introduction" class = "md-nav__link" > Introduction< / a >
< / li >
< li class = "md-nav__item" >
2022-02-09 22:11:01 +08:00
< a href = "#critical-notes-for-0-10-0" class = "md-nav__link" > Critical Notes for 0.10.0< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#upgrade-the-server-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Server (prior to 0.10.0)< / a >
2022-01-14 06:55:54 +08:00
< / li >
< li class = "md-nav__item" >
2022-02-09 22:11:01 +08:00
< a href = "#upgrade-the-clients-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Clients (prior to 0.10.0)< / a >
2022-01-14 06:55:54 +08:00
< / li > < / ul >
< / li >
< li class = "md-nav__item" >
< a href = "troubleshoot.html" class = "md-nav__link" > Troubleshooting< / a >
< / li >
< li class = "md-nav__item" >
< a href = "support.html" class = "md-nav__link" > Support< / a >
< / li >
< li class = "md-nav__item" >
< a href = "conduct.html" class = "md-nav__link" > Code of Conduct< / a >
< / li >
< li class = "md-nav__item" >
< a href = "license.html" class = "md-nav__link" > License< / a >
< / 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" >
< label class = "md-nav__title" for = "__toc" > Contents< / label >
< ul class = "md-nav__list" data-md-scrollfix = "" >
< li class = "md-nav__item" > < a href = "#upgrades--page-root" class = "md-nav__link" > Upgrades< / a > < nav class = "md-nav" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" > < a href = "#introduction" class = "md-nav__link" > Introduction< / a >
< / li >
2022-02-09 22:11:01 +08:00
< li class = "md-nav__item" > < a href = "#critical-notes-for-0-10-0" class = "md-nav__link" > Critical Notes for 0.10.0< / a >
< / li >
< li class = "md-nav__item" > < a href = "#upgrade-the-server-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Server (prior to 0.10.0)< / a >
2022-01-14 06:55:54 +08:00
< / li >
2022-02-09 22:11:01 +08:00
< li class = "md-nav__item" > < a href = "#upgrade-the-clients-prior-to-0-10-0" class = "md-nav__link" > Upgrade the Clients (prior to 0.10.0)< / a >
2022-01-14 06:55:54 +08:00
< / li > < / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" >
< article class = "md-content__inner md-typeset" role = "main" >
< h1 id = "upgrades--page-root" > Upgrades< a class = "headerlink" href = "#upgrades--page-root" title = "Permalink to this headline" > ¶< / a > < / h1 >
< h2 id = "introduction" > Introduction< a class = "headerlink" href = "#introduction" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-02-09 22:11:01 +08:00
< p > As of 0.10.0, upgrading Netmaker is a manual process. This is expected to be automated in the future, but for now is still a relatively straightforward process.< / p >
< h2 id = "critical-notes-for-0-10-0" > Critical Notes for 0.10.0< a class = "headerlink" href = "#critical-notes-for-0-10-0" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > At the time of this writing, an upgrade process has not been defined for 0.10.0. DO NOT follow this documentation to upgrade from a prior version to 0.10.0. An upgrade process will be defined shortly. For now, if you seek to upgrade to 0.10.0, you must clear your server entirely (docker-compose down – < / p >
2022-01-14 06:55:54 +08:00
2022-02-09 22:11:01 +08:00
< h2 id = "upgrade-the-server-prior-to-0-10-0" > Upgrade the Server (prior to 0.10.0)< a class = "headerlink" href = "#upgrade-the-server-prior-to-0-10-0" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-01-16 23:09:19 +08:00
< p > To upgrade the server, you only need to change the docker image versions:< / p >
< ol class = "arabic simple" >
< li > < p > < cite > ssh root@my-server-ip< / cite > < / p > < / li >
2022-01-23 01:57:59 +08:00
< li > < p > < cite > docker-compose down< / cite > < / p > < / li >
2022-01-16 23:09:19 +08:00
< li > < p > < cite > vi docker-compose.yml< / cite > < / p > < / li >
< li > < p > Change gravitl/netmaker:< version> and gravitl/netmaker-ui:< version> to the new version.< / p > < / li >
< li > < p > Save and close the file< / p > < / li >
< li > < p > < cite > docker-compose up -d< / cite > < / p > < / li >
< / ol >
2022-01-14 06:55:54 +08:00
2022-02-09 22:11:01 +08:00
< h2 id = "upgrade-the-clients-prior-to-0-10-0" > Upgrade the Clients (prior to 0.10.0)< a class = "headerlink" href = "#upgrade-the-clients-prior-to-0-10-0" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-01-16 23:09:19 +08:00
< p > To upgrade the client, you must get the new client binary and place it in /etc/netclient. Depending on the new vs. old version, there may be minor incompatibilities (discussed below).< / p >
< ol class = "arabic simple" >
< li > < p > Vists < a class = "reference external" href = "https://github.com/gravitl/netmaker/releases/" > https://github.com/gravitl/netmaker/releases/< / a > < / p > < / li >
< li > < p > Find the appropriate binary for your machine.< / p > < / li >
< li > < p > Download. E.x.: < cite > wget https://github.com/gravitl/netmaker/releases/download/vX.X.X/netclient-myversion< / cite > < / p > < / li >
< li > < p > Rename binary to < cite > netclient< / cite > and move to folder. E.x.: < cite > mv netclient-myversion /etc/netclient/netclient< / cite > < / p > < / li >
< li > < p > < cite > netclient – < / cite > (confirm it’ < / p > < / li >
< li > < p > < cite > netclient pull< / cite > < / p > < / li >
< / ol >
< p > This last step helps ensure any newly added fields are now present. You may run into a “panic” based on missing fields and your version mismatch. In such cases, you can either:< / p >
< ol class = "arabic simple" >
< li > < p > Add the missing field to /etc/netclient/config/netconfig-yournetwork and then run “netclient checkin”< / p > < / li >
< / ol >
< p > or< / p >
< ol class = "arabic simple" start = "2" >
< li > < p > Leave and rejoin the network< / p > < / li >
< / ol >
2022-01-14 06:55:54 +08:00
< / article >
< / div >
< / div >
< / main >
< / div >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" >
< a href = "api.html" title = "API Reference"
class="md-flex md-footer-nav__link md-footer-nav__link--prev"
rel="prev">
< div class = "md-flex__cell md-flex__cell--shrink" >
< i class = "md-icon md-icon--arrow-back md-footer-nav__button" > < / i >
< / div >
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" >
< span class = "md-flex__ellipsis" >
< span
class="md-footer-nav__direction"> Previous < / span > API Reference < / span >
< / div >
< / a >
< a href = "troubleshoot.html" title = "Troubleshooting"
class="md-flex md-footer-nav__link md-footer-nav__link--next"
rel="next">
< div class = "md-flex__cell md-flex__cell--stretch md-footer-nav__title" > < span
class="md-flex__ellipsis"> < span
class="md-footer-nav__direction"> Next < / span > Troubleshooting < / span >
< / div >
< div class = "md-flex__cell md-flex__cell--shrink" > < i
class="md-icon md-icon--arrow-forward md-footer-nav__button">< / i >
< / 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 2021, Alex Feiszli.
< / div >
Created using
< a href = "http://www.sphinx-doc.org/" > Sphinx< / a > 4.3.0.
and
< a href = "https://github.com/bashtage/sphinx-material/" > Material for
Sphinx< / a >
< / div >
< / div >
< / div >
< / footer >
< script src = "_static/javascripts/application.js" > < / script >
< script > app . initialize ( { version : "1.0.4" , url : { base : ".." } } ) < / script >
< / body >
< / html >
