Skip to content

Commit 522df0c

Browse files
phlogistonjohnmergify[bot]
authored andcommitted
docs: document new interface filtering options
Signed-off-by: John Mulligan <[email protected]>
1 parent 262bc9f commit 522df0c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/configuration.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,35 @@ Each domain configuration section is as follows:
259259
* `realm` - Name of the domain in kerberos realm form.
260260
* `short_domain` - Optional. The short (nt-style) name of the domain.
261261
* `admin_password` - The default password for the administrator user.
262+
* `interfaces` - An optional subsection for dynamically configuring the network
263+
interfaces the domain controller will use. See below.
264+
265+
#### Interfaces Section
266+
267+
The interfaces section enables the sambacc tool to dynamically configure what
268+
network interfaces will be enabled when the domain is provisioned. On some
269+
systems and in some environments there may be "bogus" network interfaces that
270+
one does not want to enable the domain controller for. Examples include
271+
interfaces related to virtualization or container engines that would cause the
272+
DC to include a private or otherwise inaccessable IP to be included in the DNS
273+
record(s) for the domain & domain controller.
274+
275+
The loopback device ("lo") is always enabled.
276+
277+
* `include_pattern` - Optional string. A regular expression that must match
278+
the name of an interface for that interface to be included.
279+
Example: `^eno[0-9]+$`
280+
* `exclude_pattern` - Optional string. A regular expression that must not
281+
match the name of an interface for that interface to be included.
282+
The `exclude_pattern` option takes precedence over the `include_pattern`
283+
option.
284+
Example: `^(docker|virbr)[0-9]+$`
285+
286+
These options are intended to automate the act of examining a host's interfaces
287+
prior to deployment and creating a list of suitable interfaces prior to setting
288+
the "interfaces" and "bind interfaces only" parameters. See the [Samba
289+
Wiki page](https://wiki.samba.org/index.php/Setting_up_Samba_as_an_Active_Directory_Domain_Controller#Parameter_Reference)
290+
for more details on this operation.
262291

263292

264293
## Domain Groups Section

0 commit comments

Comments
 (0)