Skip to content

Commit 1279a79

Browse files
rootclaude
root
and
claude
committed
feat: standardize image configurations for CRC prestaging environment
- Update all service image repositories from GHCR to CRC internal registry - Set pullPolicy to Always across all Helm charts for latest image fetching - Add comprehensive CRC setup documentation and configuration scripts - Create config/crc/ directory with automated setup scripts and documentation - Update README.md with detailed CRC configuration instructions This change aligns the prestaging environment with offline production deployment patterns, ensuring all services pull from the internal registry as intended for airgapped environments. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 079cc75 commit 1279a79

41 files changed

Lines changed: 205 additions & 52 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,64 @@ The following port mappings are used across the OmniPDF microservices **for deve
2424
| S3-Compatible Store | Object storage (e.g., MinIO S3 API) | 9000 |
2525
| MinIO Console | MinIO web-based Admin UI | 9001 |
2626

27+
## CRC (OpenShift Local) Setup
28+
29+
OmniPDF uses Red Hat CodeReady Containers (CRC) for local OpenShift development. Due to the resource-intensive nature of running 8+ microservices, CRC requires significant CPU and memory allocation.
30+
31+
### Recommended CRC Configuration
32+
33+
#### Quick Setup (Recommended)
34+
```bash
35+
# Run the automated setup script
36+
./config/crc/setup-crc.sh
37+
38+
# Start CRC with configured settings
39+
crc start
40+
41+
# Set up oc environment
42+
eval $(crc oc-env)
43+
44+
# Get login credentials and login
45+
crc console --credentials
46+
oc login -u kubeadmin -p <password> https://api.crc.testing:6443 --insecure-skip-tls-verify
47+
```
48+
49+
#### Manual Configuration
50+
Alternatively, configure CRC manually:
51+
52+
```bash
53+
# Stop CRC if running
54+
crc stop
55+
56+
# Configure CRC resources (adjust based on your system)
57+
crc config set memory 262144 # 256GB RAM
58+
crc config set cpus 32 # 32 CPU cores
59+
crc config set disk-size 80 # 80GB disk
60+
61+
# Start CRC with new configuration
62+
crc start
63+
```
64+
65+
### Configuration Notes
66+
67+
- **Memory**: 256GB recommended for running all microservices without constraints
68+
- **CPU**: 32 cores provides abundant processing power for OpenShift + services
69+
- **Disk**: 80GB sufficient for container images and persistent data
70+
- **Configuration saved**: Current settings stored in `config/crc/crc-config.txt`
71+
72+
### Verify Setup
73+
74+
```bash
75+
# Check CRC status
76+
crc status
77+
78+
# Check node resources
79+
oc describe node crc | grep -A 10 "Allocated resources"
80+
81+
# View current configuration
82+
crc config view
83+
```
84+
2785
## Development Workflow
2886

2987
This project uses a `Makefile` to simplify common Helm and Kubernetes operations.

‎config/crc/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# CRC Configuration for OmniPDF
2+
3+
This directory contains configuration files and scripts for setting up Red Hat CodeReady Containers (CRC) to run OmniPDF's microservices.
4+
5+
## Quick Setup
6+
7+
### Option 1: Automated Setup (Recommended)
8+
```bash
9+
# Run the setup script to configure CRC
10+
./config/crc/setup-crc.sh
11+
12+
# Start CRC
13+
crc start
14+
```
15+
16+
### Option 2: Manual Configuration
17+
```bash
18+
# Stop CRC if running
19+
crc stop
20+
21+
# Apply configuration manually
22+
crc config set memory 262144 # 256GB RAM
23+
crc config set cpus 32 # 32 CPU cores
24+
crc config set disk-size 80 # 80GB disk
25+
crc config set enable-cluster-monitoring true
26+
crc config set consent-telemetry no
27+
28+
# Start CRC
29+
crc start
30+
```
31+
32+
## Files in this Directory
33+
34+
- `setup-crc.sh` - Automated configuration script
35+
- `README.md` - This file
36+
37+
## Resource Requirements
38+
39+
The configuration assumes you have sufficient system resources:
40+
- **RAM**: At least 256GB+ available system memory
41+
- **CPU**: At least 32+ CPU cores available
42+
- **Disk**: At least 80GB free disk space
43+
44+
Adjust the values in `setup-crc.sh` based on your system capabilities.
45+
46+
## After CRC Starts
47+
48+
1. Set up oc environment:
49+
```bash
50+
eval $(crc oc-env)
51+
```
52+
53+
2. Get login credentials:
54+
```bash
55+
crc console --credentials
56+
```
57+
58+
3. Login as admin:
59+
```bash
60+
oc login -u kubeadmin -p <password> https://api.crc.testing:6443 --insecure-skip-tls-verify
61+
```
62+
63+
4. Deploy OmniPDF services:
64+
```bash
65+
make install-all
66+
```

‎config/crc/setup-crc.sh‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#!/bin/bash
2+
# CRC Setup Script for OmniPDF
3+
# This script configures CRC with optimal settings for running OmniPDF microservices
4+
5+
set -e
6+
7+
echo "Setting up CRC configuration for OmniPDF..."
8+
9+
# Stop CRC if running
10+
echo "Stopping CRC if running..."
11+
crc stop 2>/dev/null || true
12+
13+
# Configure CRC resources
14+
echo "Configuring CRC resources..."
15+
crc config set memory 262144 # 256GB RAM
16+
crc config set cpus 32 # 32 CPU cores
17+
crc config set disk-size 80 # 80GB disk
18+
crc config set enable-cluster-monitoring true
19+
crc config set consent-telemetry no
20+
21+
echo "CRC configuration completed!"
22+
echo ""
23+
echo "Current configuration:"
24+
crc config view
25+
echo ""
26+
echo "To start CRC with these settings, run:"
27+
echo " crc start"
28+
echo ""
29+
echo "After CRC starts, set up oc environment:"
30+
echo " eval \$(crc oc-env)"
31+
echo " crc console --credentials # Get login credentials"

‎helm/assets/README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,23 @@ This directory contains shared assets used across Helm charts.
44

55
## Files
66

7-
- `logo.svg` - Webwork company logo used in Chart.yaml icon fields
7+
- `logo.svg` - WebWork company logo used in Chart.yaml icon fields
88
- **Format**: SVG (112KB)
99
- **Usage**: Referenced in Chart.yaml as GitHub raw URL
10-
- **Company**: Webwork logo for consistent branding across all services
10+
- **Company**: WebWork logo for consistent branding across all services
1111

1212
## Usage in Charts
1313

1414
Reference the logo in your Chart.yaml files:
1515

1616
```yaml
1717
# Chart.yaml
18-
icon: https://github.com/YOUR-ORG/omnipdf/raw/main/helm/assets/logo.svg
18+
icon: file://logo.svg
1919
```
2020
21-
**Note**: Replace `YOUR-ORG` with your actual GitHub organization/username.
22-
2321
## Logo Guidelines
2422
2523
- ✅ **Current logo**: 112KB SVG with transparent background
2624
- ✅ **Works on**: Light and dark backgrounds
2725
- ✅ **Scalable**: Vector format works at any size
28-
- ✅ **Branding**: Consistent Webwork identity across all services
26+
- ✅ **Branding**: Consistent WebWork identity across all services

‎helm/chat-service/values-prestaging.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ secrets:
2828
image:
2929
repository: default-route-openshift-image-registry.apps-crc.testing/omnipdf/chat_service
3030
tag: "dev-v0.0.0-6653136"
31-
pullPolicy: IfNotPresent # Use local registry image
31+
pullPolicy: Always # Use local registry image
3232

3333
# Environment variables
3434
env:

‎helm/chat-service/values-prod.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ secrets:
3030

3131
# Production image handling
3232
image:
33-
pullPolicy: IfNotPresent # Stable tags in production
33+
pullPolicy: Always # Stable tags in production
3434

3535
# Production ingress with proper SSL
3636
ingress:

‎helm/chat-service/values-staging.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ secrets:
3232
image:
3333
repository: default-route-openshift-image-registry.apps-crc.testing/omnipdf/chat_service
3434
tag: "dev-v0.0.1-860e67e"
35-
pullPolicy: IfNotPresent
35+
pullPolicy: Always
3636

3737
# Enable ingress for staging testing
3838
ingress:

‎helm/chat-service/values.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ replicaCount: 2
77

88
# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
99
image:
10-
repository: ghcr.io/notyusheng/chat-service
11-
pullPolicy: Never
10+
repository: default-route-openshift-image-registry.apps-crc.testing/omnipdf/chat_service
11+
pullPolicy: Always
1212
# Overrides the image tag whose default is the chart appVersion.
1313
tag: ""
1414

‎helm/chromadb/values.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ replicaCount: 1
88
# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
99
image:
1010
repository: chromadb/chroma
11-
pullPolicy: IfNotPresent
11+
pullPolicy: Always
1212
# Overrides the image tag whose default is the chart appVersion.
1313
tag: ""
1414

‎helm/cleaner/values.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
replicaCount: 1
66

77
image:
8-
repository: ghcr.io/notyusheng/cleaner
9-
pullPolicy: Never
8+
repository: default-route-openshift-image-registry.apps-crc.testing/omnipdf/cleaner
9+
pullPolicy: Always
1010
# Overrides the image tag whose default is the chart appVersion.
1111
tag: ""
1212

0 commit comments

Comments
 (0)