kubecost / docs

GitHub repository for the official Kubecost documentation.
http://docs.kubecost.com
89 stars 103 forks source link

[Enhancement] Making external AWS docs on Athena setup mandatory #1020

Closed chipzoller closed 4 months ago

chipzoller commented 4 months ago

Description

In step 2 of the AWS integration here, the first paragraph currently shows the following.

As part of the CUR creation process, Amazon also creates a CloudFormation template that is used to create the Athena integration. It is created in the CUR S3 bucket, listed in the Objects tab in the path s3-path-prefix/cur-name and typically has the filename crawler-cfn.yml. This .yml is your necessary CloudFormation template. You will need it in order to complete the CUR Athena integration. For more information, see the AWS doc Setting up Athena using AWS CloudFormation templates.

The last sentence there suggests that the link to the AWS page is optional or informative. It is not. This step MUST be followed in order to proceed to additional steps.

The docs need to clearly state users should follow the linked procedure before proceeding to the next step or else the integration will not be possible.

brstuder commented 4 months ago

This doesn't imply that, it just says that if users want more help regarding where to find the required .yml CloudFormation template, they should consult AWS themselves. See:

You will need it in order to complete the CUR Athena integration.

I don't think we treat this as optional at all

chipzoller commented 4 months ago

What I'm suggesting is the last sentence, rather than saying "see this AWS doc" stating, in no uncertain terms, that the procedure outlined in that doc must be followed once you have the CFT in hand. The way it's worded does not make this clear, and, in fact, when I went through this process myself with a fresh AWS account I was at an impasse because of it.

brstuder commented 4 months ago

We've had this in the doc for a while. Does this need to be updated/corrected?

Athena is technically optional for AWS cloud integration, but as a result, Kubecost will only provide unreconciled costs (on-demand public rates).

chipzoller commented 4 months ago

No, it's accurate technically, but for all intents and purposes Athena is required to see the true Kubecost value.