Skip to content

Commit 231efe1

Browse files
committed
Update documentation on available structs
* Document the Network struct introduced by #144 * Document the IPv6 support introduced by #122
1 parent 4194501 commit 231efe1

File tree

1 file changed

+33
-16
lines changed

1 file changed

+33
-16
lines changed

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -195,25 +195,42 @@ Within the templates, the object emitted by docker-gen will be a structure consi
195195

196196
```go
197197
type RuntimeContainer struct {
198-
ID string
199-
Addresses []Address
200-
Gateway string
201-
Name string
202-
Hostname string
203-
Image DockerImage
204-
Env map[string]string
205-
Volumes map[string]Volume
206-
Node SwarmNode
207-
Labels map[string]string
208-
IP string
198+
ID string
199+
Addresses []Address
200+
Networks []Network
201+
Gateway string
202+
Name string
203+
Hostname string
204+
Image DockerImage
205+
Env map[string]string
206+
Volumes map[string]Volume
207+
Node SwarmNode
208+
Labels map[string]string
209+
IP string
210+
IP6LinkLocal string
211+
IP6Global string
209212
}
210213

211214
type Address struct {
212-
IP string
213-
Port string
214-
HostPort string
215-
Proto string
216-
HostIP string
215+
IP string
216+
IP6LinkLocal string
217+
IP6Global string
218+
Port string
219+
HostPort string
220+
Proto string
221+
HostIP string
222+
}
223+
224+
type Network struct {
225+
IP string
226+
Name string
227+
Gateway string
228+
EndpointID string
229+
IPv6Gateway string
230+
GlobalIPv6Address string
231+
MacAddress string
232+
GlobalIPv6PrefixLen int
233+
IPPrefixLen int
217234
}
218235

219236
type DockerImage struct {

0 commit comments

Comments
 (0)