Skip to content

Commit 1bedb69

Browse files
authored
Added migrate resources note to README (#169)
Added note on steps to migrate resources to the ACK controller if you're coming from the old SageMaker operators for Kubernetes. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent 48146fd commit 1bedb69

File tree

1 file changed

+35
-33
lines changed

1 file changed

+35
-33
lines changed

Diff for: README.md

+35-33
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,6 @@ Kubernetes Github project.
88

99
[ack-issues]: https://github.com/aws/aws-controllers-k8s/issues
1010

11-
## Contributing
12-
13-
We welcome community contributions and pull requests.
14-
15-
See our [contribution guide](/CONTRIBUTING.md) for more information on how to
16-
report issues, set up a development environment, and submit code.
17-
18-
We adhere to the [Amazon Open Source Code of Conduct][coc].
19-
20-
You can also learn more about our [Governance](/GOVERNANCE.md) structure.
21-
22-
[coc]: https://aws.github.io/code-of-conduct
23-
24-
## License
25-
26-
This project is [licensed](/LICENSE) under the Apache-2.0 License.
27-
28-
## Supported SageMaker Resources
29-
For a list of supported resources, refer to the [SageMaker API Reference](https://aws-controllers-k8s.github.io/community/reference/).
30-
31-
Find the helm charts and controller images on Amazon ECR Public Gallery.
32-
- Helm Chart: https://gallery.ecr.aws/aws-controllers-k8s/sagemaker-chart
33-
34-
- Controller Image: https://gallery.ecr.aws/aws-controllers-k8s/sagemaker-controller
35-
3611
## Getting Started
3712

3813
### 1.0 ACK SageMaker Controller
@@ -63,9 +38,11 @@ Head over to the [Manage Resources In Multiple AWS Accounts](https://aws-control
6338

6439
### 6.0 Adopt Resources
6540

66-
ACK controller provides to provide the ability to “adopt” resources that were not originally created by ACK service controller. Given the user configures the controller with permissions which has access to existing resource, the controller will be able to determine the current specification and status of the AWS resource and reconcile said resource as if the ACK controller had originally created it.
41+
ACK controllers provide the ability to “adopt” resources that were not originally created by an ACK service controller. For more information, see [Adopting Existing AWS Resources](https://aws-controllers-k8s.github.io/community/docs/user-docs/adopted-resource/) in the ACK documentation.
42+
43+
The following steps demonstrate how to adopt a SageMaker Endpoint.
6744

68-
Sample:
45+
Save the following sample to a file called `adopt-endpoint-sample.yaml`.
6946
```yaml
7047
apiVersion: services.k8s.aws/v1alpha1
7148
kind: AdoptedResource
@@ -82,20 +59,18 @@ spec:
8259
# target K8s CR name
8360
name: xgboost-endpoint
8461
```
85-
Save the above to a file name adopt-endpoint-sample.yaml.
8662
87-
Submit the CR
63+
Submit the CR:
8864
```sh
8965
kubectl apply -f adopt-endpoint-sample.yaml
9066
```
9167

92-
Check for `ACK.Adopted` condition to be true under `status.conditions`
93-
68+
Check that the `ACK.Adopted` condition under `status.conditions` is `True`:
9469
```sh
9570
kubectl describe adoptedresource adopt-endpoint-sample
9671
```
9772

98-
Output should look similar to this:
73+
Your output should look similar to the following:
9974
```yaml
10075
---
10176
kind: AdoptedResource
@@ -125,9 +100,36 @@ status:
125100
type: ACK.Adopted
126101
```
127102
128-
Check resource exists in cluster
103+
Check that the resource exists in your cluster:
129104
```sh
130105
kubectl describe endpoints.sagemaker xgboost-endpoint
131106
```
132107

108+
### 7.0 Migrate resources from the old SageMaker Operators for Kubernetes
109+
110+
For information about migrating resources from the old [SageMaker Operators for Kubernetes](https://github.com/aws/amazon-sagemaker-operator-for-k8s) to the ACK SageMaker controller, see [Migrate resources to the new SageMaker Operators for Kubernetes](https://docs.aws.amazon.com/sagemaker/latest/dg/kubernetes-sagemaker-operators-migrate.html) in the *Amazon SageMaker Developer Guide*.
111+
112+
## Supported SageMaker Resources
113+
For a list of supported resources, refer to the [SageMaker API Reference](https://aws-controllers-k8s.github.io/community/reference/).
114+
115+
Find the helm charts and controller images on Amazon ECR Public Gallery.
116+
- Helm Chart: https://gallery.ecr.aws/aws-controllers-k8s/sagemaker-chart
117+
118+
- Controller Image: https://gallery.ecr.aws/aws-controllers-k8s/sagemaker-controller
119+
120+
## Contributing
121+
122+
We welcome community contributions and pull requests.
123+
124+
See our [contribution guide](/CONTRIBUTING.md) for more information on how to
125+
report issues, set up a development environment, and submit code.
126+
127+
We adhere to the [Amazon Open Source Code of Conduct][coc].
128+
129+
You can also learn more about our [Governance](/GOVERNANCE.md) structure.
130+
131+
[coc]: https://aws.github.io/code-of-conduct
132+
133+
## License
133134

135+
This project is [licensed](/LICENSE) under the Apache-2.0 License.

0 commit comments

Comments
 (0)