Skip to content

chore(inkless): Update demo and documentation for GHCR images#497

Merged
viktorsomogyi merged 4 commits intomainfrom
jeqo/update-demo-docs
Feb 3, 2026
Merged

chore(inkless): Update demo and documentation for GHCR images#497
viktorsomogyi merged 4 commits intomainfrom
jeqo/update-demo-docs

Conversation

@jeqo
Copy link
Copy Markdown
Contributor

@jeqo jeqo commented Feb 3, 2026

Align docker demo and documentation to use ghcr.io/aiven/inkless image registry.

Depends on: #489 (release workflows)

Changes

Docker Demo:

  • Default KAFKA_VERSION changed from local to edge
  • Updated docker-compose files to use ghcr.io/aiven/inkless:${KAFKA_VERSION}
  • Added image version options documentation
  • Clarified cleanup: "Press Ctrl+C, then run make destroy"
  • Added monitoring section with log commands and Grafana dashboards

Documentation:

  • New docs/inkless/RELEASES.md - Docker tags and binary distribution reference
  • Updated docs/inkless/QUICKSTART.md:
    • Added prerequisites section
    • Added demo services table with URLs and credentials
    • Added demo backends section (s3-local, gcs-local, azure-local, s3-aws)
    • Added binary usage guide referencing sample configs
    • Added monitoring instructions
  • Updated docs/inkless/README.md - Quick Start decision tree
  • Updated docs/inkless/VERSIONING-STRATEGY.md - Workflow trigger details

Testing

# With locally built image (before edge is available)
make docker_build
make demo KAFKA_VERSION=local

# With GHCR image (after #489 is merged)
make demo  # Uses edge by default
make demo KAFKA_VERSION=latest

Image Options

KAFKA_VERSION Description
edge Latest development build (default)
latest Latest stable release
4.1.0-0.33 Specific version
local Locally built image

@jeqo jeqo mentioned this pull request Feb 3, 2026
Merged
@jeqo jeqo changed the base branch from main to jeqo/release-workflow February 3, 2026 08:12
@jeqo jeqo requested a review from Copilot February 3, 2026 08:42
Copilot AI reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Inkless demo and documentation to use the new GitHub Container Registry (GHCR) image location ghcr.io/aiven/inkless, aligning with the release workflows added in PR #489. The default demo now uses the edge tag (latest development build) instead of locally built images.

Changes:

  • Updated image registry from aivenoy/kafka to ghcr.io/aiven/inkless across all docker-compose files
  • Changed default KAFKA_VERSION from 4.1.0-inkless-SNAPSHOT (local) to edge (GHCR)
  • Added comprehensive documentation for Docker tags, binary distributions, and version selection

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/inkless/RELEASES.md New documentation describing available Docker tags (stable and development) and binary distribution naming/download instructions
docs/inkless/VERSIONING-STRATEGY.md Added CI/CD automation notes explaining workflow triggers and tag relationships
docs/inkless/README.md Added Quick Start decision tree with links to demo, prebuilt images, binaries, and build-from-source options
docs/inkless/QUICKSTART.md Enhanced with prerequisites, demo services table, backend options, binary usage guide with config references, and monitoring instructions
docker/examples/docker-compose-files/inkless/README.md Updated with image version options, monitoring section, and services/credentials table
docker/examples/docker-compose-files/inkless/Makefile Changed default KAFKA_VERSION to edge with documentation comments explaining version options
docker/examples/docker-compose-files/inkless/docker-compose.yml Updated image reference to ghcr.io/aiven/inkless:${KAFKA_VERSION}
docker/examples/docker-compose-files/inkless/docker-compose.demo.yml Updated image reference to ghcr.io/aiven/inkless:${KAFKA_VERSION}
docker/inkless/Dockerfile Fixed COPY paths to be relative to docker/ build context (removed ./ prefix, added inkless/ subdirectory path)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jeqo jeqo force-pushed the jeqo/release-workflow branch from 42c92ee to afa80b6 Compare February 3, 2026 08:54
@jeqo jeqo force-pushed the jeqo/update-demo-docs branch 2 times, most recently from 5174e12 to 4f31ea2 Compare February 3, 2026 09:30
@jeqo jeqo force-pushed the jeqo/release-workflow branch from a2d648f to eec1436 Compare February 3, 2026 09:47
@jeqo jeqo force-pushed the jeqo/update-demo-docs branch from 4f31ea2 to b8c2af9 Compare February 3, 2026 09:47
@jeqo jeqo requested a review from Copilot February 3, 2026 09:47
Copilot AI reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Base automatically changed from jeqo/release-workflow to main February 3, 2026 11:38
@jeqo jeqo force-pushed the jeqo/update-demo-docs branch from b8c2af9 to 65f8f18 Compare February 3, 2026 11:40
@jeqo jeqo requested a review from Copilot February 3, 2026 11:41
Copilot AI reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jeqo jeqo force-pushed the jeqo/update-demo-docs branch 2 times, most recently from 4585a3b to d497e62 Compare February 3, 2026 11:58
@jeqo jeqo requested a review from Copilot February 3, 2026 11:58
@jeqo jeqo marked this pull request as ready for review February 3, 2026 11:58
@jeqo jeqo requested a review from viktorsomogyi February 3, 2026 11:58
Copilot AI reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

viktorsomogyi
viktorsomogyi previously approved these changes Feb 3, 2026
View reviewed changes
jeqo added 3 commits February 3, 2026 14:11
@jeqo
refactor(docker): update demo to use GHCR images
1b23524 
- Change default KAFKA_VERSION from local to edge
- Update docker-compose to use ghcr.io/aiven/inkless
- Add image version options documentation
- Update Ctrl+C instructions (run make destroy to clean up)
- Add monitoring section to demo README
- Simplify Dockerfile COPY paths
@jeqo
docs(inkless): add releases documentation and update quickstart
2f4b660 
- Add Quick Start decision tree to README.md
- Update QUICKSTART.md:
  - Add prerequisites section
  - Add demo backends and services table
  - Add binary usage guide with sample configs
  - Add monitoring instructions
  - Fix podman compose references
@jeqo
chore(inkless:docker): add link to repository
9399e8d
@jeqo jeqo force-pushed the jeqo/update-demo-docs branch from d497e62 to 9399e8d Compare February 3, 2026 12:11
viktorsomogyi
viktorsomogyi reviewed Feb 3, 2026
View reviewed changes
@jeqo jeqo requested a review from viktorsomogyi February 3, 2026 12:45
@viktorsomogyi viktorsomogyi merged commit bbf4963 into main Feb 3, 2026
5 checks passed
@viktorsomogyi viktorsomogyi deleted the jeqo/update-demo-docs branch February 3, 2026 13:47
jeqo added a commit that referenced this pull request Feb 6, 2026
@jeqo
chore(inkless): Update demo and documentation for GHCR images (#497)
df14454 
refactor(docker): update demo to use GHCR images

- Change default KAFKA_VERSION from local to edge
- Update docker-compose to use ghcr.io/aiven/inkless
- Add image version options documentation
- Update Ctrl+C instructions (run make destroy to clean up)
- Add monitoring section to demo README
- Simplify Dockerfile COPY paths

- Add Quick Start decision tree to README.md
- Update QUICKSTART.md:
  - Add prerequisites section
  - Add demo backends and services table
  - Add binary usage guide with sample configs
  - Add monitoring instructions
  - Fix podman compose references
jeqo added a commit that referenced this pull request Feb 6, 2026
@jeqo
chore(inkless): Update demo and documentation for GHCR images (#497)
137bd7a 
refactor(docker): update demo to use GHCR images

- Change default KAFKA_VERSION from local to edge
- Update docker-compose to use ghcr.io/aiven/inkless
- Add image version options documentation
- Update Ctrl+C instructions (run make destroy to clean up)
- Add monitoring section to demo README
- Simplify Dockerfile COPY paths

- Add Quick Start decision tree to README.md
- Update QUICKSTART.md:
  - Add prerequisites section
  - Add demo backends and services table
  - Add binary usage guide with sample configs
  - Add monitoring instructions
  - Fix podman compose references
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@viktorsomogyi viktorsomogyi viktorsomogyi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jeqo @viktorsomogyi