Skip to content

Commit a58e495

Browse files
committed
Add tls configuration options to helm README
1 parent 523f4af commit a58e495

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

config/helm/appmesh-controller/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ eksctl utils associate-iam-oidc-provider --region=$AWS_REGION \
5050
--approve
5151
```
5252

53-
Download the IAM policy for AWS App Mesh Kubernetes Controller
53+
Download the IAM policy for AWS App Mesh Kubernetes Controller
5454
```
5555
curl -o controller-iam-policy.json https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/controller-iam-policy.json
5656
```
@@ -91,7 +91,7 @@ helm upgrade -i appmesh-controller eks/appmesh-controller \
9191
The [configuration](#configuration) section lists the parameters that can be configured during installation.
9292

9393
**Note**
94-
If you want to start the controller in the EKS private cluster, enable the app mesh and service discovery VPC endpoints to the linked private subnet first. Also accountId is a required field now as `--set accountId=$AWS_ACCOUNT_ID`.
94+
If you want to start the controller in the EKS private cluster, enable the app mesh and service discovery VPC endpoints to the linked private subnet first. Also accountId is a required field now as `--set accountId=$AWS_ACCOUNT_ID`.
9595
If you want to enable X-ray tracing in private cluster, enable the X-ray VPC endpoint. Also, ECR VPC endpoint [does not support public repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/vpc-endpoints.html). Controller uses `public.ecr.aws/xray/aws-xray-daemon:latest` by default, so you need to pull this image to local and [push it into your personal ECR repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-push-ecr-image.html). Set it when deploying the controller like:
9696
```
9797
helm upgrade -i appmesh-controller eks/appmesh-controller \
@@ -104,17 +104,17 @@ helm upgrade -i appmesh-controller eks/appmesh-controller \
104104
--set tracing.enabled=true \
105105
--set tracing.provider=x-ray \
106106
--set xray.image.repository={your-account-id}.dkr.ecr.{your-region}.amazonaws.com/{your-repository} \
107-
--set xray.image.tag={your-xray-daemon-image-tag}
107+
--set xray.image.tag={your-xray-daemon-image-tag}
108108
```
109-
Verify if the X-ray daemon being injected successfully when binding application deployment with virtual node/gateway.
110-
More troubleshooting please see: https://docs.aws.amazon.com/eks/latest/userguide/private-clusters.html
109+
Verify if the X-ray daemon being injected successfully when binding application deployment with virtual node/gateway.
110+
More troubleshooting please see: https://docs.aws.amazon.com/eks/latest/userguide/private-clusters.html
111111

112112
**Note**
113113
Make sure that the Envoy proxies have the following IAM policies attached for the Envoy to authenticate with AWS App Mesh and fetch it's configuration
114114
- https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/envoy-iam-policy.json
115115

116-
There are **2 ways** you can attach the above policy to the Envoy Pod
117-
#### With IRSA
116+
There are **2 ways** you can attach the above policy to the Envoy Pod
117+
#### With IRSA
118118
Download the Envoy IAM policy
119119
```
120120
curl -o envoy-iam-policy.json https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/envoy-iam-policy.json
@@ -129,7 +129,7 @@ aws iam create-policy \
129129

130130
Take note of the policy ARN that is returned
131131

132-
If your Mesh enabled applications are already using IRSA then you can attach the above policy to the role belonging to the existing IRSA or you can edit the Trust Relationship of the existing iam role which has this envoy policy so that some other service account in your mesh can also assume this role.
132+
If your Mesh enabled applications are already using IRSA then you can attach the above policy to the role belonging to the existing IRSA or you can edit the Trust Relationship of the existing iam role which has this envoy policy so that some other service account in your mesh can also assume this role.
133133

134134
If not then you can create a service account for your application namespace and use the ARN from the step above. Ensure that Application Namespace already exists
135135

@@ -145,9 +145,9 @@ eksctl create iamserviceaccount --cluster $CLUSTER_NAME \
145145
Reference this Service Account in your application pod spec. This should be the pod which would get injected with the Envoy. Refer below example:
146146
```
147147
https://github.com/aws/aws-app-mesh-examples/blob/5a2d04227593d292d52e5e2ca638d808ebed5e70/walkthroughs/howto-k8s-fargate/v1beta2/manifest.yaml.template#L220
148-
```
148+
```
149149

150-
#### Without IRSA
150+
#### Without IRSA
151151
Find the Node Instance IAM Role from your worker nodes and attach below policies to it.
152152
**Note** If you created service account for the controller as indicated above then you can skip attaching the Controller IAM policy to worker nodes. Instead attach only the Envoy IAM policy.
153153

@@ -160,7 +160,7 @@ curl -o controller-iam-policy.json https://raw.githubusercontent.com/aws/aws-app
160160

161161
Envoy IAM policy
162162
Attach the below envoy policy to your Worker Nodes (Node Instance IAM Role)
163-
- https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/envoy-iam-policy.json
163+
- https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/envoy-iam-policy.json
164164
Use below command to download the policy if not already
165165
```sh
166166
curl -o envoy-iam-policy.json https://raw.githubusercontent.com/aws/aws-app-mesh-controller-for-k8s/master/config/iam/envoy-iam-policy.json
@@ -449,3 +449,5 @@ Parameter | Description | Default
449449
`env` | environment variables to be injected into the appmesh-controller pod | `{}`
450450
`livenessProbe` | Liveness probe settings for the controller | (see `values.yaml`)
451451
`podDisruptionBudget` | PodDisruptionBudget | `{}`
452+
`tlsMinVersion` | Minimum TLS version for the controller webhook server as shown in [here](https://github.com/kubernetes/component-base/blob/master/cli/flag/ciphersuites_flag.go#L114) | `VersionTLS12`
453+
`tlsCipherSuite` | Comma delimited TLS cipher suites for the controller webhook server as shown [here](https://pkg.go.dev/crypto/tls#pkg-constants) | None

0 commit comments

Comments
 (0)