[Enhancement] Provide extensive examples in the docs for created objects (cloud, Kubernetes manifest/YAML)

[spkane]

Description

The current documentation (e.g. AWS Cloud Integration) is very focused on manual setups using very specific tools. It talks you through using tools like eksctl without even sharing the cloud objects or k8s manifests that will be generated. This makes it difficult to follow when you are not using those tools.

At a minimum, it would be nice, if each command, then said, and you will see these objects with configurations similar to this created in your cloud account, and you will see Kubernetes manifests like this applied to your cluster.

• Along these lines, it would also be wonderful if there was documentation for at least one of the more common automation approaches, like terraform, providing a solid example of how the installation can be achieved with that toolset.
  • A maintained terraform module would be helpful, but honestly, even robust examples would be a vast improvement. Trying to translate the current docs has been pretty challenging.

[chipzoller]

Hi @spkane and thank you for proposing some enhancements here. Regarding your statement:

without even sharing the cloud objects or k8s manifests that will be generated. This makes it difficult to follow when you are not using those tools.

Many of these commands/procedures result in AWS changes. Or were you referring to another section? If so, can you provide the link to the docs you're suggesting enhancements? Could you additionally provide a short example of what you think would be helpful?

[spkane]

@chipzoller I didn't see your original comment, and I have long since moved on to other things, but the idea here was that your directions on how to set up AWS don't explain how to set up AWS. They just talked about running commands like eksctl, which is only useful if you don't use any other tools, like terraform, and want to just blindly type commands into the console.

The suggestion was that you all seriously consider expanding the documentation so that it makes it clear what you need to set up in AWS for Kubecost to work. So, instead of "run this eksctl command", say something like "you need to create a Role with these options set at a minimum..., which can be accomplished using this eksctl command, among other ways."