Skip to content

Commit aef38af

Browse files
committed
docs: Remove specific username references to make repo more generic
- **Updated README.md:** - Added Quick Start section for immediate usage - Updated clone instructions to use upstream repository - Added clear fork and contribute instructions - Removed specific username references (jeffdyoung, sherine from personal repos) - Cleaned up duplicate content at end of file - **Updated Tekton YAML files:** - Changed default image-namespace from 'jdyoung' to 'your-registry-namespace' - Updated git-url examples to use upstream repository - Made all examples generic and user-agnostic - **Benefits:** - Anyone can now clone and run the repository without modifications - Clear instructions for both direct usage and contribution - Generic examples that work for any user - Consistent references to upstream repository Repository is now completely generic and ready for public use.
1 parent b508f33 commit aef38af

File tree

5 files changed

+43
-78
lines changed

5 files changed

+43
-78
lines changed

README.md

Lines changed: 37 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,50 @@ Before getting started, ensure you have the following installed:
2020
- **Storage**: 10GB free space (for models and dependencies)
2121
- **OS**: Linux (recommended), macOS, or Windows with WSL2
2222

23+
## Quick Start
24+
25+
For users who want to get started immediately:
26+
27+
```bash
28+
# 1. Clone the repository
29+
git clone https://github.com/sherine-k/ci_analysis_agent.git
30+
cd ci_analysis_agent
31+
32+
# 2. Setup Python environment
33+
python3 -m venv venv
34+
source venv/bin/activate # On Windows: venv\Scripts\activate
35+
pip install -r requirements.txt
36+
37+
# 3. Install and start Ollama
38+
curl -fsSL https://ollama.com/install.sh | sh
39+
ollama serve &
40+
41+
# 4. Pull the AI model
42+
ollama pull qwen3:4b
43+
44+
# 5. Install ADK and start the web interface
45+
npm install -g @google/adk
46+
adk web
47+
48+
# 6. Open http://localhost:3000 in your browser
49+
```
50+
2351
## Getting Started
2452

2553
### 1. Clone the Repository
2654

2755
```bash
28-
# Clone your fork
29-
git clone git@github.com:jeffdyoung/ci_analysis_agent.git
56+
# Clone the repository
57+
git clone https://github.com/sherine-k/ci_analysis_agent.git
3058
cd ci_analysis_agent
3159

32-
# Add upstream remote (optional, for contributing)
33-
git remote add upstream [email protected]:sherine-k/ci_analysis_agent.git
60+
# OR if you want to fork and contribute:
61+
# 1. Fork the repository on GitHub
62+
# 2. Clone your fork:
63+
# git clone [email protected]:<your-username>/ci_analysis_agent.git
64+
# cd ci_analysis_agent
65+
# 3. Add upstream remote:
66+
# git remote add upstream https://github.com/sherine-k/ci_analysis_agent.git
3467
```
3568

3669
### 2. Install Dependencies
@@ -404,71 +437,3 @@ For issues and questions:
404437

405438
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
406439

407-
## 🚀 Multi-User Tekton Pipeline Suite
408-
409-
### Files Created:
410-
- **`deploy/tekton/pipeline.yaml`** - Main pipeline definition with 7 stages (multi-user)
411-
- **`deploy/tekton/tasks.yaml`** - Custom tasks for deployment operations (multi-user)
412-
- **`deploy/tekton/rbac.yaml`** - Service account and RBAC permissions
413-
- **`deploy/tekton/pipeline-run.yaml`** - Example pipeline run configuration
414-
- **`deploy/tekton/triggers.yaml`** - Automated GitHub webhook triggers (multi-user)
415-
- **`deploy/tekton/deploy-pipeline.sh`** - Automated deployment script
416-
- **`deploy/tekton/user-examples.yaml`** - Multi-user deployment examples
417-
- **`deploy/tekton/README.md`** - Comprehensive documentation
418-
419-
### Pipeline Flow:
420-
1. **Git Clone** - Fetches source code from any GitHub repository
421-
2. **Create Namespace** - Sets up user-specific namespaces (`ci-analysis-<username>`)
422-
3. **Build Image** - Builds container image using Buildah (user-tagged)
423-
4. **Deploy Ollama** - Deploys Ollama with persistent storage (per user)
424-
5. **Deploy CI Analysis Agent** - Deploys the main application (per user)
425-
6. **Load Model** - Loads the qwen3:4b model into Ollama
426-
7. **Create Route** - Exposes the application via OpenShift Route (per user)
427-
428-
### Key Features:
429-
-**Multi-User Support** - Multiple developers on single cluster
430-
-**Namespace Isolation** - Each user gets their own namespace
431-
-**Resource Prefixing** - All resources prefixed with user identifier
432-
-**OpenShift 4.19+ Compatible** - Full security contexts and RBAC
433-
-**Automated Triggers** - GitHub webhook integration for auto-deployment
434-
-**Persistent Storage** - Ollama model storage across deployments
435-
-**Security Hardened** - Non-root containers, minimal permissions
436-
-**Comprehensive Monitoring** - Full logging and status tracking
437-
-**Registry Integration** - Supports any container registry (Quay.io default)
438-
439-
### Quick Start:
440-
```bash
441-
# Navigate to tekton directory
442-
cd deploy/tekton
443-
444-
# Deploy all pipeline resources
445-
./deploy-pipeline.sh
446-
447-
# Create registry secret in user namespace
448-
oc create secret docker-registry docker-registry-secret \
449-
--docker-server=quay.io \
450-
--docker-username=<your-username> \
451-
--docker-password=<your-password> \
452-
--docker-email=<your-email> \
453-
-n ci-analysis-<username>
454-
455-
# Deploy for user "alice"
456-
./deploy-user-namespace.sh alice
457-
458-
# Monitor progress
459-
tkn pipelinerun logs --last -f -n ci-analysis-alice
460-
```
461-
462-
### Multi-User Deployment:
463-
The pipeline supports multiple users deploying to completely isolated namespaces. Each user gets their own:
464-
- **Namespace**: `ci-analysis-<username>`
465-
- **Pipeline & Tasks**: Deployed in user's namespace
466-
- **Resources**: Prefixed with username (e.g., `alice-ollama`, `bob-ci-analysis-agent`)
467-
- **Routes**: Individual URLs for each deployment
468-
- **Storage**: Isolated persistent volumes
469-
- **Secrets**: Registry credentials in each user namespace
470-
471-
### Automated Deployment:
472-
The pipeline supports GitHub webhooks for automatic deployment on code pushes from any repository. The webhook endpoint automatically creates user-specific deployments based on the repository owner.
473-
474-
The pipeline is production-ready and includes comprehensive error handling, security best practices, and detailed documentation. Perfect for development teams working on the same codebase with different features or environments.

deploy/tekton/pipeline-run.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ spec:
99
name: ci-analysis-agent-pipeline
1010
params:
1111
- name: git-url
12-
value: https://github.com/jeffdyoung/ci_analysis_agent.git
12+
value: https://github.com/sherine-k/ci_analysis_agent.git
1313
- name: git-revision
1414
value: main
1515
- name: target-namespace
@@ -19,7 +19,7 @@ spec:
1919
- name: image-registry
2020
value: quay.io
2121
- name: image-namespace
22-
value: jdyoung
22+
value: your-registry-namespace
2323
- name: image-name
2424
value: ci-analysis-agent
2525
- name: image-tag

deploy/tekton/pipeline.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ spec:
2727
- name: image-namespace
2828
type: string
2929
description: Container image namespace
30-
default: jdyoung
30+
default: your-registry-namespace
3131
- name: image-name
3232
type: string
3333
description: Container image name

deploy/tekton/triggers.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ spec:
9090
- name: image-registry
9191
value: quay.io
9292
- name: image-namespace
93-
value: jdyoung
93+
value: your-registry-namespace
9494
- name: image-name
9595
value: ci-analysis-agent
9696
- name: image-tag

deploy/tekton/user-examples.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ spec:
9494
name: ci-analysis-agent-pipeline
9595
params:
9696
- name: git-url
97-
value: https://github.com/jeffdyoung/ci_analysis_agent.git
97+
value: https://github.com/sherine-k/ci_analysis_agent.git
9898
- name: git-revision
9999
value: main
100100
- name: target-namespace
@@ -132,7 +132,7 @@ spec:
132132
set -e
133133

134134
USERNAME=${1:-dev}
135-
GIT_URL=${2:-https://github.com/jeffdyoung/ci_analysis_agent.git}
135+
GIT_URL=${2:-https://github.com/sherine-k/ci_analysis_agent.git}
136136
GIT_REVISION=${3:-main}
137137
IMAGE_NAMESPACE=${4:-$USERNAME}
138138

0 commit comments

Comments
 (0)