kubernetes-sigs/aws-load-balancer-controller

Inconsistent annotation documentation for k8s service objects

オープン

#3,776 opened on 2024/07/22

 (3 件のコメント) (0 件のリアクション) (0 人の担当者)Go (1,644 件のフォーク)auto 404
good first issuekind/documentation

Repository metrics

Stars
 (4,317 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Is your feature request related to a problem? Going through the documentation it can be confusing to find the correct annotations for k8s objects. The documentation page is usually quite clear and good for initial setup but once there's a need to modify the defaults it's not clear which source should be trusted and leads to additional Google searches and trial and error approach which could be easily avoided.

In this instance I was trying to limit the subnets used for a particular LB and I knew it was supported but finding the correct annotation or place in the docs was not clear.

It may have been my fault but the annotation list split in the docs (Ingress/Service), having to click through different sections and pages and the page search not clearly returning a simple list is a drawback.

Describe the solution you'd like Perhaps the annotation list could be joined or displayed in a way where it's easy to search through all of the available annotations would be more beneficial for discovery and deciding which one to go for.

Additionally the subnet discovery page doesn't mention the fact that subnets can be manually configured with a link to the annotations which would be great: subnet discovery subnet annotations

The search in the docs page could be improved but that's beyond the scope I'd guess.

Anyway, thanks for a great project and support!

コントリビューターガイド