Merge pull request #20 from vshn/pricing

Add setup instructions and adjust pricing
vshn · Nov 4, 2022 · 303d2d7 · 303d2d7
2 parents 95b0d08 + c6793d4
commit 303d2d7
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -14,3 +14,71 @@
 Batch job to sync usage data from the Exoscale API to the [APPUiO Cloud reporting](https://github.com/appuio/appuio-cloud-reporting/) database.
 
 See the [component documentation](https://hub.syn.tools/exoscale-metrics-collector/index.html) for more information.
+
+
+## Getting started for developers
+
+In order to run this tool, you need
+* An instance of the billing database
+* Access to the Exoscale account which has the services to be invoiced
+* Access to the Kubernetes cluster which has the claims corresponding to the Exoscale services
+
+Get all this (see below), and put it all into an 'env' file:
+
+```
+export EXOSCALE_API_KEY="..."
+export EXOSCALE_API_SECRET="..."
+export K8S_SERVER_URL='https://...'
+export K8S_TOKEN='...'
+export ACR_DB_URL="postgres://reporting:reporting@localhost/appuio-cloud-reporting-test?sslmode=disable"
+```
+
+Then source the env file and run the client:
+
+```
+$ . ./env
+$ make build
+$ ./exoscale-metrics-collector objectstorage
+```
+
+### Billing Database
+
+Provided that you have Docker installed, you can easily run a local instance of the billing database by getting the [appuio-cloud-reporting](https://github.com/appuio/appuio-cloud-reporting/) repository and running:
+
+```
+$ cd appuio-cloud-reporting
+$ make docker-compose-up
+```
+
+### Exoscale API key and secret
+
+You can get your Exoscale API key and secret from the Exoscale web UI. Be sure to select the correct project.
+
+The token should be restricted to the 'sos' and 'dbaas' services.
+
+### Kubernetes API token
+
+The following instructions work for OpenShift via the 'oc' utility. Not all of them will work with kubectl.
+
+The commands assume that you are logged in to the Kubernetes cluster you want to use, and your working directory needs to be this git repository.
+
+Instructions for OpenShift >=4.11:
+```
+$ cd exoscale-metrics-collector
+$ oc -n default --as cluster-admin apply -f clusterrole.yaml 
+$ oc -n default --as cluster-admin create serviceaccount vshn-exoscale-metrics-collector
+$ oc --as cluster-admin adm policy add-cluster-role-to-user vshn-exoscale-metrics-collector system:serviceaccount:default:vshn-exoscale-metrics-collector
+$ oc -n default --as cluster-admin apply -f clusterrole-secret.yaml
+$ oc -n default --as cluster-admin get secret vshn-exoscale-metrics-collector-secret -o jsonpath='{.data.token}' | base64 -d
+```
+
+Instuctions for OpenShift <=4.10:
+```
+$ cd exoscale-metrics-collector
+$ oc -n default --as cluster-admin apply -f clusterrole.yaml 
+$ oc -n default --as cluster-admin create serviceaccount vshn-exoscale-metrics-collector
+$ oc --as cluster-admin adm policy add-cluster-role-to-user vshn-exoscale-metrics-collector system:serviceaccount:default:vshn-exoscale-metrics-collector
+$ oc -n default --as cluster-admin serviceaccounts get-token vshn-exoscale-metrics-collector
+```
+
+The last command will print out your token without trailing newline; be sure to copy the correct part of the output.
diff --git a/clusterrole-secret.yaml b/clusterrole-secret.yaml
@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: Secret
+type: kubernetes.io/service-account-token
+metadata:
+  name: vshn-exoscale-metrics-collector-secret
+  annotations:
+    kubernetes.io/service-account.name: vshn-exoscale-metrics-collector
diff --git a/clusterrole.yaml b/clusterrole.yaml
@@ -1,7 +1,3 @@
-# $ oc --as cluster-admin apply -f clusterrole.yaml 
-# $ oc -n default --as cluster-admin create serviceaccount vshn-exoscale-metrics-collector
-# $ oc --as cluster-admin adm policy add-cluster-role-to-user vshn-exoscale-metrics-collector system:serviceaccount:default:vshn-exoscale-metrics-collector
-# $ oc -n default --as cluster-admin serviceaccounts get-token vshn-exoscale-metrics-collector
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:

diff --git a/component/class/defaults.yml b/component/class/defaults.yml
@@ -13,7 +13,7 @@ parameters:
       collector:
         registry: 'ghcr.io'
         repository: 'vshn/exoscale-metrics-collector'
-        tag: 'v0.2.3'
+        tag: 'v0.3.0'
     # Times in UTC! Don't run job around midnight as exoscale API may return incomplete data
     # default: Every day at minute 10 past hour 10, 16 and 20.
     schedule: '10 10,16,20 * * *'
diff --git a/...ector-cloudscale-lpg-2/collector-cloudscale-lpg-2/collector-cloudscale-lpg-2/cronjob.yaml b/...ector-cloudscale-lpg-2/collector-cloudscale-lpg-2/collector-cloudscale-lpg-2/cronjob.yaml
@@ -34,7 +34,7 @@ spec:
               envFrom:
                 - secretRef:
                     name: credentials-collector-cloudscale-lpg-2
-              image: ghcr.io/vshn/exoscale-metrics-collector:v0.2.3
+              image: ghcr.io/vshn/exoscale-metrics-collector:v0.3.0
               name: exoscale-metrics-collector-backfill
               resources: {}
           restartPolicy: OnFailure

diff --git a/...cale-metrics-collector/exoscale-metrics-collector/exoscale-metrics-collector/cronjob.yaml b/...cale-metrics-collector/exoscale-metrics-collector/exoscale-metrics-collector/cronjob.yaml
@@ -34,7 +34,7 @@ spec:
               envFrom:
                 - secretRef:
                     name: credentials-exoscale-metrics-collector
-              image: ghcr.io/vshn/exoscale-metrics-collector:v0.2.3
+              image: ghcr.io/vshn/exoscale-metrics-collector:v0.3.0
               name: exoscale-metrics-collector-backfill
               resources: {}
           restartPolicy: OnFailure

diff --git a/go.mod b/go.mod
@@ -11,7 +11,7 @@ require (
 	github.com/jmoiron/sqlx v1.3.5
 	github.com/stretchr/testify v1.8.0
 	github.com/urfave/cli/v2 v2.20.3
-	github.com/vshn/cloudscale-metrics-collector v0.3.3
+	github.com/vshn/cloudscale-metrics-collector v0.4.0
 	github.com/vshn/provider-exoscale v0.1.0
 	go.uber.org/zap v1.23.0
 	k8s.io/apimachinery v0.25.0

diff --git a/go.sum b/go.sum
@@ -458,6 +458,8 @@ github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyC
 github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ=
 github.com/vshn/cloudscale-metrics-collector v0.3.3 h1:81y66v4WV1dPYYf+gpPwyxHa2bDb+igSXXUIZF/1vrg=
 github.com/vshn/cloudscale-metrics-collector v0.3.3/go.mod h1:Ejyqp4eZDBrjnXJPA66ttA8cI3I06aa6W2CGxV2DB2o=
+github.com/vshn/cloudscale-metrics-collector v0.4.0 h1:hhqxPeQBo+nOHuHjlaRxw8i/nlloteIZDq3NccFnRXc=
+github.com/vshn/cloudscale-metrics-collector v0.4.0/go.mod h1:Ejyqp4eZDBrjnXJPA66ttA8cI3I06aa6W2CGxV2DB2o=
 github.com/vshn/provider-exoscale v0.1.0 h1:2qEYt37BYvTkIvPUYWmZ2pZ7stAy4rGl4CvqTL86CTk=
 github.com/vshn/provider-exoscale v0.1.0/go.mod h1:ilQ+p905LOQByfrwPMnm+kfYRoRn8yXax4i1TJaNYhQ=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=

diff --git a/pkg/database/database.go b/pkg/database/database.go
@@ -31,7 +31,7 @@ var (
 	product = db.Product{
 		Source: queryAndZone,
 		Target: sql.NullString{String: "1402", Valid: true},
-		Amount: 0.00066,
+		Amount: 0.000726,
 		Unit:   "GBDay",
 		During: db.InfiniteRange(),
 	}