Add make targets for local development setup and documentation - #137
Add make targets for local development setup and documentation#137PuneetPunamiya wants to merge 1 commit into
Conversation
GitHub Actions
Failure
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces automated local development environment setup and cleanup through new Makefile targets and bash scripts. The scripts handle Kind cluster creation, namespace setup, local caching, Docling service management, and LocalStack resource configuration. Feedback was provided to improve the scripts' robustness by adding dependency checks, using relative paths for configuration files, removing unused variables, and ensuring the cleanup process removes the local cache directory.
3f32894 to
f6639f8
Compare
GitHub Actions
Failure
PuneetPunamiya
changed the title
f6639f8 to
f28a507
Compare
GitHub Actions
Failure
f28a507 to
37217a9
Compare
GitHub Actions
Failure
37217a9 to
f940fad
Compare
GitHub Actions
Failure
|
Can we priortise this? I would like to try this as customer 0. Thanks. |
| #!/usr/bin/env bash | ||
| set -e | ||
|
|
||
| export AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION:-us-east-1}" |
There was a problem hiding this comment.
can we move this to yaml
| CACHE_DIR="${CACHE_DIR:-tmp/cache}" | ||
| DATA_STORAGE_BUCKET="${DATA_STORAGE_BUCKET:-data-storage-bucket}" | ||
| DATA_INGESTION_BUCKET="${DATA_INGESTION_BUCKET:-data-ingestion-bucket}" | ||
| OUTPUT_RESULT_BUCKET="${OUTPUT_RESULT_BUCKET:-output-result-bucket}" |
There was a problem hiding this comment.
why such name?
can we follow the convention defined
| CACHE_DIR="${CACHE_DIR:-tmp/cache}" | ||
| DATA_STORAGE_BUCKET="${DATA_STORAGE_BUCKET:-data-storage-bucket}" | ||
| DATA_INGESTION_BUCKET="${DATA_INGESTION_BUCKET:-data-ingestion-bucket}" | ||
| OUTPUT_RESULT_BUCKET="${OUTPUT_RESULT_BUCKET:-output-result-bucket}" |
There was a problem hiding this comment.
why we are introducing these variables in script, these should be part of yaml
this is defining them again, we can keep kind and namespace thing
| echo "✓ Docling is already running" | ||
| else | ||
| echo "Starting Docling in the background..." | ||
| nohup docling-serve run --enable-ui > /tmp/docling.log 2>&1 & |
There was a problem hiding this comment.
this will create dep to install this and not sure how it will work on other system, can we do via sh
| --bucket "${DATA_INGESTION_BUCKET}" \ | ||
| --notification-configuration "file://${NOTIFICATION_FILE}" | ||
| echo "✓ S3 bucket notification configured (queue ARN from LocalStack)" | ||
|
|
There was a problem hiding this comment.
what about ollama setup
| echo "✓ S3 bucket notification configured (queue ARN from LocalStack)" | ||
|
|
||
| echo "" | ||
| echo "✓ Local development environment setup complete!" |
There was a problem hiding this comment.
dont we need to create create and controller config also, or we can do till make install and run
| ```bash | ||
| make run | ||
| ``` | ||
|
|
There was a problem hiding this comment.
make local dev should cover till here i think, i will let @concaf chime in
|
|
||
| ```yaml | ||
| apiVersion: operator.dataverse.redhat.com/v1alpha1 | ||
| kind: SQSInformer |
There was a problem hiding this comment.
this can be created also, as queue is getting created in script
| ### Export Environment Variables | ||
|
|
||
| ```bash | ||
| export IMG=<your-image-registry>/<image-name>:<tag> |
There was a problem hiding this comment.
we can take these variables as input and create controller config and secret also
Add DEVELOPMENT.md guide covering the complete local development workflow including LocalStack setup, CRD installation, controller configuration, and e2e testing with required environment variables Introduce make targets (local-dev-setup, local-dev-cleanup) with corresponding shell scripts to automate local environment creation, including S3 buckets, SQS queues, and Docling service setup. Fix test-e2e target to pass KIND_CLUSTER and SKIP_CLUSTER_SETUP environment variables, preventing duplicate cluster creation and aligning local test execution with CI workflow. Signed-off-by: Puneet Punamiya <ppunamiy@redhat.com>
f940fad to
5541946
Compare
GitHub Actions
Failure
4 participants
Add DEVELOPMENT.md guide covering the complete local development
workflow including LocalStack setup, CRD installation, controller
configuration, and e2e testing with required environment variables
Introduce make targets (local-dev-setup, local-dev-cleanup) with
corresponding shell scripts to automate local environment creation,
including S3 buckets, SQS queues, and Docling service setup.
Fix test-e2e target to pass KIND_CLUSTER and SKIP_CLUSTER_SETUP
environment variables, preventing duplicate cluster creation and
aligning local test execution with CI workflow.