Skip to content

Add AGENTS.md#570

Open
fmount wants to merge 1 commit into
openstack-k8s-operators:mainfrom
fmount:agentsmd
Open

Add AGENTS.md#570
fmount wants to merge 1 commit into
openstack-k8s-operators:mainfrom
fmount:agentsmd

Conversation

@fmount
Copy link
Copy Markdown
Contributor

@fmount fmount commented May 7, 2026

This patch adds AGENTS.md to the repo to ensure any AI agent can follow the conventions defined for this operator. At the same time, it allows to not waste time navigating the repo to find initial information and save tokens.

@openshift-ci openshift-ci Bot requested review from karelyatin and slawqo May 7, 2026 11:58
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 7, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: fmount
Once this PR has been reviewed and has the lgtm label, please assign slawqo for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@fmount fmount force-pushed the agentsmd branch 3 times, most recently from 58e7f24 to 2a8ee4b Compare May 8, 2026 09:35
Comment thread AGENTS.md

- [lib-common](https://github.com/openstack-k8s-operators/lib-common): shared modules for conditions, endpoints, TLS, secrets, etc.
- [infra-operator](https://github.com/openstack-k8s-operators/infra-operator): topology APIs.
- [dev-docs/developer.md](https://github.com/openstack-k8s-operators/dev-docs/blob/main/developer.md): developer guide and coding conventions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we also mention neutron-operator here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah makes sense, let me update this and also mention pre-commit like we did in neutron-operator.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Done)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But neutron-operator is dependent on the ovn-operator not the reverse so seems we don't need to add here, if we add then it will also require octavia-operator.
It is something like almost all operator depends on keystone-operator, and in keystone-operator all operators needs to be added as dependency which doesn't look so here checking keystone-operator similar PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah ok, yes, if the dependency is the reverse we don't need to overcomplicate. for deeper inspection I assume the LLM can simply go through go.mod and build the dependency graph, but here is mostly to give a direction about the key dependency we want to establish for the project.
So yes, let's not have other dependencies here other than what we added at the beginning, and then we can improve in a follow up in case we missed something.

Comment thread AGENTS.md Outdated
|------|---------|
| `OVNNorthd` | Manages the OVN Northd deployment (logical-to-physical flow translation). |
| `OVNDBCluster` | Manages OVN database clusters (northbound and southbound OVSDB). |
| `OVNController` | Manages the OVN Controller daemonset (per-node OVS flow management). |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here we should extend ovs and metric daemonsets as well

This patch adds AGENTS.md to the repo to ensure any AI agent can follow
the conventions defined for this operator. At the same time, it allows
to not waste time navigating the repo to find initial information and
save tokens.

Signed-off-by: Francesco Pantano <fpantano@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants