Skip to content
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.

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

Improve visibility of the status of custom resources on Kubernetes to quickly identify failed resources #2194

Open
daniduhnev1 opened this issue Oct 17, 2024 · 1 comment · Fixed by aws-controllers-k8s/sns-controller#63
Assignees
Labels
kind/enhancement Categorizes issue or PR as related to existing feature enhancements. service/sns Indicates issues or PRs that are related to sns-controller.

Comments

@daniduhnev1
Copy link

daniduhnev1 commented Oct 17, 2024

Is your feature request related to a problem?

An improvement on the visibility of the status of the ACK custom resources on Kubernetes will be very helpful to identify failed resources fast and debug why they have failed.

In GCP config-connector when kubectl get is ran there is visibility on the status of the resource. For example:

kubectl get pubsubtopics

NAME                                                              AGE    READY   STATUS        STATUS AGE
pubsubtopic.pubsub.cnrm.cloud.google.com/int-pubsub-1             334d   True    UpToDate      145d
pubsubtopic.pubsub.cnrm.cloud.google.com/int-pubsub-2             329d   False   Updating      1s
pubsubtopic.pubsub.cnrm.cloud.google.com/int-pubsub-3             13d    False   UpdateFailed  13d
...

While, in ACK even with the -o wide flag we do not get any more useful information on the resource. For example:

kubectl get buckets -o wide

NAME                         AGE
my-ack-s3-bucket-us-east-1   37d
my-ack-s3-bucket-us-west-2   37d
...

Describe the solution you'd like

We would like to have visibility on what the status of the resource is when all the resources are listed using a kubectl get command. Alternative solutions which provide a quick and easy way to check the status of all resources would also be viable.

Describe alternatives you've considered

We could run a kubectl describe on every single resource to check its state but this quickly becomes unfeasible when managing an environment with thousands of resources. Our scale can go above 10,000 resources in some environments.

@a-hilaly a-hilaly added kind/enhancement Categorizes issue or PR as related to existing feature enhancements. service/sqs Indicates issues or PRs that are related to sqs-controller. service/sns Indicates issues or PRs that are related to sns-controller. and removed service/sqs Indicates issues or PRs that are related to sqs-controller. labels Oct 21, 2024
@a-hilaly a-hilaly self-assigned this Oct 24, 2024
ack-prow bot pushed a commit to aws-controllers-k8s/sns-controller that referenced this issue Oct 24, 2024
Fixes aws-controllers-k8s/community#2194

Adds additional printer columns (`ARN`, `Age`, `Synced`) to Topic and Subscription
CRDs to improve kubectl output. Topics also show `DisplayName`.

Output example:
```bash
k get topics
NAME        DISPLAYNAME   SYNCED   AGE
topic-123   My Topic      True     32m

k get subscriptions -owide
NAME               ARN                                                                                 SYNCED   AGE
subscription-123   arn:aws:sns:us-west-2:095708837592:topic-123:a140e042-4de4-44c3-b301-599672805647   True     25m

k get subscriptions
NAME               SYNCED   AGE
subscription-123   True     25m

k get subscriptions -owide
NAME               ARN                                                                                 SYNCED   AGE
subscription-123   arn:aws:sns:us-west-2:095708837592:topic-123:a140e042-4de4-44c3-b301-599672805647   True     25m
```

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
@a-hilaly
Copy link
Member

@daniduhnev1 we just released a new sns and sqs topics improving the kubectl prints. PTAL and let us know if this works!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Categorizes issue or PR as related to existing feature enhancements. service/sns Indicates issues or PRs that are related to sns-controller.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants