Skip to content

Commit 18f5517

Browse files
committed
update doc with correct type and note to specify values as string
1 parent 6d72edb commit 18f5517

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/configuration/annotations.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ For implementation details, see:
99
- [Basic Service Examples](../examples/basic.md)
1010
- [Advanced Configuration Examples](../examples/advanced.md)
1111

12+
NOTE:
13+
The keys and the values in [annotations must be strings](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/). In other words, you cannot use numeric, boolean, list or other types for either the keys or the values. Hence, one should double quote them when specifying in annotations to convert them to string.
14+
1215
## Available Annotations
1316

1417
### Basic Configuration
@@ -27,10 +30,10 @@ For implementation details, see:
2730
| `check-attempts` | int (1-30) | | Number of health check failures necessary to remove a back-end |
2831
| `check-passive` | bool | `false` | When `true`, `5xx` status codes will cause the health check to fail |
2932
| `preserve` | bool | `false` | When `true`, deleting a `LoadBalancer` service does not delete the underlying NodeBalancer |
30-
| `nodebalancer-id` | string | | The ID of the NodeBalancer to front the service |
33+
| `nodebalancer-id` | int | | The ID of the NodeBalancer to front the service |
3134
| `hostname-only-ingress` | bool | `false` | When `true`, the LoadBalancerStatus will only contain the Hostname |
3235
| `tags` | string | | A comma separated list of tags to be applied to the NodeBalancer instance |
33-
| `firewall-id` | string | | An existing Cloud Firewall ID to be attached to the NodeBalancer instance. See [Firewall Setup](firewall.md) |
36+
| `firewall-id` | int | | An existing Cloud Firewall ID to be attached to the NodeBalancer instance. See [Firewall Setup](firewall.md) |
3437
| `firewall-acl` | string | | The Firewall rules to be applied to the NodeBalancer. See [Firewall Configuration](#firewall-configuration) |
3538
| `nodebalancer-type` | string | | The type of NodeBalancer to create (options: common, premium). See [NodeBalancer Types](#nodebalancer-type) |
3639
| `enable-ipv6-ingress` | bool | `false` | When `true`, both IPv4 and IPv6 addresses will be included in the LoadBalancerStatus ingress |

0 commit comments

Comments
 (0)