community icon indicating copy to clipboard operation
community copied to clipboard

Provide example for AdoptedResource

Open jkatz opened this issue 2 years ago • 4 comments

What is the URL of the document?

Which section(s) is the issue in?

Likely "Tutorials"

What needs fixing?

There is no example for how to use AdoptedResource in the documentation, which may be affecting its adoption.

Additional context

Provide some examples with how it works with one or more services.

jkatz avatar May 24 '22 18:05 jkatz

Design proposal has some good examples at https://github.com/aws-controllers-k8s/community/blob/main/docs/design/proposals/adoption/resource-adoption.md

But not sure if it matches with implementation. Adding it in the official documentation will definitely help the adopters.

jeesmon avatar May 25 '22 19:05 jeesmon

@jeesmon I have more examples, if anyone needs them. Thankfully the implementation does actually match the proposal, except that the apiVersion of the resource is not service specific - that is, the apiVersion is services.k8s.aws/v1alpha1

Here's one example with an S3 bucket

apiVersion: services.k8s.aws/v1alpha1
kind: AdoptedResource
metadata:
  name: adopt-boring-bucket
spec:  
  aws:
    nameOrID: boring-old-normal-bucket
  kubernetes:
    group: s3.services.k8s.aws
    kind: Bucket
    metadata:
      name: my-adopted-bucket

RedbackThomson avatar May 25 '22 20:05 RedbackThomson

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close. Provide feedback via https://github.com/aws-controllers-k8s/community. /lifecycle stale

ack-bot avatar Aug 25 '22 17:08 ack-bot

Ideally we should provide examples in the examples repository /lifecycle frozen

a-hilaly avatar Aug 25 '22 17:08 a-hilaly