-
Notifications
You must be signed in to change notification settings - Fork 9
chore(inkless): Update demo and documentation for GHCR images #497
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1b23524
refactor(docker): update demo to use GHCR images
jeqo 2f4b660
docs(inkless): add releases documentation and update quickstart
jeqo 9399e8d
chore(inkless:docker): add link to repository
jeqo dbb2c04
fixup! docs(inkless): add releases documentation and update quickstart
jeqo 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
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 |
|---|---|---|
| @@ -1,65 +1,27 @@ | ||
| # Inkless demo | ||
| # Inkless Docker Compose Demo | ||
|
|
||
| Contains examples of how to run Inkless with Postgres as batch coordinator and different object storage back-ends using Docker Compose. | ||
| Docker Compose examples for running Inkless with different storage backends. | ||
|
|
||
| Running the make task for a setup will start the necessary services and run the Inkless demo, including topic creation, producer/consumer perf clients, and monitoring with Prometheus and Grafana. | ||
| See the [Quickstart guide](../../../../docs/inkless/QUICKSTART.md#dockerized-demo) for complete setup instructions. | ||
|
|
||
| ## Run the demo | ||
| ## Quick reference | ||
|
|
||
| ### in-memory | ||
| | Command | Description | | ||
| |-----------------------|---------------------------------------------------| | ||
| | `make s3-local` | MinIO S3-compatible storage (default) | | ||
| | `make gcs-local` | Fake GCS server | | ||
| | `make azure-local` | Azurite Azure-compatible storage | | ||
| | `make s3-aws` | Real AWS S3 (requires AWS credentials) | | ||
| | `make destroy` | Manual cleanup (automatic on Ctrl+C) | | ||
|
|
||
| This setup uses an in-memory object storage and Postgres as a metadata store. | ||
| ## Image version | ||
|
|
||
| ``` | ||
| make in-memory | ||
| ``` | ||
|
|
||
| ### S3 local | ||
|
|
||
| This setup uses MinIO as a local S3-compatible object storage and Postgres as a metadata store. | ||
|
|
||
| ``` | ||
| make s3-local | ||
| ``` | ||
|
|
||
| ### GCS local | ||
|
|
||
| This setup uses `fake-gcs-server` as a local GCS-compatible object storage and Postgres as a metadata store. | ||
|
|
||
| ``` | ||
| make gcs-local | ||
| ``` | ||
|
|
||
| ### Azure local | ||
|
|
||
| This setup uses `azurite` as a local Azure-compatible object storage and Postgres as a metadata store. | ||
|
|
||
| ``` | ||
| make azure-local | ||
| ``` | ||
|
|
||
| ### AWS S3 | ||
|
|
||
| This example demonstrates how to use Inkless with remote data and metadata stores, | ||
| using a Remote Postgres instance for metadata and AWS S3 for data storage. | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| Set the environment variables: | ||
|
|
||
| For AWS S3: | ||
|
|
||
| ```properties | ||
| AWS_ACCESS_KEY_ID= | ||
| AWS_SECRET_ACCESS_KEY= | ||
| AWS_SESSION_TOKEN= | ||
| AWS_REGION= | ||
| AWS_S3_BUCKET_NAME= | ||
| ``` | ||
|
|
||
| Then run | ||
| By default, the demo pulls the `edge` image (latest development build). Override with `KAFKA_VERSION`: | ||
|
|
||
| ```bash | ||
| make s3-aws | ||
| make s3-local KAFKA_VERSION=latest # Latest stable release | ||
| make s3-local KAFKA_VERSION=4.1.0-0.33 # Specific Kafka+Inkless version | ||
| make s3-local KAFKA_VERSION=local # Locally built image (requires: make docker_build) | ||
| ``` | ||
|
|
||
| See [Releases](../../../../docs/inkless/RELEASES.md#docker-images) for all available tags. |
2 changes: 1 addition & 1 deletion
2
docker/examples/docker-compose-files/inkless/docker-compose.demo.yml
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
2 changes: 1 addition & 1 deletion
2
docker/examples/docker-compose-files/inkless/docker-compose.yml
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.