Skip to content

Commit 5e3d283

Browse files
committed
Add VPC and Firewall Configuration Precedence Documentation
Enhance the documentation for firewall and VPC configurations by detailing the precedence rules for specifying `firewallID`/`firewallRef` and `VPCID`/`VPCRef` in `LinodeMachine` and `LinodeCluster` resources. Include recommendations for clarity and best practices in configuration.
1 parent 4ccb684 commit 5e3d283

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

docs/src/topics/firewalling.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,25 @@ spec:
186186
region: us-ord
187187
type: g6-standard-4
188188
```
189+
190+
### Firewall Configuration Precedence
191+
192+
When configuring firewalls, you can specify either a direct `firewallID` or a `firewallRef` in both `LinodeMachine` and `LinodeCluster` resources. If both are specified, the following precedence rules apply:
193+
194+
#### LinodeMachine Firewall Precedence
195+
196+
For `LinodeMachine` resources, when both `firewallID` and `firewallRef` are specified:
197+
198+
- `firewallRef` takes precedence over `firewallID`
199+
- The ID from the referenced `LinodeFirewall` will be used instead of the directly specified `firewallID`
200+
201+
#### LinodeCluster NodeBalancer Firewall Precedence
202+
203+
For `LinodeCluster` resources, when both `NodeBalancerFirewallID` and `NodeBalancerFirewallRef` are specified:
204+
205+
- `NodeBalancerFirewallRef` takes precedence over `NodeBalancerFirewallID`
206+
- The ID from the referenced `LinodeFirewall` will be used instead of the directly specified `NodeBalancerFirewallID`
207+
208+
```admonish warning
209+
While you can specify both direct IDs and references, it's recommended to use only one approach for clarity and to avoid confusion.
210+
```

docs/src/topics/vpc.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,37 @@ By default, the VPC will use the subnet with the `default` label for deploying c
6666

6767
Additionally, the `VPC_NETWORK_CIDR` and `K8S_CLUSTER_CIDR` environment variables can be used to change which CIDR blocks are used by the VPC and its clusters. `VPC_NETWORK_CIDR` designates the range used by the VPC, while `K8S_CLUSTER_CIDR` designates the range used by clusters for nodes. The `K8S_CLUSTER_CIDR` should be within the `VPC_NETWORK_CIDR`.
6868

69+
### VPC Configuration Precedence
70+
71+
When configuring VPCs, you can specify either a direct `VPCID` or a `VPCRef` in both `LinodeMachine` and `LinodeCluster` resources. If both are specified, the following precedence rules apply:
72+
73+
#### LinodeMachine VPC Precedence
74+
75+
For `LinodeMachine` resources, the precedence order is:
76+
77+
1. Machine's direct `VPCID` (highest precedence)
78+
2. Cluster's direct `VPCID`
79+
3. VPC reference (`VPCRef`) from either machine or cluster
80+
81+
If multiple options are specified, the highest precedence option will be used.
82+
83+
#### LinodeCluster VPC Precedence
84+
85+
For `LinodeCluster` resources, the precedence order is:
86+
87+
1. Direct `VPCID` (highest precedence)
88+
2. `VPCRef`
89+
90+
If both are specified, the direct `VPCID` will be used.
91+
92+
```admonish note
93+
This VPC precedence behavior differs from firewall configuration, where references take precedence over direct IDs. For VPCs, direct IDs always take precedence over references.
94+
```
95+
96+
```admonish warning
97+
While you can specify both direct IDs and references, it's recommended to use only one approach for clarity and to avoid confusion.
98+
```
99+
69100
## Troubleshooting
70101
### If pod-to-pod connectivity is failing
71102
If a pod can't ping pod ips on different node, check and make sure pod CIDRs are added to ip_ranges of VPC interface.

0 commit comments

Comments
 (0)