search

bridgecrewio / yor

Extensible auto-tagger for your IaC files. The ultimate way to link entities in the cloud back to the codified resource which created it.
https://www.yor.io
Apache License 2.0
827 stars 123 forks source link

Suggestion: Better document what IaC can be tagged by Yor #285

Closed larryclaman closed 2 years ago

larryclaman commented 2 years ago

I just came across Yor and am quite interested -- looks to be very useful! However, the documentation is not particularly clear with respect to specifying what IaC platforms are supported. The opening docs say: Yor is an open-source tool that helps to manage tags consistently across infrastructure as code frameworks such as Terraform, Cloudformation, Kubernetes, and Serverless Framework. First comment (nitpick): 'such as' isn't a great descriptor. Is this list a subset or complete list of supported platforms?)

Then later in the docs it reads:

Yor can tag the following IaC file types:

Second comment: What happened to Kubernetes? Is it supported or not? Third comment: What is meant by Serverless? Is it AWS Lambda? Azure Functions? Knative? Or do you literally mean the product "Serverless Framework?" Could the docs be updated to be more specific?

Thanks in advance for looking into this!

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

tsmithv11 commented 2 years ago

Hopefully this update helps! Quick answers - no support for Kubernetes yet. We'd love a contribution. Serverless is AWS Serverless Framework.