Skip to content

Commit 42688a0

Browse files
committed
docs(readme): add OpenSSF Scorecard badge
The scorecard workflow already publishes results (publish_results: true); this surfaces the score in the README badge row. Badge image: api.securityscorecards.dev; click-through: scorecard.dev viewer.
1 parent 8582c71 commit 42688a0

1 file changed

Lines changed: 36 additions & 8 deletions

File tree

README.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,24 @@
1313
</p>
1414

1515
<p align="center">
16-
<a href="https://pypi.org/project/orb-py/"><img src="https://img.shields.io/pypi/v/orb-py" alt="PyPI Version"></a>
17-
<a href="https://pypi.org/project/orb-py/"><img src="https://img.shields.io/pypi/pyversions/orb-py" alt="Python Versions"></a>
1816
<a href="LICENSE"><img src="https://img.shields.io/github/license/finos/open-resource-broker" alt="License"></a>
17+
<a href="https://pypi.org/project/orb-py/"><img src="https://img.shields.io/pypi/v/orb-py" alt="PyPI Version"></a>
1918
<a href="https://github.com/finos/open-resource-broker/releases"><img src="https://img.shields.io/github/v/release/finos/open-resource-broker" alt="Latest Release"></a>
19+
<a href="https://pypi.org/project/orb-py/"><img src="https://img.shields.io/pypi/pyversions/orb-py" alt="Python Versions"></a>
2020
<a href="https://deepwiki.com/finos/open-resource-broker"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
21-
</p>
22-
23-
<p align="center">
21+
<br>
2422
<a href="https://github.com/finos/open-resource-broker/actions/workflows/ci-tests.yml"><img src="https://github.com/finos/open-resource-broker/actions/workflows/ci-tests.yml/badge.svg" alt="Unit Tests"></a>
2523
<a href="https://github.com/finos/open-resource-broker/actions/workflows/ci-quality.yml"><img src="https://github.com/finos/open-resource-broker/actions/workflows/ci-quality.yml/badge.svg" alt="Quality Checks"></a>
2624
<a href="https://github.com/finos/open-resource-broker/actions/workflows/security-code.yml"><img src="https://github.com/finos/open-resource-broker/actions/workflows/security-code.yml/badge.svg" alt="Security Scanning"></a>
27-
<a href="https://codecov.io/gh/finos/open-resource-broker"><img src="https://codecov.io/gh/finos/open-resource-broker/graph/badge.svg" alt="Coverage"></a>
2825
<a href="https://github.com/finos/open-resource-broker/actions/workflows/docs.yml"><img src="https://github.com/finos/open-resource-broker/actions/workflows/docs.yml/badge.svg" alt="Documentation"></a>
26+
<br>
27+
<a href="https://codecov.io/gh/finos/open-resource-broker"><img src="https://codecov.io/gh/finos/open-resource-broker/graph/badge.svg" alt="Coverage"></a>
28+
<a href="https://scorecard.dev/viewer/?uri=github.com/finos/open-resource-broker"><img src="https://api.securityscorecards.dev/projects/github.com/finos/open-resource-broker/badge" alt="OpenSSF Scorecard"></a>
2929
</p>
3030

3131
---
3232

33-
ORB is a unified API for orchestrating and provisioning compute capacity programmatically. Define what you need in a template, request it, track it, return it — through a CLI, REST API, Python SDK, or MCP server.
33+
Open Resource Broker (ORB) is a unified API for orchestrating and provisioning compute capacity programmatically. Define what you need in a template, request it, track it, return it — through a CLI, REST API, Python SDK, or MCP server.
3434

3535
Built for AWS today (EC2, Auto Scaling Groups, SpotFleet, EC2Fleet), with an extensible provider system for adding new cloud backends.
3636

@@ -192,6 +192,31 @@ See the [AWS Provider Guide](docs/root/user_guide/configuration.md) for required
192192

193193
</details>
194194

195+
<details>
196+
<summary>Kubernetes Provider Setup</summary>
197+
198+
ORB uses the standard Kubernetes client credential chain — any context that works with `kubectl` works with ORB. Running in-cluster, it auto-detects the mounted service account; running outside, it reads your `KUBECONFIG` and current context.
199+
200+
```bash
201+
# Verify your context is active
202+
kubectl config current-context
203+
```
204+
205+
**Supported credential methods:** `KUBECONFIG` contexts, the default `~/.kube/config`, and in-cluster service accounts (auto-detected). See [provider discovery](docs/root/providers/k8s/discovery.md) for the detection order.
206+
207+
### Supported resource types
208+
209+
| Type | Description |
210+
|---|---|
211+
| `Pod` | Single-pod provisioning |
212+
| `Deployment` | Replica-managed stateless workloads |
213+
| `StatefulSet` | Stable-identity stateful workloads |
214+
| `Job` | Run-to-completion batch workloads |
215+
216+
Install with `pip install "orb-py[k8s]"`. Minimum RBAC is in [`docs/root/providers/k8s/rbac.yaml`](docs/root/providers/k8s/rbac.yaml); see the [Kubernetes Provider Guide](docs/root/providers/k8s/index.md) for full setup.
217+
218+
</details>
219+
195220
## Interfaces
196221

197222
ORB provides four ways to interact with your infrastructure.
@@ -377,7 +402,8 @@ curl http://localhost:8000/health
377402

378403
</details>
379404

380-
## Symphony HostFactory on Kubernetes (legacy)
405+
<details>
406+
<summary>Symphony HostFactory on Kubernetes (legacy)</summary>
381407

382408
The `k8s-legacy` module is a Symphony HostFactory custom provider plugin for Kubernetes, predating the modern multi-cloud ORB architecture. It is now bundled with `orb-py` as an optional install extra rather than as a separate PyPI package.
383409

@@ -398,6 +424,8 @@ The plugin is in maintenance mode. A modern Kubernetes provider with native ORB
398424
- **Upgrading from `open-resource-broker`?** See the [migration guide](docs/root/operational/from-open-resource-broker.md).
399425
- **Deploying the Symphony HF plugin?** See the [k8s-legacy deployment guide](k8s-legacy/README.md).
400426

427+
</details>
428+
401429
## Project
402430

403431
Architecture, development, and documentation.

0 commit comments

Comments
 (0)