Skip to content

Commit d240b8b

Browse files
committed
Update docs
1 parent 20f59ef commit d240b8b

3 files changed

Lines changed: 29 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,7 @@ pre-commit install
5454
```
5555

5656
This will set up the hooks defined in `.pre-commit-config.yaml` to run automatically on `git commit`.
57+
58+
## Chartpress
59+
60+
Helm charts are automatically published with [Chartpress](https://github.com/jupyterhub/chartpress) and hosted at [2i2c.org/jupyterhub-cost-monitoring](https://2i2c.org/jupyterhub-cost-monitoring/). Images are hosted at [Quay.io](https://quay.io/repository/2i2c/jupyterhub-cost-monitoring).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2025, Jenny Wong
3+
Copyright (c) 2025, 2i2c
44

55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ This tool provides a per-user cost reporting system for JupyterHubs running on A
1010
2. Cost Estimation – Usage is correlated with AWS cost data to estimate per-user costs.
1111
3. Visualization – Grafana dashboards display rich, interactive views of usage and cost data, making it easy to monitor trends, identify high-cost workloads, and generate reports for funders and decision-makers.
1212

13+
## Installation
14+
15+
This project is designed to be compatible with Zero to JupyterHub distributions, making it easy to deploy in the cloud with Kubernetes.
16+
17+
Add this project as a subchart of the z2jh `Chart.yaml` file with
18+
19+
```yaml
20+
dependencies:
21+
- name: jupyterhub-cost-monitoring
22+
version: "<version-number>"
23+
repository: "https://2i2c.org/jupyterhub-cost-monitoring/"
24+
condition: jupyterhub-cost-monitoring.enabled
25+
```
26+
27+
In the values file, enable the cost monitoring chart for your Kubernetes cluster:
28+
29+
```yaml
30+
jupyterhub-cost-monitoring:
31+
enabled: true
32+
extraEnv:
33+
- name: CLUSTER_NAME
34+
value: "<name-of-cluster>"
35+
```
36+
1337
## Contributing
1438
1539
Contributions to the `jupyterhub-cost-monitoring` project are welcome! Please follow the standard GitHub workflow:

0 commit comments

Comments
 (0)