@backstage-community/plugin-cost-insights 0.12.24 → 0.12.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +6 -6
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ yarn --cwd packages/app add @backstage-community/plugin-cost-insights
|
|
|
24
24
|
|
|
25
25
|
1. Configure `app-config.yaml`. See [Configuration](#configuration).
|
|
26
26
|
|
|
27
|
-
2. Create a CostInsights client. Clients must implement the [CostInsightsApi](https://github.com/backstage/
|
|
27
|
+
2. Create a CostInsights client. Clients must implement the [CostInsightsApi](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/api/CostInsightsApi.ts) interface. Create your own or [use a template](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/example/templates/CostInsightsClient.ts) to get started.
|
|
28
28
|
|
|
29
29
|
Tip: You can also use the `ExampleCostInsightsClient` from `@backstage-community/plugin-cost-insights` to see how the plugin looks with some mock data.
|
|
30
30
|
|
|
@@ -35,7 +35,7 @@ import { CostInsightsApi } from '@backstage-community/plugin-cost-insights';
|
|
|
35
35
|
export class CostInsightsClient implements CostInsightsApi { ... }
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
**Note:** We've briefly explored using the AWS Cost Explorer API to implement a Cost Insights client. Learn more about our findings [here](https://github.com/backstage/
|
|
38
|
+
**Note:** We've briefly explored using the AWS Cost Explorer API to implement a Cost Insights client. Learn more about our findings [here](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/contrib/aws-cost-explorer-api.md).
|
|
39
39
|
|
|
40
40
|
3. Import the client and the Cost Insights plugin API to your Backstage instance.
|
|
41
41
|
|
|
@@ -134,7 +134,7 @@ costInsights:
|
|
|
134
134
|
|
|
135
135
|
For showing cost breakdowns you can define a map of cloud products. They must be defined as keys on the `products` field. A user-friendly name is **required**.
|
|
136
136
|
|
|
137
|
-
You can optionally supply a product `icon` to display in Cost Insights navigation. See the [type file](https://github.com/backstage/
|
|
137
|
+
You can optionally supply a product `icon` to display in Cost Insights navigation. See the [type file](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/types/Icon.ts) for supported types and Material UI icon [mappings](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/utils/navigation.tsx).
|
|
138
138
|
|
|
139
139
|
**Note:** Product keys should be unique and on `camelCase` form. Backstage does not support underscores in configuration keys.
|
|
140
140
|
|
|
@@ -237,8 +237,8 @@ costInsights:
|
|
|
237
237
|
|
|
238
238
|
## Alerts
|
|
239
239
|
|
|
240
|
-
The CostInsightsApi `getAlerts` method may return any type of alert or recommendation (called collectively "Action Items" in Cost Insights) that implements the [Alert type](https://github.com/backstage/
|
|
240
|
+
The CostInsightsApi `getAlerts` method may return any type of alert or recommendation (called collectively "Action Items" in Cost Insights) that implements the [Alert type](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/types/Alert.ts). This allows you to deliver any alerts or recommendations specific to your infrastructure or company migrations.
|
|
241
241
|
|
|
242
|
-
To learn more about using Cost Insights' ready-to-use alerts, see the alerts [README](https://github.com/backstage/
|
|
242
|
+
To learn more about using Cost Insights' ready-to-use alerts, see the alerts [README](https://github.com/backstage/community-plugins/blob/main/workspaces/cost-insights/plugins/cost-insights/src/alerts/README.md).
|
|
243
243
|
|
|
244
|
-
Example implementations of custom alerts, forms and components can be found in the [examples](https://github.com/backstage/
|
|
244
|
+
Example implementations of custom alerts, forms and components can be found in the [examples](https://github.com/backstage/community-plugins/tree/main/workspaces/cost-insights/plugins/cost-insights/src/example) directory.
|