Skip to content

Commit 455c1b0

Browse files
committed
chore: Add AGENTS.md
Generated by Claude Code using the '/init' command, and renamed to AGENTS.md Keep a CLAUDE.md symlink since Claude doesn't yet support AGENTS.md.
1 parent 92590fa commit 455c1b0

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

AGENTS.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to AI models and human developers working with code in this repository.
4+
5+
## Project Overview
6+
7+
This repository is a Red Hat fork of the upstream Vector project, specifically maintained for OpenShift Logging. It serves as a log collector and forwarder that runs as a daemon set on each OpenShift cluster node to gather application and node logs.
8+
9+
**Important**: The `rh-main` branch is intentionally minimal and contains only documentation. All active development occurs in version-specific branches.
10+
11+
## Branch Structure
12+
13+
The actual implementation code resides in version-specific branches, not in `rh-main`. Current active branches include:
14+
15+
- `v0.47.0-rh` - OpenShift 6.4 (Vector v0.47.0)
16+
- `v0.37.1-rh` - OpenShift 6.0-6.3 (Vector v0.37.1)
17+
- `release-5.9` - OpenShift 5.9 (Vector v0.34.1)
18+
- `release-5.8` - OpenShift 5.8 (Vector v0.28.1)
19+
20+
## Development Workflow
21+
22+
When working on this project:
23+
24+
1. **Branch Selection**: Switch to the appropriate version branch for your target OpenShift release
25+
2. **Build System**: This is a Rust project using Cargo as the build system
26+
3. **Integration**: The project is designed to be deployed and configured by the [cluster-logging-operator](https://github.com/openshift/cluster-logging-operator)
27+
4. **Runtime**: Runs with configuration and `run.sh` files provided by the operator
28+
29+
## Red Hat Specific Modifications
30+
31+
This fork includes several patches not found in upstream Vector:
32+
33+
- **OpenSSL Integration** (LOG-2552): Replaces Ring with OpenSSL for Red Hat compliance
34+
- **TLS Security Profile** (LOG-3398): Applies OpenShift TLS security settings
35+
- **Syslog Sink** (LOG-2288): Custom syslog output capability
36+
- **File Rotation** (LOG-3949): Enhanced file rotation controls
37+
- **AWS Credentials** (LOG-6789): Fixes for AWS credentials file authentication
38+
- **CloudWatch Limits** (LOG-7013): Updated to match current AWS event size limits
39+
40+
## Issue Reporting
41+
42+
- File issues at [Red Hat JIRA](https://issues.redhat.com)
43+
- Include [must-gather](https://github.com/openshift/cluster-logging-operator/tree/master/must-gather) output for debugging
44+
- Reference the specific OpenShift Logging release version
45+
46+
## Development Notes
47+
48+
- This project is tightly integrated with the OpenShift ecosystem
49+
- Testing and deployment should consider the cluster-logging-operator context
50+
- Changes should maintain compatibility with Red Hat's OpenShift Logging architecture
51+
- Consider upstream contribution potential when making modifications

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/home/aconway/src/vector/AGENTS.md

0 commit comments

Comments
 (0)