Skip to content

Commit

Permalink
Update readme file (#55)
Browse files Browse the repository at this point in the history
* Update readme file

* Updates

* Update README.md

* Update README.md

* updates

* update

---------

Co-authored-by: dsingh <[email protected]>
  • Loading branch information
Kaaku2302 and dsingh authored Oct 17, 2024
1 parent 24ddb7a commit 6c540da
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The app is configured using environment variables defined in a .env file. The fo
| SERVICE_APP_CLIENT_ID | The service account client ID used to obtain an access token for the Flexera One API. Please refer to [Using a Service Account](https://docs.flexera.com/flexera/EN/FlexeraAPI/ServiceAccounts.htm?Highlight=service%20account) in the Flexera documentation. This parameter is incompatible with REFRESH_TOKEN, use only one of them. |
| SERVICE_APP_CLIENT_SECRET | The service account client secret used to obtain an access token for the Flexera One API. Please refer to [Using a Service Account](https://docs.flexera.com/flexera/EN/FlexeraAPI/ServiceAccounts.htm?Highlight=service%20account) in the Flexera documentation. |
| SHARD | The zone of your Flexera One account. Valid values are NAM, EU or AU. |
| INCLUDE_PREVIOUS_MONTH | Indicates whether to collect and export previous month data. Default is true. Setting this flag to false will prevent collecting and uploading the data from previous month and only upload data for the current month. |
| INCLUDE_PREVIOUS_MONTH | Indicates whether to collect and export previous month data. Default is true. Setting this flag to false will prevent collecting and uploading the data from previous month and only upload data for the current month. Partial Data (i.e. missing data for some days) for previous month will not be uploaded even if the flag value is set to true.|
| REQUEST_TIMEOUT | Indicates the timeout per each request in minutes. |
| KUBECOST_HOST | The hostname of the Kubecost instance. Default is "kubecost-cost-analyzer.kubecost.svc.cluster.local:9090". |
| KUBECOST_API_PATH | The base path for the Kubecost API endpoint. Default is "/model/" |
Expand Down Expand Up @@ -184,9 +184,7 @@ You should see 200/201s in the logs, which indicates that the exporter is workin
| image.repository | string | `"public.ecr.aws/flexera/cbi-oi-kubecost-exporter"` | |
| image.tag | string | `"1.17"` | |
| imagePullSecrets | list | `[]` | |
| includePreviousMonth | bool | `true` | Indicates whether to collect and export previous month data. Default is true. Setting this
flag to false
will prevent collecting and uploading the data from previous month and only upload data for the current month. |
| includePreviousMonth | bool | `true` | Indicates whether to collect and export previous month data. Default is true. Setting this flag to false will prevent collecting and uploading the data from previous month and only upload data for the current month. Partial Data (i.e. missing data for some days) for previous month will not be uploaded even if the flag value is set to true.|
| kubecost.aggregation | string | `"pod"` | The level of granularity to use when aggregating the cost data. Valid values are namespace, controller, node, or pod. |
| kubecost.apiPath | string | `"/model/"` | The base path for the Kubecost API endpoint. |
| kubecost.host | string | `"kubecost-cost-analyzer.kubecost.svc.cluster.local:9090"` | Default kubecost-cost-analyzer service host on the current cluster. For current cluster is serviceName.namespaceName.svc.cluster.local |
Expand Down
4 changes: 1 addition & 3 deletions helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@ You should see 200/201s in the logs, which indicates that the exporter is workin
| image.repository | string | `"public.ecr.aws/flexera/cbi-oi-kubecost-exporter"` | |
| image.tag | string | `"1.20"` | |
| imagePullSecrets | list | `[]` | |
| includePreviousMonth | bool | `true` | Indicates whether to collect and export previous month data. Default is true. Setting this
flag to false
will prevent collecting and uploading the data from previous month and only upload data for the current month. |
| includePreviousMonth | bool | `true` | Indicates whether to collect and export previous month data. Default is true. Setting this flag to false will prevent collecting and uploading the data from previous month and only upload data for the current month. Partial Data (i.e. missing data for some days) for previous month will not be uploaded even if the flag value is set to true. |
| kubecost.aggregation | string | `"pod"` | The level of granularity to use when aggregating the cost data. Valid values are namespace, controller, node, or pod. |
| kubecost.apiPath | string | `"/model/"` | The base path for the Kubecost API endpoint. |
| kubecost.host | string | `"kubecost-cost-analyzer.kubecost.svc.cluster.local:9090"` | Default kubecost-cost-analyzer service host on the current cluster. For current cluster is serviceName.namespaceName.svc.cluster.local |
Expand Down

0 comments on commit 6c540da

Please sign in to comment.