Skip to content

Commit 58630b6

Browse files
committed
docs: Revise README to enhance clarity on prerequisites for DigitalOcean Marketplace installations, including Nginx Ingress Controller, and reorganize contributing section for better visibility.
1 parent 7468624 commit 58630b6

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,18 @@ DigitalOcean Cloud Controller Manager applies annotation changes to the actual L
1616

1717
## Prerequisites
1818

19-
- Install the DigitalOcean Marketplace Metrics Server: [Kubernetes Metrics Server](https://marketplace.digitalocean.com/apps/kubernetes-metrics-server)
20-
- Install a Prometheus stack (for scraping ingress metrics): [Kubernetes Monitoring Stack (kube-prometheus-stack)](https://marketplace.digitalocean.com/apps/kubernetes-monitoring-stack)
19+
- Install from the DigitalOcean Kubernetes Marketplace:
20+
- [Kubernetes Metrics Server](https://marketplace.digitalocean.com/apps/kubernetes-metrics-server)
21+
- [Kubernetes Monitoring Stack](https://marketplace.digitalocean.com/apps/kubernetes-monitoring-stack) (kube-prometheus-stack)
22+
- [Nginx Ingress Controller](https://marketplace.digitalocean.com/apps/nginx-ingress-controller) (optional, any ingress controller should work)
2123

2224
## Required annotations
2325

2426
- `kubernetes.digitalocean.com/load-balancer-id`: the DO LB ID.
2527
- `doks-lb-scale/metric`: the metric to use. Must be a Prometheus query prefixed with `promql:`.
2628
- `doks-lb-scale/target-per-node`: REQUIRED: `req=<int>` (requests per second per node target)
2729

28-
Only HTTP/ingress metrics are supported. NLB throughput-based scaling is no longer supported.
30+
Only HTTP/ingress metrics are supported.
2931

3032
Optional annotations:
3133
- `doks-lb-scale/hysteresis-percent`: default `20`.
@@ -101,16 +103,6 @@ kubectl apply -f config/deployment.yaml
101103

102104
Set the Prometheus URL via the `--prom-url` flag or `PROMETHEUS_URL` env var. The provided deployment sets `PROMETHEUS_URL` to `http://ingress-nginx-controller-metrics:9090` by default; adjust to your cluster.
103105

104-
## Contributing
105-
106-
### Build and push container image (for contributors)
107-
108-
```bash
109-
# Build multi-arch image (adjust registry/name as needed)
110-
IMAGE=ghcr.io/your-org/doks-lb-scale:latest
111-
docker build --platform linux/amd64,linux/arm64 -t $IMAGE --push .
112-
```
113-
114106
After pushing, update `config/deployment.yaml` to point to your published image.
115107

116108
## Notes
@@ -130,6 +122,12 @@ If desired is within [lower, upper], nothing changes.
130122
Quick examples:
131123
- current 10, pct 20% → window [8,12]; desired 12 = no change; 13 = scale up; 7 = scale down
132124
- current 5, pct 10% → window [4,5]; desired 4 = no change; 6 = scale up; 3 = scale down
133-
- current 1, pct 20% → window [0,1]; desired 1 = no change; ≥2 = scale up (min-nodes still applies)
125+
- current 1, pct 20% → window [0,1]; desired 1 = no change; ≥2 = scale up (min-nodes still applies)`
126+
127+
## Contact
128+
129+
If you wish to learn more about DigitalOcean's services, you are welcome to reach out to the sales team at [email protected]. A global team of talented engineers will be happy to provide assistance.
130+
131+
## License
134132

135-
Notes: integer truncation is used; min/max nodes are enforced.
133+
This GitHub Action and associated scripts and documentation in this project are released under the MIT License.

0 commit comments

Comments
 (0)