-
Notifications
You must be signed in to change notification settings - Fork 34
/
index.html
71 lines (66 loc) · 3.64 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{% extends 'base_layout.html' %}
{% block title %}Netplan{% endblock %}
{% block meta_description %}Backend-agnostic network configuration in YAML.{% endblock %}
{% block content %}
<div id="main-content" class="p-strip is-bordered is-deep">
<div class="row">
<div class="col-8 col-medium-4">
<h1>Netplan</h1>
<p class="p-heading--4">
The network configuration abstraction renderer
</p>
<p>Netplan is a utility for easily configuring networking on a linux system. You simply create a YAML description of the required network interfaces and what each should be configured to do. From this description Netplan will generate all the necessary configuration for your chosen renderer tool.</p>
</div>
<div class="col-4 col-medium-2 u-vertically-center u-align--center u-hide--small">
<img src="https://assets.ubuntu.com/v1/0fbee9c4-pictogram_internet01.svg?w=200" width="200" alt="" />
</div>
</div>
</div>
<div id="how-does-it-work" class="p-strip--light is-bordered is-deep">
<div class="row u-vertically-center">
<div class="col-8 col-medium-4">
<h2>How does it work?</h2>
<p>Netplan reads network configuration from <code>/etc/netplan/*.yaml</code> which are written by administrators, installers, cloud image instantiations, or other OS deployments. During early boot, Netplan generates backend specific configuration files in <code>/run</code> to hand off control of devices to a particular networking daemon.</p>
<p>Netplan currently works with these supported renderers</p>
<ul class="p-list">
<li class="p-list__item is-ticked">
<a href="https://help.ubuntu.com/community/NetworkManager">NetworkManager</a>
</li>
<li class="p-list__item is-ticked">
<a href="http://manpages.ubuntu.com/manpages/bionic/man5/systemd.network.5.html">Systemd-networkd</a>
</li>
</ul>
</div>
<div class="col-4 col-medium-2 u-align--center u-hide--small">
<img src="https://assets.ubuntu.com/v1/a1a80854-netplan_design_overview.svg" width="300" alt="" />
</div>
</div>
</div>
<div id="quick-start" class="p-strip is-bordered is-deep">
<div class="row">
<div class="col-12">
<h2>How do I use it?</h2>
</div>
</div>
<div class="row">
<div class="col-6 col-medium-3">
<h3>Configuration</h3>
<p>Without configuration, Netplan will not do anything. The simplest configuration snippet (to bring up things via DHCP on workstations) is as follows:</p>
<pre><code>network:
version: 2
renderer: NetworkManager</code></pre>
<p>This will make Netplan hand over control to NetworkManager, which will manage all devices in its default way (i.e. any ethernet device will come up with DHCP once carrier is detected).</p>
<p>When individual interface configurations are given, it will not let devices automatically come up using DHCP, but each interface needs to be specified in a file in /etc/netplan/ with its explicit YAML settings for the networkd or NetworkManager backend renderers.</p>
</div>
<div class="col-6 col-medium-3">
<h3>Commands</h3>
<p>Netplan uses a set of subcommands to drive its behavior:</p>
<ul>
<li><strong>netplan generate</strong>: Use <code>/etc/netplan</code> to generate the required configuration for the renderers.</li>
<li><strong>netplan apply</strong>: Apply all configuration for the renderers, restarting them as necessary.</li>
<li><strong>netplan try</strong>: Apply configuration and wait for user confirmation; will roll back if network is broken or no confirmation is given.</li>
</ul>
</div>
</div>
</div>
{% endblock content %}