|
1 | | -# OSEP (OpenSandbox Enhancement Proposals) |
| 1 | +# OpenSandbox Enhancement Proposals |
2 | 2 |
|
3 | | -Use this directory to draft, review, and store enhancement proposals before they |
4 | | -undergo broader discussion. |
| 3 | +See the [OSEP contributing](CONTRIBUTING.md) for information on OSEPs and how to create and merge them. |
5 | 4 |
|
6 | | -> [!NOTE] |
7 | | -> The OSEP process and template structure is inspired by |
8 | | -> [Tekton Enhancement Proposals (TEPs)](https://github.com/tektoncd/community/tree/main/teps). |
| 5 | +This is the complete list of OpenSandbox Enhancement Proposals: |
9 | 6 |
|
10 | | -> [!IMPORTANT] |
11 | | -> **When is an OSEP required?** |
12 | | -> |
13 | | -> Use the OSEP process for changes that: |
14 | | -> - Introduce new features or major enhancements |
15 | | -> - Modify the core sandbox API or runtime behavior |
16 | | -> - Affect the security model or isolation guarantees |
17 | | -> |
18 | | -> Small bug fixes, documentation updates, and minor refactors can be submitted |
19 | | -> directly as Pull Requests without an OSEP. |
20 | | -
|
21 | | -## Getting started |
22 | | - |
23 | | -1. Run the init script to create a new proposal: |
24 | | - |
25 | | - ```bash |
26 | | - oseps/init-osep.sh "Proposal Title" |
27 | | - ``` |
28 | | - |
29 | | - This copies the template, fills in metadata, and creates a sequentially |
30 | | - numbered `0001-proposal-title.md` draft. |
31 | | - |
32 | | -2. Fill in each section from the template (`Summary`, `Motivation`, …). |
33 | | -3. Once ready, submit the resulting file in a PR for community review. |
34 | | - |
35 | | -**Available options:** |
36 | | - |
37 | | -```bash |
38 | | -oseps/init-osep.sh --help |
39 | | -oseps/init-osep.sh --status provisional --author "@username" "My Feature" |
40 | | -``` |
41 | | - |
42 | | -## Template |
43 | | - |
44 | | -The template used for new proposals lives at `oseps/osep-template.md.template` |
45 | | -and mirrors Tekton's TEP structure while capturing the key sections needed |
46 | | -for OpenSandbox planning. Each generated file starts with YAML front matter |
47 | | -followed by the title and TOC: |
48 | | - |
49 | | -```yaml |
50 | | ---- |
51 | | -title: My First Proposal |
52 | | -authors: |
53 | | - - "@your-github-handle" |
54 | | -creation-date: 2025-12-21 |
55 | | -last-updated: 2025-12-21 |
56 | | -status: draft |
57 | | ---- |
58 | | - |
59 | | -# OSEP-0001: My First Proposal |
60 | | - |
61 | | -<!-- toc --> |
62 | | -- [Summary](#summary) |
63 | | -... |
64 | | -<!-- /toc --> |
65 | | -``` |
66 | | - |
67 | | -This YAML front matter renders as a table on GitHub and keeps the proposal |
68 | | -metadata (status, authors, dates) visible at the top of the document. |
69 | | - |
70 | | -## Status lifecycle |
71 | | - |
72 | | -| Status | Description | |
73 | | -|--------|-------------| |
74 | | -| `draft` | Work in progress; not yet under formal review. | |
75 | | -| `provisional` | Maintainers agree with the direction; design details still pending. | |
76 | | -| `implementable` | Design approved and compliance checks passed; ready for implementation. | |
77 | | -| `implementing` | Code is being merged and SDKs are being synchronized. | |
78 | | -| `implemented` | Feature has reached GA status with complete documentation. | |
79 | | -| `withdrawn` | Author has withdrawn the proposal. | |
80 | | -| `rejected` | Maintainers have declined the proposal. | |
| 7 | +| OSEP | Title | Status | Last Updated | |
| 8 | +|:----------------------------------------------------------:|:------------------------------------------:|:-------------:|:------------:| |
| 9 | +| [OSEP-0001](0001-fqdn-based-egress-control.md) | FQDN-based Egress Control | implemented | 2026-01-22 | |
| 10 | +| [OSEP-0002](0002-kubernetes-sigs-agent-sandbox-support.md) | kubernetes-sigs/agent-sandbox Support | implemented | 2026-01-23 | |
| 11 | +| [OSEP-0003](0003-volume-and-volumebinding-support.md) | Volume Support | implementing | 2026-02-11 | |
| 12 | +| [OSEP-0004](0004-secure-container-runtime.md) | Pluggable Secure Container Runtime Support | implementing | 2026-02-09 | |
| 13 | +| [OSEP-0005](0005-client-side-sandbox-pool.md) | Client-Side Sandbox Pool | implementing | 2026-03-09 | |
| 14 | +| [OSEP-0006](0006-developer-console.md) | Developer Console for Sandbox Operations | implementable | 2026-03-06 | |
| 15 | +| [OSEP-0007](0007-fast-sandbox-runtime-support.md) | Fast Sandbox Runtime Support | provisional | 2026-02-08 | |
0 commit comments