Skip to content

Commit

Permalink
address review comments
Browse files Browse the repository at this point in the history
include link to kubernetes website with more info on annotations, make []string clearer to non golang users and include line between eg and list
  • Loading branch information
nhennigan committed Nov 15, 2024
1 parent 525dfab commit ddaaf14
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/src/snap/reference/annotations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Annotations

This page outlines the annotations that can be configured during cluster
[bootstrap]. To do this, set the `cluster-config/annotations` parameter in
[bootstrap]. To do this, set the `cluster-config.annotations` parameter in
the bootstrap configuration.

For example:
Expand All @@ -14,6 +14,8 @@ cluster-config:
k8sd/v1alpha/lifecycle/skip-stop-services-on-remove: true
```
Please refer to the [Kubernetes website] for more information on annnotations.
## `k8sd/v1alpha/lifecycle/skip-cleanup-kubernetes-node-on-remove`

| | |
Expand Down Expand Up @@ -95,7 +97,7 @@ cluster-config:

| | |
|---|---|
|**Values**| []string (comma separated) |
|**Values**| \[] (string values comma separated) |
|**Description**|Enable IP auto-detection based on which addresses on the nodes are within one of the provided CIDRs.|

## `k8sd/v1alpha1/calico/autodetection-v6/firstFound`
Expand Down Expand Up @@ -137,7 +139,7 @@ cluster-config:

| | |
|---|---|
|**Values**| []string (comma separated) |
|**Values**| \[] (string values comma separated) |
|**Description**|Enable IP auto-detection based on which addresses on the nodes are within one of the provided CIDRs.|

## `k8sd/v1alpha1/cilium/devices`
Expand All @@ -158,7 +160,7 @@ cluster-config:

| | |
|---|---|
|**Values**| []string|
|**Values**| \[] (string values comma separated)|
|**Description**|Comma separated list of VLAN tags to bypass eBPF filtering on native devices. Cilium enables firewalling on native devices and filters all unknown traffic, including VLAN 802.1q packets, which pass through the main device with the associated tag (e.g., VLAN device eth0.4000 and its main interface eth0). Supports `0` as wildcard for bypassing all VLANs. e.g. `4001,4002`|

## `k8sd/v1alpha1/metrics-server/image-repo`
Expand Down Expand Up @@ -186,4 +188,5 @@ for(var i=0;i<el.length;i++){

<!-- Links -->

[Kubernetes website]:https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
[bootstrap]: bootstrap-config-reference

0 comments on commit ddaaf14

Please sign in to comment.