Skip to content

Commit b564cef

Browse files
authored
documentation updates for v2.4.1 (#2562)
1 parent c4471de commit b564cef

File tree

4 files changed

+63
-2
lines changed

4 files changed

+63
-2
lines changed

docs/deploy/configurations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,5 @@ They are a set of kye=value pairs that describe AWS load balance controller feat
143143
|---------------------------------------|---------------------------------|-----------------|-------------|
144144
| ListenerRulesTagging | string | true | Enable or disable tagging AWS load balancer listeners and rules |
145145
| WeightedTargetGroups | string | true | Enable or disable weighted target groups |
146-
| ServiceTypeLoadBalancerOnly | string | false | If enabled, controller will be limited to reconciling service of type `LoadBalancer`|
146+
| ServiceTypeLoadBalancerOnly | string | false | If enabled, controller will be limited to reconciling service of type `LoadBalancer`|
147+
| EndpointsFailOpen | string | false | Enable or disable allowing endpoints with `ready:unknown` state in the target groups. |

docs/examples/secrets_access.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# RBAC configuration for secrets resources
2+
3+
In this walkthrough, you will
4+
5+
- configure RBAC permissions for the controller to access specific secrets resource in a particular namespace.
6+
7+
# Create Role
8+
1. Prepare the role manifest with the appropriate name, namespace, and secretName, for example:
9+
10+
```
11+
apiVersion: rbac.authorization.k8s.io/v1
12+
kind: Role
13+
metadata:
14+
name: example-role
15+
namespace: example-namespace
16+
rules:
17+
- apiGroups:
18+
- ""
19+
resourceNames:
20+
- example-secret
21+
resources:
22+
- secrets
23+
verbs:
24+
- get
25+
- list
26+
- watch
27+
```
28+
29+
2. Apply the role manifest
30+
31+
```
32+
kubectl apply -f role.yaml
33+
```
34+
35+
# Create RoleBinding
36+
1. Prepare the rolebinding manifest with the appropriate name, namespace and role reference. For example:
37+
38+
```
39+
apiVersion: rbac.authorization.k8s.io/v1
40+
kind: RoleBinding
41+
metadata:
42+
name: example-rolebinding
43+
namespace: example-namespace
44+
roleRef:
45+
apiGroup: rbac.authorization.k8s.io
46+
kind: Role
47+
name: example-role
48+
subjects:
49+
- kind: ServiceAccount
50+
name: aws-load-balancer-controller
51+
namespace: kube-system
52+
```
53+
54+
2. Apply the rolebinding manifest
55+
56+
```
57+
kubectl apply -f rolebinding.yaml
58+
```

helm/aws-load-balancer-controller/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ If you are setting `serviceMonitor.enabled: true` you need to have installed the
8686

8787
## Installing the Chart
8888
**Note**: You need to uninstall aws-alb-ingress-controller. Please refer to the [upgrade](#Upgrade) section below before you proceed.
89+
**Note**: Starting chart version 1.4.1, you need to explicitly set clusterSecretsPermissions.allowAllSecrets to true to grant the controller permission to access all secrets for OIDC feature. We recommend configuring access to individual secrets resource separately [[link](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.4/examples/secrets_access/)].
8990

9091
Add the EKS repository to Helm:
9192
```shell script
@@ -234,4 +235,4 @@ The default values set by the application itself can be confirmed [here](https:/
234235
| `serviceMonitor.enabled` | Specifies whether a service monitor should be created, requires the ServiceMonitor CRD to be installed | `false` |
235236
| `serviceMonitor.additionalLabels` | Labels to add to the service account | `{}` |
236237
| `serviceMonitor.interval` | Prometheus scrape interval | `1m` |
237-
| `clusterSecretsPermissions.allowAllSecrets` | If `true`, controller has access to all secrets in the cluster. | `false` |
238+
| `clusterSecretsPermissions.allowAllSecrets` | If `true`, controller has access to all secrets in the cluster. | `false` |

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ nav:
3333
- Examples:
3434
- EchoServer: examples/echo_server.md
3535
- gRPCServer: examples/grpc_server.md
36+
- RBAC to access OIDC Secret: examples/secrets_access.md
3637

3738

3839

0 commit comments

Comments
 (0)