Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Nicolas Bigler <[email protected]>
  • Loading branch information
TheBigLee committed Dec 20, 2023
1 parent f918e63 commit d710e80
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 295 deletions.
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/explanations/data-usage.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= Data Usage

WARNING: This page is outdated and the information below is not correct anymore.

This page gives a brief overview how resources data usage (e.g. buckets) is saved to the postgres billing database.

== Data flow
Expand Down
30 changes: 2 additions & 28 deletions docs/modules/ROOT/pages/how-tos/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

== Requirements

This component requires https://github.com/appuio/component-appuio-cloud-reporting[component-appuio-cloud-reporting] and is installed into the same namespace.
This is required for this component to be able to access the billing database and its connection secrets.
It also requires an Exoscale IAMKey and a Kubernetes/OpenShift Service Account token in the target cluster to get resources (e.g. SOS buckets, Postgres, etc).
This controller is deployed with https://github.com/vshn/component-appcat[component-appcat].

== Sources

The data is matched from a k8s cluster and an Exoscale organization.
The data is matched from the local k8s cluster and the associated Exoscale organization.
The Kubernetes Service Account token is required to have `get` permissions on `Namespaces` and to the following managed resources:

* `buckets.exoscale.crossplane.io`
Expand All @@ -20,27 +18,3 @@ The Kubernetes Service Account token is required to have `get` permissions on `N

=== Exoscale organization
The Access Key (IAM Key) from an Exoscale organization is required to have read access across all managed resources (e.g. SOS buckets, Postgres, etc).

=== K8s cluster
The access to the desired cluster from where the metrics should be collected has to be configured. The current configuration for each instance is done in the
`syn-tenant-repo` under `manifests/<desired-cluster>/billing`

== Example

[source,yaml]
----
applications:
- billing-collector-cloudservices
parameters:
metrics_collector:
exoscale:
enabled: true
objectStorage:
schedule: '10 10,16,20 * * *'
dbaas:
enabled: true # must be manually enabled to scrape DBaas metrics
schedule: '*/15 * * * *'
----

See the xref:references/parameters.adoc[parameters] reference for a full list of parameters.
44 changes: 0 additions & 44 deletions docs/modules/ROOT/pages/how-tos/multi-instance.adoc

This file was deleted.

6 changes: 2 additions & 4 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
= billing-collector-cloudservices

Batch job to sync usage data from the Exoscale and Cloudscale metrics APIs to the https://github.com/appuio/appuio-cloud-reporting/[APPUiO Cloud Reporting] database.
Controller to sync usage data from the Exoscale and Cloudscale metrics APIs to Odoo16

Metrics are collected taking into account product (e.g. `object-storage-storage:exoscale`), source (e.g. `exoscale:namespace`), tenant (organization) and date time.

On DBaaS, we also gather information by Plan. That can be seeing in the product. For example, in the case of a PostgreSQL database service, product may look like `postgres:exoscale:*:*:hobbyist-2`.

See the xref:references/parameters.adoc[parameters] reference for further details.
On DBaaS, we also gather information by Plan. That can be seeing in the product. For example, in the case of a PostgreSQL database service, product may look like `appcat-exoscale-pg-hobbyist-2`.
219 changes: 0 additions & 219 deletions docs/modules/ROOT/pages/references/parameters.adoc

This file was deleted.

0 comments on commit d710e80

Please sign in to comment.