paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

Add reference to doc in main README

Browse Source 
Signed-off-by: Brenda Sukh <brendasukh@gmail.com>
This commit is contained in:
Brenda Sukh
2021-02-26 12:01:48 -05:00
parent 67f47a8282
commit 3b1a0715c2
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/cost-insights/README.md
+2
View File
@@ -25,6 +25,8 @@ yarn add @backstage/plugin-cost-insights
2. Create a CostInsights client. Clients must implement the CostInsightsApi interface. See the [API file](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/api/CostInsightsApi.ts) for required methods and documentation.
**Note:** We've briefly explored using the AWS Cost Explorer API to implement a CostInsights client. Learn more about our findings [here](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/contrib/aws-cost-explorer-api.md).
```ts
// path/to/CostInsightsClient.ts
import { CostInsightsApi } from '@backstage/plugin-cost-insights';
plugins/cost-insights/contrib/aws-cost-explorer-api.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Using the AWS Cost Explorer API with Cost Insights
Cost Insights currently does not provide a CostInsightsApi client out of the box, this is left up to the implementr. We plan to provide an open-source client and backend eventually that can pull cost data from different cloud providers. In the meantime, we briefly explored the AWS Cost Explorer API and wanted to share our findings. Please contribute to this documentation if you try any experiments with AWS Cost Explorer.
Cost Insights currently does not provide a CostInsightsApi client out of the box, this is left up to the implementer. We plan to provide an open-source client and backend eventually that can pull cost data from different cloud providers. In the meantime, we briefly explored the AWS Cost Explorer API and wanted to share our findings. Please contribute to this documentation if you try any experiments with AWS Cost Explorer.
**Note:** Each request using the Cost Explorer API will incur a cost of \$0.01. If you anticipate high usage, adding some caching of Cost Explorer API responses could prove worthwhile over time.