You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/nw-multus-ipam-object.adoc
+52-34Lines changed: 52 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,8 @@ endif::[]
21
21
[id="nw-multus-ipam-object_{context}"]
22
22
= Configuration for ipam CNI plug-in
23
23
24
-
The IP address management (IPAM) Container Network Interface (CNI) plug-in manages IP address assignment for other CNI plug-ins. You can configure ipam for either static IP address assignment or dynamic IP address assignment by using DHCP. The DHCP server you specify must be reachable from the additional network.
24
+
The ipam Container Network Interface (CNI) plug-in provides IP address management (IPAM) for other CNI plug-ins.
25
+
You can configure ipam for either static IP address assignment or dynamic IP address assignment by using DHCP. The DHCP server you specify must be reachable from the additional network.
25
26
26
27
ifdef::json[]
27
28
The following JSON configuration object describes the parameters that you can set.
@@ -31,65 +32,82 @@ ifdef::yaml[]
31
32
The following YAML configuration describes the parameters that you can set.
32
33
endif::yaml[]
33
34
35
+
////
34
36
IMPORTANT: If you set the `type` parameter to the `DHCP` value, you cannot set
35
37
any other parameters.
38
+
////
36
39
37
40
ifdef::json[]
38
-
.ipam CNI plug-in JSON configuration object
41
+
[id="nw-multus-static_{context}"]
42
+
== Static IP address assignment configuration
43
+
44
+
The following JSON describes the configuration for static IP address assignment:
45
+
46
+
.Static assignment configuration
39
47
[source,json]
40
48
----
41
49
{
42
50
"ipam": {
43
-
"type": "<type>", <1>
44
-
"addresses": [ <2>
51
+
"type": "static",
52
+
"addresses": [ <1>
45
53
{
46
-
"address": "<address>", <3>
47
-
"gateway": "<gateway>" <4>
54
+
"address": "<address>", <2>
55
+
"gateway": "<gateway>" <3>
48
56
}
49
57
],
50
-
"routes": [ <5>
58
+
"routes": [ <4>
51
59
{
52
-
"dst": "<dst>" <6>
53
-
"gw": "<gw>" <7>
60
+
"dst": "<dst>" <5>
61
+
"gw": "<gw>" <6>
54
62
}
55
63
],
56
-
"dns": { <8>
57
-
"nameservers": ["<nameserver>"], <9>
58
-
"domain": "<domain>", <10>
59
-
"search": ["<search_domain>"] <11>
64
+
"dns": { <7>
65
+
"nameservers": ["<nameserver>"], <8>
66
+
"domain": "<domain>", <9>
67
+
"search": ["<search_domain>"] <10>
60
68
}
61
69
}
62
70
}
63
71
----
64
-
<1> Specify `static` to configure the plug-in to manage IP address assignment.
65
-
Specify `DHCP` to allow a DHCP server to manage IP address assignment. You
66
-
cannot specify any additional parameters if you specify a value of `DHCP`.
67
-
68
-
<2> An array describing IP addresses to assign to the virtual interface. Both
72
+
<1> An array describing IP addresses to assign to the virtual interface. Both
69
73
IPv4 and IPv6 IP addresses are supported.
70
74
71
-
<3> A block of IP addresses that you specify in CIDR format to assign
72
-
to Pods on a worker node, such as `10.1.1.0/24`.
75
+
<2> An IP address that you specify.
73
76
74
-
<4> The default gateway to route egress network traffic to.
77
+
<3> The default gateway to route egress network traffic to.
75
78
76
-
<5> An array describing routes to configure inside the Pod.
79
+
<4> An array describing routes to configure inside the Pod.
77
80
78
-
<6> The IP address range in CIDR format.
81
+
<5> The IP address range in CIDR format.
79
82
80
-
<7> The gateway where network traffic is routed.
83
+
<6> The gateway where network traffic is routed.
81
84
82
-
<8> Optional: DNS configuration.
85
+
<7> Optional: DNS configuration.
83
86
84
-
<9> An of array of one or more IP addresses for to send DNS queries to.
87
+
<8> An of array of one or more IP addresses for to send DNS queries to.
85
88
86
-
<10> The default domain to append to a host name. For example, if the
89
+
<9> The default domain to append to a host name. For example, if the
87
90
domain is set to `example.com`, a DNS lookup query for `example-host` is
88
91
rewritten as `example-host.example.com`.
89
92
90
-
<11> An array of domain names to append to an unqualified host name,
93
+
<10> An array of domain names to append to an unqualified host name,
91
94
such as `example-host`, during a DNS lookup query.
92
95
96
+
[id="nw-multus-dhcp_{context}"]
97
+
== Dynamic IP address assignment configuration
98
+
99
+
The following JSON describes the configuration for dynamic IP address assignment with DHCP:
100
+
101
+
.DHCP assignment configuration
102
+
[source,json]
103
+
----
104
+
{
105
+
"ipam": {
106
+
"type": "dhcp"
107
+
}
108
+
}
109
+
----
110
+
93
111
[id="nw-multus-static-example_{context}"]
94
112
== Static IP address assignment configuration example
95
113
@@ -109,22 +127,23 @@ You can configure ipam for static IP address assignment:
109
127
}
110
128
----
111
129
112
-
[id="nw-multus-dynamic-example_{context}"]
113
-
== Dynamic IP address assignment configuration example
130
+
[id="nw-multus-dhcp-example_{context}"]
131
+
== Dynamic IP address assignment configuration example using DHCP
114
132
115
133
You can configure ipam for DHCP:
116
134
117
135
[source,json]
118
136
----
119
137
{
120
138
"ipam": {
121
-
"type": "DHCP"
139
+
"type": "dhcp"
122
140
}
123
141
}
124
142
----
125
143
endif::json[]
126
144
127
-
// YAML uses collection and mapping to describe arrays and objects
145
+
// YAML configuration is only relevant to `simpleMacvlanConfig`
146
+
// This is limited by the fields that the CNO accepts
128
147
129
148
ifdef::yaml[]
130
149
.ipam CNI plug-in YAML configuration object
@@ -168,8 +187,7 @@ ipamConfig:
168
187
<1> A collection of mappings that define IP addresses to assign to the virtual
169
188
interface. Both IPv4 and IPv6 IP addresses are supported.
170
189
171
-
<2> A block of IP addresses that you specify in CIDR format to assign
172
-
to Pods on a worker node, such as `10.1.1.0/24`.
190
+
<2> An IP address that you specify.
173
191
174
192
<3> The default gateway to route egress network traffic to.
0 commit comments