Skip to content

Updated SageMaker operator Helm chart installation guide #1254

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.

Sign up for GitHub

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 4 commits into from
Jan 23, 2020
Merged

Updated SageMaker operator Helm chart installation guide #1254

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83607c8
Updated helm chart installation guide
Jan 21, 2020
6bd5761
Replaced Arn with ARN
Jan 22, 2020
325525d
Added note regarding namespacing
Jan 23, 2020
602985f
Added sphinx admonition warning
Jan 23, 2020
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
17 changes: 11 additions & 6 deletions doc/amazon_sagemaker_operators_for_kubernetes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ follows:

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

- Use the following command to deploy the cluster:

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

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

Install the Helm Chart using the following command:

::

helm install rolebased/ --generate-name
kubectl create namespace sagemaker-k8s-operator-system
helm install --namespace sagemaker-k8s-operator-system sagemaker-operator rolebased/
Comment on lines +273 to +274
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a note that customers can pick their own namespace, but it must be specified in "system:serviceaccount:sagemaker-k8s-operator-system:sagemaker-k8s-operator-default" in the trust.json file. Otherwise, authentication won't work and customers will be confused.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea. Added a note directly underneath

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(optional) there are actually some fun directives you can use for formatting these kinds of things: https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html#admonitions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a good way to check for syntax errors? (A make target?) I'd like to use the warning admonition

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, you can build the docs locally: https://github.com/aws/sagemaker-python-sdk#building-sphinx-docs



.. warning::
If you decide to install the operator into a namespace other than the one specified above,
you will need to adjust the namespace defined in the IAM role ``trust.json`` file to match.

After a moment, the chart will be installed with a randomly generated
name. Verify that the installation succeeded by running the following
command:
Expand All @@ -285,8 +290,8 @@ Your output should look like the following:

::

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


Verify the operator deployment
Expand Down