> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> NetworkRuleConfig is a network firewall rule config document.

# NetworkRuleConfig

```yaml theme={null}
apiVersion: v1alpha1
kind: NetworkRuleConfig
name: ingress-apid # Name of the config document.
# Port selector defines which ports and protocols on the host are affected by the rule.
portSelector:
    # Ports defines a list of port ranges or single ports.
    ports:
        - 50000
    protocol: tcp # Protocol defines traffic protocol (e.g. TCP or UDP).
# Ingress defines which source subnets are allowed to access the host ports/protocols defined by the `portSelector`.
ingress:
    - subnet: 192.168.0.0/16 # Subnet defines a source subnet.
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Name of the config document.</td>

      <td />
    </tr>

    <tr>
      <td>`portSelector`</td>
      <td><a href="#portselector">RulePortSelector</a></td>
      <td>Port selector defines which ports and protocols on the host are affected by the rule.</td>

      <td />
    </tr>

    <tr>
      <td>`ingress`</td>
      <td><a href="#ingress%5B%5D">IngressRule</a></td>
      <td>Ingress defines which source subnets are allowed to access the host ports/protocols defined by the `portSelector`.</td>

      <td />
    </tr>
  </tbody>
</table>

## portSelector

RulePortSelector is a port selector for the network rule.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`ports`</td>
      <td>PortRanges</td>
      <td>Ports defines a list of port ranges or single ports.<br />The port ranges are inclusive, and should not overlap.</td>

      <td />
    </tr>

    <tr>
      <td>`protocol`</td>
      <td>Protocol</td>
      <td>Protocol defines traffic protocol (e.g. TCP or UDP).</td>
      <td>`tcp`<br />`udp`<br />`icmp`<br />`icmpv6`<br /></td>
    </tr>
  </tbody>
</table>

## ingress\[]

IngressRule is a ingress rule.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`subnet`</td>
      <td>Prefix</td>
      <td>Subnet defines a source subnet.</td>

      <td />
    </tr>

    <tr>
      <td>`except`</td>
      <td>Prefix</td>
      <td>Except defines a source subnet to exclude from the rule, it gets excluded from the `subnet`.</td>

      <td />
    </tr>
  </tbody>
</table>