Skip to content

Commit e75a1ca

Browse files
authored
Update service annotations documentation (#1624)
1 parent 26ce165 commit e75a1ca

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

docs/guide/service/annotations.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
## Service annotations
22

33
!!!note ""
4-
- Annotation keys and values can only be strings. Advanced format should be encoded as below:
5-
- boolean: 'true'
6-
- integer: '42'
7-
- stringList: s1,s2,s3
8-
- stringMap: k1=v1,k2=v2
9-
- json: 'jsonContent'
4+
- Annotation keys and values can only be strings. All other types below must be string-encoded, for example:
5+
- boolean: `"true"`
6+
- integer: `"42"`
7+
- stringList: `"s1,s2,s3"`
8+
- stringMap: `"k1=v1,k2=v2"`
9+
- json: `"{ \"key\": \"value\" }"`
1010

1111
## Annotations
12-
|Name | Type | Default |
13-
|-----------------------------------------------------------------------------------|-------------------|---------------|
14-
|service.beta.kubernetes.io/aws-load-balancer-type | string | |
15-
|service.beta.kubernetes.io/aws-load-balancer-internal | boolean | false |
16-
|service.beta.kubernetes.io/aws-load-balancer-proxy-protocol | string | |
17-
|service.beta.kubernetes.io/aws-load-balancer-access-log-enabled | boolean | false |
18-
|service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-name | string | |
19-
|service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-prefix | string | |
20-
|service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled | boolean | false |
21-
|service.beta.kubernetes.io/aws-load-balancer-ssl-cert | stringList | |
22-
|service.beta.kubernetes.io/aws-load-balancer-ssl-ports | stringList | |
23-
|service.beta.kubernetes.io/aws-load-balancer-ssl-negotiation-policy | string | ELBSecurityPolicy-2016-08 |
24-
|service.beta.kubernetes.io/aws-load-balancer-backend-protocol | string | |
25-
|service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags | stringMap | |
26-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-healthy-threshold | integer | 3 |
27-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-unhealthy-threshold | integer | 3 |
28-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout | integer | 10 |
29-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-interval | integer | 10 |
30-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol | string | TCP |
31-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-port | string | traffic-port |
32-
|service.beta.kubernetes.io/aws-load-balancer-healthcheck-path | string | "/" for HTTP(S) protocols |
33-
|service.beta.kubernetes.io/aws-load-balancer-eip-allocations | stringList | |
12+
| Name | Type | Default | Notes |
13+
|--------------------------------------------------------------------------------|------------|---------------------------|------------------------|
14+
| service.beta.kubernetes.io/aws-load-balancer-type | string | | |
15+
| service.beta.kubernetes.io/aws-load-balancer-internal | boolean | false | |
16+
| service.beta.kubernetes.io/aws-load-balancer-proxy-protocol | string | | Set to `"*"` to enable |
17+
| service.beta.kubernetes.io/aws-load-balancer-access-log-enabled | boolean | false | |
18+
| service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-name | string | | |
19+
| service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-prefix | string | | |
20+
| service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled | boolean | false | |
21+
| service.beta.kubernetes.io/aws-load-balancer-ssl-cert | stringList | | |
22+
| service.beta.kubernetes.io/aws-load-balancer-ssl-ports | stringList | | |
23+
| service.beta.kubernetes.io/aws-load-balancer-ssl-negotiation-policy | string | ELBSecurityPolicy-2016-08 | |
24+
| service.beta.kubernetes.io/aws-load-balancer-backend-protocol | string | | |
25+
| service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags | stringMap | | |
26+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-healthy-threshold | integer | 3 | |
27+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-unhealthy-threshold | integer | 3 | |
28+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout | integer | 10 | |
29+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-interval | integer | 10 | |
30+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol | string | TCP | |
31+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-port | string | traffic-port | |
32+
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-path | string | "/" for HTTP(S) protocols | |
33+
| service.beta.kubernetes.io/aws-load-balancer-eip-allocations | stringList | | |

0 commit comments

Comments
 (0)