Skip to content

Commit 7d2f7a0

Browse files
authored
update readme to call out breaking changes with namespaced deployment (#96)
1 parent 44230e2 commit 7d2f7a0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -158,17 +158,14 @@ helm chart export $CHART_REF --destination $CHART_EXPORT_PATH
158158
cd -
159159
```
160160
- [Option 2] Namespace scoped deployment
161-
- Specify the namespace to listen to
162-
```sh
163-
export WATCH_NAMESPACE=<NAMESPACE_TO_LISTEN_TO>
164-
```
161+
- The controller will watch for the resources in the helm chart release namespace. In this guide, that value is set from the `$ACK_K8S_NAMESPACE` variable in helm install section [3.1.3](#313-install-controller)
165162
- ```sh
166163
# Update values in helm chart
167164
cd $CHART_EXPORT_PATH/$SERVICE-chart
168165
yq e '.aws.region = env(AWS_DEFAULT_REGION)' -i values.yaml
169166
yq e '.aws.account_id = env(AWS_ACCOUNT_ID)' -i values.yaml
170167
yq e '.serviceAccount.annotations."eks.amazonaws.com/role-arn" = env(IAM_ROLE_ARN_FOR_IRSA)' -i values.yaml
171-
yq e '.watchNamespace" = env(WATCH_NAMESPACE)' -i values.yaml
168+
yq e '.installScope = namespace' -i values.yaml
172169
cd -
173170
```
174171
##### 3.1.3 Install Controller
@@ -249,16 +246,17 @@ for example, the controller default region is us-west-2 (3.a/3.b) and you want t
249246
apiVersion: sagemaker.services.k8s.aws/v1alpha1
250247
kind: TrainingJob
251248
metadata:
252-
name: ack-sample-tainingjob
249+
name: ack-sample-trainingjob
253250
annotations:
254251
services.k8s.aws/region: us-east-1
255252
spec:
256-
trainingJobName: ack-sample-tainingjob
253+
trainingJobName: ack-sample-trainingjob
257254
roleARN: <sagemaker_execution_role_arn>
258255
...
259256
```
260257

261258
- [Option 2] Namespace default region annotation sample
259+
- **Note**: Namespaced scope deployment does not support this option
262260
- To bind a region to a specific Namespace you will have to annotate the Namespace with `services.k8s.aws/default-region` annotation. For example:
263261
- ```yaml
264262
apiVersion: v1
@@ -278,10 +276,10 @@ for example, the controller default region is us-west-2 (3.a/3.b) and you want t
278276
apiVersion: sagemaker.services.k8s.aws/v1alpha1
279277
kind: TrainingJob
280278
metadata:
281-
name: ack-sample-tainingjob
279+
name: ack-sample-trainingjob
282280
namespace: production
283281
spec:
284-
trainingJobName: ack-sample-tainingjob
282+
trainingJobName: ack-sample-trainingjob
285283
roleARN: <sagemaker_execution_role_arn>
286284
...
287285
```
@@ -291,7 +289,9 @@ for example, the controller default region is us-west-2 (3.a/3.b) and you want t
291289
ACK service controllers can manage resources in different AWS accounts. To enable and start using this feature, you will need to:
292290

293291
1. Configure your AWS accounts, where the resources will be managed.
294-
2. Create a ConfigMap to map AWS accounts with the Role ARNs that needs to be assumed
292+
2. Deploy ACK service controller in Cluster scope
293+
- Namespaced scope deployment does not support Cross Account Resource Management
294+
3. Create a ConfigMap to map AWS accounts with the Role ARNs that needs to be assumed
295295
3. Annotate namespaces with AWS Account IDs
296296

297297
For detailed information about how ACK service controllers manage resource in multiple AWS accounts, please refer to [CARM](https://github.com/aws/aws-controllers-k8s/blob/main/docs/design/proposals/carm/cross-account-resource-management.md) design document.

0 commit comments

Comments
 (0)