Skip to content

Commit 3191e0e

Browse files
committed
readme: add a note about the billing
Signed-off-by: Maël Valais <mael@vls.dev>
1 parent 79646f3 commit 3191e0e

File tree

2 files changed

+23
-11
lines changed

2 files changed

+23
-11
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,12 @@ local workstation to complete these steps.
383383

384384
[![Open in Cloud Shell](http://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/jetstack/jetstack-secure-gcm&cloudshell_working_dir=/)
385385

386+
The pricing using the CLI to install is identical to using the click-to-deploy
387+
method: each cluster is priced at $50 a month, billed hourly ($0.07/hour). Note
388+
that the cert-manager controller deployment should always have a number of
389+
replicas equal to 1. High-availability for the cert-manager controller is not
390+
supported yet.
391+
386392
### Prerequisites
387393

388394
#### Set up command line tools

docs/TESTING-DEPLOYER.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,28 @@
2323
2424
## Pricing mechanism
2525
26-
The [pricing panel](https://console.cloud.google.com/partner/editor/jetstack-public/jetstack-secure-for-cert-manager?project=jetstack-public&authuser=4&form=saasK8sPricingPanel) is set as:
26+
Each cluster is priced at $50 a month, billed hourly ($0.07/hour). The way the
27+
hourly billing works is by running `ubbagent` which is set as a side-car
28+
container to the cert-manager controller
29+
[deployment](https://github.com/jetstack/jetstack-secure-gcm/blob/c43be00b36f7fd1d01f15771025308b8f5ab69f7/chart/jetstack-secure-gcm/charts/cert-manager/templates/deployment.yaml#L1).
30+
The ubbagent pings the Google Billing API every hour; each ping will add a value
31+
of `1` to the `time` value. The unit for `time` is something we have configured
32+
in the [pricing
33+
panel](https://console.cloud.google.com/partner/editor/jetstack-public/jetstack-secure-for-cert-manager?project=jetstack-public&authuser=4&form=saasK8sPricingPanel).
2734
2835
| Field | Value |
2936
| -------------- | ------ |
30-
| Name | `Time` |
3137
| ID | `time` |
3238
| Unit | `h` |
33-
| Reporting Unit | `h` |
3439
35-
The application contains a ConfigMap that we configured with a heartbeat
36-
period of 1 hour. And since the heartbeat period must be given in seconds,
37-
we give the field `intervalSeconds` a value of 3600. The heartbeat is
38-
configured in
39-
[billing-agent-config.yml](https://github.com/jetstack/jetstack-secure-gcm/blob/c43be00b36f7fd1d01f15771025308b8f5ab69f7/chart/jetstack-secure-gcm/templates/billing-agent-config.yml#L15-L74):
40+
Note that the cert-manager deployment should always be run with replicas=1.
41+
High-availability (replicas > 1) is not supported yet, and the application will
42+
be billed for each replica on the cluster.
43+
44+
The ubbagent's ping period is configured using the `intervalSeconds` field (in
45+
seconds!) in the
46+
[billing-agent-config.yml](https://github.com/jetstack/jetstack-secure-gcm/blob/c43be00b36f7fd1d01f15771025308b8f5ab69f7/chart/jetstack-secure-gcm/templates/billing-agent-config.yml#L15-L74)
47+
that looks like:
4048
4149
```yaml
4250
# File: billing-agent-config.yml
@@ -77,8 +85,6 @@ sources:
7785
int64Value: 1
7886
```
7987
80-
Note that the only supported number of replicas for the cert-manager controller [deployment](https://github.com/jetstack/jetstack-secure-gcm/blob/c43be00b36f7fd1d01f15771025308b8f5ab69f7/chart/jetstack-secure-gcm/charts/cert-manager/templates/deployment.yaml#L1) is 1.
81-
8288
For information, here is the `jetstack-secure-for-cert-manager.yaml` that was
8389
[provided to us](https://github.com/jetstack/platform-board/issues/347); this
8490
file contains the name of the "services" that can be used in the above
@@ -293,7 +299,7 @@ If you go to GKE's [applications
293299
page](https://console.cloud.google.com/kubernetes/application), you should
294300
see everything green:
295301
296-
<img src="https://user-images.githubusercontent.com/2195781/110791519-9acde700-8272-11eb-81f4-4f27fb8a174d.png" width="300" alt="The application page on GKE should show the test-1 application. The preflight deployment is failing because the user has not (yet) gone to http://platform.jetstack.io/ to register their cluster. This screenshot is stored in this issue: https://github.com/jetstack/jetstack-secure-gcm/issues/21">
302+
<img src="https://user-images.githubusercontent.com/2195781/110795922-a96acd00-8277-11eb-959e-bf7ea51ae992.png" width="500" alt="The application page for test-1 shows that all the deployments are green. This screenshot is stored in this issue: https://github.com/jetstack/jetstack-secure-gcm/issues/21">
297303
298304
## Cutting a new release
299305

0 commit comments

Comments
 (0)