Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add generated documentation for network zones #847

Merged
merged 3 commits into from
May 6, 2024
Merged

Add generated documentation for network zones #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb40017
incusd/network/zone: add gendoc for network zone
rpunjani May 6, 2024
135176c
doc: Update configs
rpunjani May 6, 2024
8307649
doc: Use gen doc for network zones
rpunjani May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions doc/config_options.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,44 @@ This template gets access to the project name (`projectName`), integration name
```

<!-- config group network_integration-ovn end -->
<!-- config group network_zone-common start -->
```{config:option} dns.nameservers network_zone-common
:required: "no"
:shortdesc: "Comma-separated list of DNS server FQDNs (for NS records)"
:type: "string set"

```

```{config:option} network.nat network_zone-common
:defaultdesc: "`true`"
:required: "no"
:shortdesc: "Whether to generate records for NAT-ed subnets"
:type: "bool"

```

```{config:option} peers.NAME.address network_zone-common
:required: "no"
:shortdesc: "IP address of a DNS server"
:type: "string"

```

```{config:option} peers.NAME.key network_zone-common
:required: "no"
:shortdesc: "TSIG key for the server"
:type: "string"

```

```{config:option} user.* network_zone-common
:required: "no"
:shortdesc: "User-provided free-form key/value pairs"
:type: "string"

```

<!-- config group network_zone-common end -->
<!-- config group project-features start -->
```{config:option} features.images project-features
:defaultdesc: "`false`"
Expand Down
12 changes: 5 additions & 7 deletions doc/howto/network_zones.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,11 @@ incus network zone edit <network_zone>

The following configuration options are available for network zones:

Key | Type | Required | Default | Description
:-- | :-- | :-- | - | :--
`peers.NAME.address`| string | no | - | IP address of a DNS server
`peers.NAME.key` | string | no | - | TSIG key for the server
`dns.nameservers` | string set | no | - | Comma-separated list of DNS server FQDNs (for NS records)
`network.nat` | bool | no | `true` | Whether to generate records for NAT-ed subnets
`user.*` | * | no | - | User-provided free-form key/value pairs
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_zone-common start -->
:end-before: <!-- config group network_zone-common end -->
```

```{note}
When generating the TSIG key using `tsig-keygen`, the key name must follow the format `<zone_name>_<peer_name>.`.
Expand Down
47 changes: 47 additions & 0 deletions internal/server/metadata/configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1482,6 +1482,53 @@
]
}
},
"network_zone": {
"common": {
"keys": [
{
"dns.nameservers": {
"longdesc": "",
"required": "no",
"shortdesc": "Comma-separated list of DNS server FQDNs (for NS records)",
"type": "string set"
}
},
{
"network.nat": {
"defaultdesc": "`true`",
"longdesc": "",
"required": "no",
"shortdesc": "Whether to generate records for NAT-ed subnets",
"type": "bool"
}
},
{
"peers.NAME.address": {
"longdesc": "",
"required": "no",
"shortdesc": "IP address of a DNS server",
"type": "string"
}
},
{
"peers.NAME.key": {
"longdesc": "",
"required": "no",
"shortdesc": "TSIG key for the server",
"type": "string"
}
},
{
"user.*": {
"longdesc": "",
"required": "no",
"shortdesc": "User-provided free-form key/value pairs",
"type": "string"
}
}
]
}
},
"project": {
"features": {
"keys": [
Expand Down
33 changes: 33 additions & 0 deletions internal/server/network/zone/zone.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,22 @@ func (d *zone) validateConfig(info *api.NetworkZonePut) error {
rules := map[string]func(value string) error{}

// Regular config keys.

// gendoc:generate(entity=network_zone, group=common, key=dns.nameservers)
//
// ---
// type: string set
// required: no
// shortdesc: Comma-separated list of DNS server FQDNs (for NS records)
rules["dns.nameservers"] = validate.IsListOf(validate.IsAny)

// gendoc:generate(entity=network_zone, group=common, key=network.nat)
//
// ---
// type: bool
// required: no
// defaultdesc: `true`
// shortdesc: Whether to generate records for NAT-ed subnets
rules["network.nat"] = validate.Optional(validate.IsBool)

// Validate peer config.
Expand All @@ -185,12 +200,30 @@ func (d *zone) validateConfig(info *api.NetworkZonePut) error {
// Add the correct validation rule for the dynamic field based on last part of key.
switch peerKey {
case "address":
// gendoc:generate(entity=network_zone, group=common, key=peers.NAME.address)
//
// ---
// type: string
// required: no
// shortdesc: IP address of a DNS server
rules[k] = validate.Optional(validate.IsNetworkAddress)
case "key":
// gendoc:generate(entity=network_zone, group=common, key=peers.NAME.key)
//
// ---
// type: string
// required: no
// shortdesc: TSIG key for the server
rules[k] = validate.Optional(validate.IsAny)
}
}

// gendoc:generate(entity=network_zone, group=common, key=user.*)
//
// ---
// type: string
// required: no
// shortdesc: User-provided free-form key/value pairs
err := d.validateConfigMap(info.Config, rules)
if err != nil {
return err
Expand Down
Loading