@electrolux-oss/plugin-infrawallet 0.1.9 → 0.1.10

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.
Files changed (2) hide show
  1. package/README.md +39 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -28,17 +28,18 @@ infraWallet:
28
28
  defaultShowLastXMonths: 3 # 3 by default, or other numbers, we recommend it less than 12
29
29
  ```
30
30
 
31
- ### Default Settings for Frontend
31
+ #### Customizing the InfraWalletPage Title and Subtitle
32
32
 
33
- Site admins can configure the default view for InfraWallet, including the default group by dimension, and the default
34
- query period. Add the following configurations to your `app-config.yaml` file if the default view needs to be changed.
33
+ By default, the `InfraWalletPage` component is configured in the `packages/app/src/App.tsx` file as follows:
35
34
 
36
- ```yaml
37
- # note that infraWallet exists at the root level, it is not the same one for backend configurations
38
- infraWallet:
39
- settings:
40
- defaultGroupBy: none # none by default, or provider, category, service, tag:<tag_key>
41
- defaultShowLastXMonths: 3 # 3 by default, or other numbers, we recommend it less than 12
35
+ ```ts
36
+ <Route path="/infrawallet" element={<InfraWalletPage />} />
37
+ ```
38
+
39
+ To customize the title and subtitle of the InfraWalletPage, you can modify the route in the same file as shown below:
40
+
41
+ ```ts
42
+ <Route path="/infrawallet" element={<InfraWalletPage title="Custom title" subTitle="Custom subTitle" />} />
42
43
  ```
43
44
 
44
45
  ### Define Cloud Accounts in app-config.yaml
@@ -111,6 +112,35 @@ backend:
111
112
  tableId: <big_query_table_id>
112
113
  ```
113
114
 
115
+ #### Confluent Cloud
116
+
117
+ To manage Confluent Cloud costs, you need to create an API key (Service account) for your Organization with the 'Cloud resource management' resource scope, you can find the documentation [here](https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/service-accounts/api-keys/manage-api-keys.html#add-an-api-key). Once you have your API key details, add the following settings to `app-config.yaml`:
118
+
119
+ ```yaml
120
+ backend:
121
+ infraWallet:
122
+ integrations:
123
+ confluent:
124
+ - name: <unique_name_of_this_account>
125
+ apiKey: <your_api_key>
126
+ apiSecret: <your_api_key_secret>
127
+ ```
128
+
129
+ #### Mongo Atlas
130
+
131
+ To manage Mongo Atlas costs, you need to create an API key for your Organization with the 'Organization Billing Viewer' permission, you can find the documentation [here](https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-about-org-api-keys). Once you have your API key details, add the following settings to `app-config.yaml`:
132
+
133
+ ```yaml
134
+ backend:
135
+ infraWallet:
136
+ integrations:
137
+ mongoatlas:
138
+ - name: <unique_name_of_this_account>
139
+ orgId: <id_organization_mongo_atlas>
140
+ publicKey: <public_key_of_your_api_key>
141
+ privateKey: <private_key_of_your_api_key>
142
+ ```
143
+
114
144
  ### Adjust Category Mappings if Needed
115
145
 
116
146
  The category mappings are stored in the plugin's database. If there is no mapping found in the DB when initializing the plugin, the default mappings will be used. The default mappings can be found in the [plugins/infrawallet-backend/seeds/init.js](plugins/infrawallet-backend/seeds/init.js) file. You can adjust this seed file to fit your needs, or update the database directly later on.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@electrolux-oss/plugin-infrawallet",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
4
  "backstage": {
5
5
  "role": "frontend-plugin"
6
6
  },