Skip to content

LOG-9344: add context files for agentic SDLC#269

Open
vparfonov wants to merge 1 commit into
ViaQ:v0.54.0-rhfrom
vparfonov:log9344-v0.54-rh
Open

LOG-9344: add context files for agentic SDLC#269
vparfonov wants to merge 1 commit into
ViaQ:v0.54.0-rhfrom
vparfonov:log9344-v0.54-rh

Conversation

@vparfonov
Copy link
Copy Markdown

@vparfonov vparfonov commented May 11, 2026

Create four comprehensive context files on rh-main to orient AI agents and developers to this Red Hat fork of Vector:

  • AGENTS.md: Fork-specific quick reference (branch selection, ocp-logging feature scope, patched crates, build commands, OWNERS, Jira conventions) with pointers to upstream docs for generic Vector development

  • CONTRIBUTING.md: Fork-focused contribution guide (branching strategy, PR process, code review, Jira conventions, upstream contribution workflow)

  • ARCHITECTURE.md: Fork architecture (deployment model, ocp-logging feature tables for both v0.47.0-rh and v0.54.0-rh, patched dependencies with rationale, build system, design decisions, upstream sync strategy)

  • CLAUDE.md: Stub pointing to AGENTS.md (matches dev branch pattern)

  • README.md: Updated with doc links, quick-start build snippet, v0.54.0-rh release entry, fixed formatting

All ocp-logging component lists (sources, transforms, sinks) verified against actual Cargo.toml on both dev branches. No upstream duplication — files reference upstream docs for generic Vector content. Upstream files on dev branches left untouched to avoid merge conflicts.

Fixes LOG-9344

Create four comprehensive context files on rh-main to orient AI agents and
developers to this Red Hat fork of Vector:

- AGENTS.md: Fork-specific quick reference (branch selection, ocp-logging
  feature scope, patched crates, build commands, OWNERS, Jira conventions)
  with pointers to upstream docs for generic Vector development

- CONTRIBUTING.md: Fork-focused contribution guide (branching strategy,
  PR process, code review, Jira conventions, upstream contribution workflow)

- ARCHITECTURE.md: Fork architecture (deployment model, ocp-logging feature
  tables for both v0.47.0-rh and v0.54.0-rh, patched dependencies with
  rationale, build system, design decisions, upstream sync strategy)

- CLAUDE.md: Stub pointing to AGENTS.md (matches dev branch pattern)

- README.md: Updated with doc links, quick-start build snippet, v0.54.0-rh
  release entry, fixed formatting

All ocp-logging component lists (sources, transforms, sinks) verified against
actual Cargo.toml on both dev branches. No upstream duplication — files
reference upstream docs for generic Vector content. Upstream files on dev
branches left untouched to avoid merge conflicts.

Fixes LOG-9344

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented May 11, 2026

@vparfonov: This pull request references LOG-9344 which is a valid jira issue.

Details

In response to this:

Create four comprehensive context files on rh-main to orient AI agents and developers to this Red Hat fork of Vector:

  • AGENTS.md: Fork-specific quick reference (branch selection, ocp-logging feature scope, patched crates, build commands, OWNERS, Jira conventions) with pointers to upstream docs for generic Vector development

  • CONTRIBUTING.md: Fork-focused contribution guide (branching strategy, PR process, code review, Jira conventions, upstream contribution workflow)

  • ARCHITECTURE.md: Fork architecture (deployment model, ocp-logging feature tables for both v0.47.0-rh and v0.54.0-rh, patched dependencies with rationale, build system, design decisions, upstream sync strategy)

  • CLAUDE.md: Stub pointing to AGENTS.md (matches dev branch pattern)

  • README.md: Updated with doc links, quick-start build snippet, v0.54.0-rh release entry, fixed formatting

All ocp-logging component lists (sources, transforms, sinks) verified against actual Cargo.toml on both dev branches. No upstream duplication — files reference upstream docs for generic Vector content. Upstream files on dev branches left untouched to avoid merge conflicts.

Fixes LOG-9344

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot requested review from Clee2691 and cahartma May 11, 2026 16:34
@vparfonov
Copy link
Copy Markdown
Author

/retest

Copy link
Copy Markdown
Member

@jcantrill jcantrill left a comment

Choose a reason for hiding this comment

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

nits but otherwise lgtm

Comment thread ARCHITECTURE.md
### Build constraints

- **`lld` linker**: Configured in `.cargo/config.toml`. GNU ld runs out of memory during linking.
- **`protoc` bundled**: Pre-built binaries in `thirdparty/protoc/` (architecture-aware). No network download during build.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we can remove this now we are not bundling it

Comment thread ARCHITECTURE.md

### CI/CD

No in-repo CI pipelines. Builds happen in Red Hat's internal ART/OSBS infrastructure:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

just say "internal infrastructure"

@jcantrill
Copy link
Copy Markdown
Member

/approve

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 19, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jcantrill, vparfonov

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

The pull request process is described 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants