Skip to content

documentation updates for v2.4.1 #2562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/deploy/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,5 @@ They are a set of kye=value pairs that describe AWS load balance controller feat
|---------------------------------------|---------------------------------|-----------------|-------------|
| ListenerRulesTagging | string | true | Enable or disable tagging AWS load balancer listeners and rules |
| WeightedTargetGroups | string | true | Enable or disable weighted target groups |
| ServiceTypeLoadBalancerOnly | string | false | If enabled, controller will be limited to reconciling service of type `LoadBalancer`|
| ServiceTypeLoadBalancerOnly | string | false | If enabled, controller will be limited to reconciling service of type `LoadBalancer`|
| EndpointsFailOpen | string | false | Enable or disable allowing endpoints with `ready:unknown` state in the target groups. |
58 changes: 58 additions & 0 deletions docs/examples/secrets_access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# RBAC configuration for secrets resources

In this walkthrough, you will

- configure RBAC permissions for the controller to access specific secrets resource in a particular namespace.

# Create Role
1. Prepare the role manifest with the appropriate name, namespace, and secretName, for example:

```
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: example-role
namespace: example-namespace
rules:
- apiGroups:
- ""
resourceNames:
- example-secret
resources:
- secrets
verbs:
- get
- list
- watch
```

2. Apply the role manifest

```
kubectl apply -f role.yaml
```

# Create RoleBinding
1. Prepare the rolebinding manifest with the appropriate name, namespace and role reference. For example:

```
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: example-rolebinding
namespace: example-namespace
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: example-role
subjects:
- kind: ServiceAccount
name: aws-load-balancer-controller
namespace: kube-system
```

2. Apply the rolebinding manifest

```
kubectl apply -f rolebinding.yaml
```
3 changes: 2 additions & 1 deletion helm/aws-load-balancer-controller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ If you are setting `serviceMonitor.enabled: true` you need to have installed the

## Installing the Chart
**Note**: You need to uninstall aws-alb-ingress-controller. Please refer to the [upgrade](#Upgrade) section below before you proceed.
**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/)].

Add the EKS repository to Helm:
```shell script
Expand Down Expand Up @@ -234,4 +235,4 @@ The default values set by the application itself can be confirmed [here](https:/
| `serviceMonitor.enabled` | Specifies whether a service monitor should be created, requires the ServiceMonitor CRD to be installed | `false` |
| `serviceMonitor.additionalLabels` | Labels to add to the service account | `{}` |
| `serviceMonitor.interval` | Prometheus scrape interval | `1m` |
| `clusterSecretsPermissions.allowAllSecrets` | If `true`, controller has access to all secrets in the cluster. | `false` |
| `clusterSecretsPermissions.allowAllSecrets` | If `true`, controller has access to all secrets in the cluster. | `false` |
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ nav:
- Examples:
- EchoServer: examples/echo_server.md
- gRPCServer: examples/grpc_server.md
- RBAC to access OIDC Secret: examples/secrets_access.md



Expand Down