Skip to content

Commit 63cccdf

Browse files
RedbackThomsonlaurenyu
authored andcommitted
doc: Update SageMaker operator Helm chart installation guide (aws#1254)
1 parent a7f14f7 commit 63cccdf

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

doc/amazon_sagemaker_operators_for_kubernetes.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ follows:
239239

240240
- Edit the \ ``installer.yaml`` file to
241241
replace \ ``eks.amazonaws.com/role-arn``. Replace the ARN here with
242-
the ARN for the OIDC-based role you’ve created.
242+
the Amazon Resource Name (ARN) for the OIDC-based role you’ve created.
243243

244244
- Use the following command to deploy the cluster:
245245

@@ -262,17 +262,22 @@ Clone the Helm installer directory using the following command:
262262

263263
Navigate to the
264264
``amazon-sagemaker-operator-for-k8s/hack/charts/installer`` folder. Edit
265-
the \ ``values.yaml`` file, which includes high-level parameters for the
266-
Chart. Replace the ARN here with the ARN for the OIDC-based role you’ve
265+
the \ ``rolebased/values.yaml`` file, which includes high-level parameters for the
266+
Chart. Replace the role ARN here with the Amazon Resource Name (ARN) for the OIDC-based role you’ve
267267
created.
268268

269269
Install the Helm Chart using the following command:
270270

271271
::
272272

273-
helm install rolebased/ --generate-name
273+
kubectl create namespace sagemaker-k8s-operator-system
274+
helm install --namespace sagemaker-k8s-operator-system sagemaker-operator rolebased/
274275

275276

277+
.. warning::
278+
If you decide to install the operator into a namespace other than the one specified above,
279+
you will need to adjust the namespace defined in the IAM role ``trust.json`` file to match.
280+
276281
After a moment, the chart will be installed with a randomly generated
277282
name. Verify that the installation succeeded by running the following
278283
command:
@@ -285,8 +290,8 @@ Your output should look like the following:
285290

286291
::
287292

288-
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
289-
rolebased-1234567 default 1 2019-11-20 23:14:59.6777082 +0000 UTC deployed sagemaker-k8s-operator-0.1.0
293+
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
294+
sagemaker-operator sagemaker-k8s-operator-system 1 2019-11-20 23:14:59.6777082 +0000 UTC deployed sagemaker-k8s-operator-0.1.0
290295

291296

292297
Verify the operator deployment

0 commit comments

Comments
 (0)