Skip to content

Commit 5388e4f

Browse files
committed
docs
Signed-off-by: Lukas Hoehl <[email protected]>
1 parent de5a6ba commit 5388e4f

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/usage/usage.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ In this document we are describing how this configuration looks like for Cilium
88

99
Hubble is a fully distributed networking and security observability platform build on top of Cilium and BPF. It is optional and is deployed to the cluster when enabled in the `NetworkConfig`.
1010
If the dashboard is not externally exposed
11+
1112
```
1213
kubectl port-forward -n kube-system deployment/hubble-ui 8081
1314
```
15+
1416
can be used to acess it locally.
1517

1618
## Example `NetworkingConfig` manifest
@@ -40,17 +42,20 @@ The `bpfSocketLBHostnsOnly.enabled` field describes whether socket LB will be sk
4042
Setting the field `cni.exclusive` to `false` might be useful when additional plugins, such as Istio or Linkerd, wish to chain after Cilium. This action disables the default behavior of Cilium, which is to overwrite changes to the CNI configuration file.
4143

4244
The `egressGateway.enabled` field describes whether egress gateways are enabled or not (default). To use this feature kube-proxy must be disabled. This can be done with the following configuration in the Shoot:
45+
4346
```yaml
4447
spec:
4548
kubernetes:
4649
kubeProxy:
4750
enabled: false
4851
```
52+
4953
The egress gateway feature is only supported in gardener with an overlay network (shoot.spec.networking.providerConfig.overlay.enabled: true) at the moment. This is due to the reason that bpf masquerading is required for the egress gateway feature. Once the overlay network is enabled `bpf.masquerade` is set to `true` in the cilium configmap.
5054

5155
The `snatToUpstreamDNS.enabled` field describes whether the traffic to the upstream dns server should be masqueraded or not (default). This is needed on some infrastructures where traffic to the dns server with the pod CIDR range is blocked.
5256

5357
The `policyAuditMode` field describes whether the [policy audit mode](https://docs.cilium.io/en/latest/security/policy-creation/#enable-policy-audit-mode-entire-daemon) is enabled for the entire Cilium Daemon or not (default). When enabled, this will log all dropped packets due to policy enforcement. It is useful for testing your network policies before enforcing them. Policy audit mode can be enabled on the shoot by adding the following configuration:
58+
5459
```yaml
5560
apiVersion: cilium.networking.extensions.gardener.cloud/v1alpha1
5661
kind: NetworkConfig
@@ -59,6 +64,25 @@ policyAuditMode: true
5964

6065
> :warning: When you have enabled the policy audit mode, network policies are NOT enforced but only observed. This means that traffic that would have been denied by a network policy is allowed, but logged as `AUDIT` in Hubble.
6166

67+
### Transparent Encryption
68+
69+
It is possible to enable transparent encryption of Cilium-managed host traffic and traffic between Cilium-managed endpoint.
70+
Currently only [Wireguard encryption](https://docs.cilium.io/en/stable/security/network/encryption-wireguard/) is supported.
71+
72+
An example cilium networking configuration could look like this:
73+
74+
```yaml
75+
apiVersion: cilium.networking.extensions.gardener.cloud/v1alpha1
76+
kind: NetworkConfig
77+
encryption:
78+
enabled: true
79+
mode: wireguard
80+
```
81+
82+
You can enable the feature [`node-to-node encryption`](https://docs.cilium.io/en/stable/security/network/encryption-wireguard/#node-to-node-encryption-beta) of cilium using the `nodeToNodeEnabled` field.
83+
84+
Find the API documentation for encryption [here](/hack/api-reference/cilium.md#cilium.networking.extensions.gardener.cloud/v1alpha1.Encryption)
85+
6286
## Example `Shoot` manifest
6387

6488
Please find below an example `Shoot` manifest with cilium networking configuration:
@@ -99,4 +123,5 @@ spec:
99123
...
100124
```
101125

102-
This setup prevents unnecessary node spin-ups and reduces the compute costs in single-node clusters.
126+
This setup prevents unnecessary node spin-ups and reduces the compute costs in single-node clusters.
127+

0 commit comments

Comments
 (0)