Skip to content

Commit 18ee9c6

Browse files
Merge pull request #749 from abays/agents_update
Add some more detail to AGENTS.md Just a bit of additional detail in two sections of AGENTS.md, and then some guidance on testing in CIFMW context. Reviewed-by: Roberto Alfieri
2 parents 1f3bcee + 063e1e1 commit 18ee9c6

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ The upstream repository lives at
2727
| Path | Description |
2828
|---|---|
2929
| `lib/` | Base templates common to all VAs and DTs. |
30+
| `lib/control-plane/` | Control plane components (base, dns, storage, ovn-bridge, etc.). |
31+
| `lib/dataplane/` | Data plane components (nodesets, deployments). |
32+
| `lib/networking/` | Network configurations (metallb, nad, netconfig, nncp). |
3033
| `va/` | VA-specific templates. |
3134
| `dt/` | DT-specific templates. |
3235
| `examples/va/` | User-environment VA templates. Users are expected to modify these. |
@@ -38,6 +41,12 @@ The upstream repository lives at
3841

3942
## Critical rules
4043

44+
### Kustomize patterns
45+
46+
Templates use the kustomize components and overlays pattern for reusability.
47+
Values-based customization is done through YAML files. Remote builds via
48+
GitHub URLs are supported for referencing specific branches or tags.
49+
4150
### Three-layer structure
4251

4352
Templates are organized in three layers:
@@ -213,3 +222,14 @@ automation files in this repo.
213222

214223
When making changes here, consider whether corresponding updates are needed
215224
in the ci-framework scenario files or the ci-framework-jobs variable packs.
225+
226+
To test a scenario locally with CI-Framework:
227+
228+
```bash
229+
git clone https://github.com/openstack-k8s-operators/ci-framework.git
230+
cd ci-framework
231+
make run_ctx_architecture_test \
232+
SCENARIO_NAME=your_scenario \
233+
ARCH_REPO=../architecture \
234+
NET_ENV_FILE=./ci/playbooks/files/networking-env-definition.yml
235+
```

0 commit comments

Comments
 (0)