forked from vectordotdev/vector
-
Notifications
You must be signed in to change notification settings - Fork 10
chore: Add AGENTS.md #237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alanconway
wants to merge
1
commit into
ViaQ:rh-main
Choose a base branch
from
alanconway:agent-md
base: rh-main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
chore: Add AGENTS.md #237
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file provides guidance to AI models and human developers working with code in this repository. | ||
|
|
||
| ## Project Overview | ||
|
|
||
| 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. | ||
|
|
||
| **Important**: The `rh-main` branch is intentionally minimal and contains only documentation. All active development occurs in version-specific branches. | ||
|
|
||
| ## Branch Structure | ||
|
|
||
| The actual implementation code resides in version-specific branches, not in `rh-main`. Current active branches include: | ||
|
|
||
| - `v0.47.0-rh` - OpenShift 6.4 (Vector v0.47.0) | ||
| - `v0.37.1-rh` - OpenShift 6.0-6.3 (Vector v0.37.1) | ||
| - `release-5.9` - OpenShift 5.9 (Vector v0.34.1) | ||
| - `release-5.8` - OpenShift 5.8 (Vector v0.28.1) | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| When working on this project: | ||
|
|
||
| 1. **Branch Selection**: Switch to the appropriate version branch for your target OpenShift release | ||
| 2. **Build System**: This is a Rust project using Cargo as the build system | ||
| 3. **Integration**: The project is designed to be deployed and configured by the [cluster-logging-operator](https://github.com/openshift/cluster-logging-operator) | ||
| 4. **Runtime**: Runs with configuration and `run.sh` files provided by the operator | ||
|
|
||
| ## Red Hat Specific Modifications | ||
|
|
||
| This fork includes several patches not found in upstream Vector: | ||
|
|
||
| - **OpenSSL Integration** (LOG-2552): Replaces Ring with OpenSSL for Red Hat compliance | ||
| - **TLS Security Profile** (LOG-3398): Applies OpenShift TLS security settings | ||
| - **Syslog Sink** (LOG-2288): Custom syslog output capability | ||
| - **File Rotation** (LOG-3949): Enhanced file rotation controls | ||
| - **AWS Credentials** (LOG-6789): Fixes for AWS credentials file authentication | ||
| - **CloudWatch Limits** (LOG-7013): Updated to match current AWS event size limits | ||
|
|
||
| ## Issue Reporting | ||
|
|
||
| - File issues at [Red Hat JIRA](https://issues.redhat.com) | ||
| - Include [must-gather](https://github.com/openshift/cluster-logging-operator/tree/master/must-gather) output for debugging | ||
| - Reference the specific OpenShift Logging release version | ||
|
|
||
| ## Development Notes | ||
|
|
||
| - This project is tightly integrated with the OpenShift ecosystem | ||
| - Testing and deployment should consider the cluster-logging-operator context | ||
| - Changes should maintain compatibility with Red Hat's OpenShift Logging architecture | ||
| - Consider upstream contribution potential when making modifications |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /home/aconway/src/vector/AGENTS.md | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@alanconway specific file should be here?