This is an automated email from the ASF dual-hosted git repository. piotr pushed a commit to branch update_readmes in repository https://gitbox.apache.org/repos/asf/iggy.git
commit fb0f18662bf7c592578ec9e50366626061e379ac Author: spetz <[email protected]> AuthorDate: Sun Aug 10 18:37:51 2025 +0200 chore(repo): update readme files --- .github/workflows/release_cli.yml | 25 +++++++++++++------------ .github/workflows/release_sdk.yml | 21 +++++++++++---------- .github/workflows/release_server.yml | 29 +++++++++++++++-------------- README.md | 32 ++++++++++++++++---------------- core/ai/mcp/README.md | 2 ++ core/bench/README.md | 7 +++++++ core/bench/dashboard/README.md | 2 ++ core/cli/README.md | 9 +++++++++ core/connectors/sinks/README.md | 2 +- core/connectors/sources/README.md | 2 +- core/server/README.md | 9 +++++++++ examples/README.md | 5 +++++ web/README.md | 18 +++++++----------- web/static/permissions.png | Bin 176393 -> 0 bytes web/static/signIn.png | Bin 75607 -> 0 bytes web/static/stats.png | Bin 117201 -> 0 bytes web/static/streams.png | Bin 107782 -> 0 bytes web/static/streamsLight.png | Bin 106050 -> 0 bytes 18 files changed, 98 insertions(+), 65 deletions(-) diff --git a/.github/workflows/release_cli.yml b/.github/workflows/release_cli.yml index afd9734f..4c1a7489 100644 --- a/.github/workflows/release_cli.yml +++ b/.github/workflows/release_cli.yml @@ -21,7 +21,7 @@ on: workflow_call: inputs: tag_name: - description: 'The name of the tag to be released' + description: "The name of the tag to be released" required: true type: string @@ -80,8 +80,8 @@ jobs: - name: Prepare ${{ matrix.platform.target }} toolchain run: | - rustup target add ${{ matrix.platform.target }} - echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" + rustup target add ${{ matrix.platform.target }} + echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" - name: Install cross uses: taiki-e/install-action@v2 @@ -135,15 +135,16 @@ jobs: - name: List files run: find - - name: Create Changelog - uses: orhun/git-cliff-action@v4 - id: changelog - with: - config: cliff.toml - args: -vv --latest - env: - OUTPUT: CHANGELOG.md - GITHUB_REPO: ${{ github.repository }} + # Action disallowed + # - name: Create Changelog + # uses: orhun/git-cliff-action@v4 + # id: changelog + # with: + # config: cliff.toml + # args: -vv --latest + # env: + # OUTPUT: CHANGELOG.md + # GITHUB_REPO: ${{ github.repository }} - name: Create GitHub Release uses: softprops/action-gh-release@v2 diff --git a/.github/workflows/release_sdk.yml b/.github/workflows/release_sdk.yml index 6c528f8a..cd2fed6a 100644 --- a/.github/workflows/release_sdk.yml +++ b/.github/workflows/release_sdk.yml @@ -21,7 +21,7 @@ on: workflow_call: inputs: tag_name: - description: 'The name of the tag to be released' + description: "The name of the tag to be released" required: true type: string @@ -38,15 +38,16 @@ jobs: with: fetch-depth: 0 - - name: Create Changelog - uses: orhun/git-cliff-action@v4 - id: changelog - with: - config: cliff.toml - args: -vv --latest - env: - OUTPUT: CHANGELOG.md - GITHUB_REPO: ${{ github.repository }} + # Action disallowed + # - name: Create Changelog + # uses: orhun/git-cliff-action@v4 + # id: changelog + # with: + # config: cliff.toml + # args: -vv --latest + # env: + # OUTPUT: CHANGELOG.md + # GITHUB_REPO: ${{ github.repository }} - name: Create GitHub Release uses: softprops/action-gh-release@v2 diff --git a/.github/workflows/release_server.yml b/.github/workflows/release_server.yml index a633277b..0b6aff29 100644 --- a/.github/workflows/release_server.yml +++ b/.github/workflows/release_server.yml @@ -21,7 +21,7 @@ on: workflow_call: inputs: tag_name: - description: 'The name of the tag to be released' + description: "The name of the tag to be released" required: true type: string @@ -46,8 +46,8 @@ jobs: - name: Prepare x86_64-unknown-linux-musl toolchain run: | - rustup target add x86_64-unknown-linux-musl - echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" + rustup target add x86_64-unknown-linux-musl + echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" - name: Install cross uses: taiki-e/install-action@v2 @@ -64,8 +64,8 @@ jobs: - name: Prepare aarch64-unknown-linux-musl toolchain run: | - rustup target add aarch64-unknown-linux-musl - echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" + rustup target add aarch64-unknown-linux-musl + echo "Using Rust toolchain from rust-toolchain.toml: $(rustup show)" - name: Build iggy-server release binary for aarch64-unknown-linux-musl run: cross +stable build --verbose --target aarch64-unknown-linux-musl --release --bin iggy-server --target-dir target_aarch64 @@ -84,15 +84,16 @@ jobs: fi done - - name: Create Changelog - uses: orhun/git-cliff-action@v4 - id: changelog - with: - config: cliff.toml - args: -vv --latest - env: - OUTPUT: CHANGELOG.md - GITHUB_REPO: ${{ github.repository }} + # Action disallowed + # - name: Create Changelog + # uses: orhun/git-cliff-action@v4 + # id: changelog + # with: + # config: cliff.toml + # args: -vv --latest + # env: + # OUTPUT: CHANGELOG.md + # GITHUB_REPO: ${{ github.repository }} - name: Create GitHub Release uses: softprops/action-gh-release@v2 diff --git a/README.md b/README.md index e1ac5dcb..e0f3a4f1 100644 --- a/README.md +++ b/README.md @@ -90,11 +90,9 @@ This is the high-level architecture of the Iggy message streaming server, where ## Version -The latest released version is `0.4.300` for Iggy server, which is compatible with `0.6` Rust client SDK and the others. +The official releases follow the regular semver (`0.5.0`) or have `latest` tag applied (`apache/iggy:latest`). -The recent improvements based on the zero-copy (de)serialization, along with updated SDKs etc. will be available in the upcoming release with Iggy server `0.5.0`, Rust SDK `0.7` and all the other SDKs. - -You can also find the `edge` versions of SDKs that are compatible with the `edge` version of Iggy Server Docker Image, but should be used with caution as these are not based on the official release. +We do also publish edge/dev/nightly releases (e.g. `0.5.0-edge.1` or `apache/iggy:edge`), for both, SDKs and the Docker images, which are typically compatible with the latest changes, but are not guaranteed to be stable, and as the name states, are not recommended for production use. --- @@ -105,22 +103,22 @@ You can also find the `edge` versions of SDKs that are compatible with the `edge --- -## Supported languages SDK (work in progress) +## Supported languages SDK + +- [Rust](https://crates.io/crates/iggy) +- [C#](https://www.nuget.org/packages/Apache.Iggy/) +- [Java](https://repository.apache.org/#nexus-search;quick~iggy) +- [Python](https://pypi.org/project/apache-iggy/) +- [Node.js (TypeScript)](https://www.npmjs.com/package/apache-iggy) +- [Go](https://pkg.go.dev/github.com/apache/iggy/foreign/go) -- Rust -- C# -- Java -- Go -- Python -- Node -- C++ -- Elixir +C++ and Elixir are work in progress. --- ## CLI -The brand new, rich, interactive CLI is implemented under the `cli` project, to provide the best developer experience. This is a great addition to the Web UI, especially for all the developers who prefer using the console tools. +The interactive CLI is implemented under the `cli` project, to provide the best developer experience. This is a great addition to the Web UI, especially for all the developers who prefer using the console tools. Iggy CLI can be installed with `cargo install iggy-cli` and then simply accessed by typing `iggy` in your terminal. @@ -175,7 +173,9 @@ The [Model Context Protocol](https://modelcontextprotocol.io) (MCP) is an open p ## Docker -The official images can be found in [Docker Hub](https://hub.docker.com/r/apache/iggy), simply type `docker pull apache/iggy` to pull the image. +The official Apache Iggy images can be found in [Docker Hub](https://hub.docker.com/r/apache/iggy), simply type `docker pull apache/iggy` to pull the image. + +You can also find the images for all the different tooling such as Connectors, MCP Server etc. [here](https://hub.docker.com/u/apache?page=1&search=iggy). Please note that the images tagged as `latest` are based on the official, stable releases, while the `edge` ones are updated directly from latest version of the `master` branch. @@ -313,7 +313,7 @@ let mut producer = client producer.init().await?; // Send some messages to the topic -let messages = vec![Message::from_str("Hello Apache Iggy")?]; +let messages = vec![IggyMessage::from_str("Hello Apache Iggy")?]; producer.send(messages).await?; // Create a consumer for the given stream and one of its topics diff --git a/core/ai/mcp/README.md b/core/ai/mcp/README.md index dcec8b03..a420b2ea 100644 --- a/core/ai/mcp/README.md +++ b/core/ai/mcp/README.md @@ -60,3 +60,5 @@ Here's the example configuration to be used with Claude Desktop: ``` **Remember to use the appropriate Iggy account credentials for your environment** (e.g. create the user with read-only permissions to avoid modifying the data). On top of this, you can also configure the `permissions` for the MCP server to control which operations are allowed (this will be checked first, before forwarding the actual request to the Iggy server). + + diff --git a/core/bench/README.md b/core/bench/README.md new file mode 100644 index 00000000..b3ae1ac4 --- /dev/null +++ b/core/bench/README.md @@ -0,0 +1,7 @@ +# Apache Iggy Bench CLI + +The interactive Bench CLI allows you to perform various benchmarking on the Apache Iggy server. + +Iggy Bench CLI can be installed with `cargo install iggy-bench` and then simply accessed by typing `iggy-bench` in your terminal. + + diff --git a/core/bench/dashboard/README.md b/core/bench/dashboard/README.md index 714ac098..452cf43c 100644 --- a/core/bench/dashboard/README.md +++ b/core/bench/dashboard/README.md @@ -18,6 +18,8 @@ A modern, high-performance benchmark results dashboard for Iggy, built with Rust - 🚀 High-performance Rust backend - ⚡ Fast, modern web frontend built with Yew + + ## Project Structure The project is organized as a Rust workspace with four main components: diff --git a/core/cli/README.md b/core/cli/README.md new file mode 100644 index 00000000..970051da --- /dev/null +++ b/core/cli/README.md @@ -0,0 +1,9 @@ +# Apache Iggy CLI + +The interactive CLI allows you to interact with the Apache Iggy server from the command line. + +This is a great addition to the Web UI, especially for all the developers who prefer using the console tools. + +Iggy CLI can be installed with `cargo install iggy-cli` and then simply accessed by typing `iggy` in your terminal. + + diff --git a/core/connectors/sinks/README.md b/core/connectors/sinks/README.md index 0ab9b6a5..737fd509 100644 --- a/core/connectors/sinks/README.md +++ b/core/connectors/sinks/README.md @@ -27,7 +27,7 @@ pub trait Sink: Send + Sync { ## Configuration -Sink is configured in the default `config` file used by runtime. Each sink configuration, is part of the map of <String, SinkConfig>, which can be represented using toml, json, or yaml. +Sink is configured in the default `config` file used by runtime. Each sink configuration, is part of the map of `<String, SinkConfig>`, which can be represented using toml, json, or yaml. ```rust pub struct SinkConfig { diff --git a/core/connectors/sources/README.md b/core/connectors/sources/README.md index aba6f9a8..8ce0d73c 100644 --- a/core/connectors/sources/README.md +++ b/core/connectors/sources/README.md @@ -22,7 +22,7 @@ pub trait Source: Send + Sync { ## Configuration -Source is configured in the default `config` file used by runtime. Each source configuration, is part of the map of <String, SourceConfig>, which can be represented using toml, json, or yaml. +Source is configured in the default `config` file used by runtime. Each source configuration, is part of the map of `<String, SourceConfig>`, which can be represented using toml, json, or yaml. ```rust pub struct SourceConfig { diff --git a/core/server/README.md b/core/server/README.md new file mode 100644 index 00000000..5608b4e0 --- /dev/null +++ b/core/server/README.md @@ -0,0 +1,9 @@ +# Apache Iggy Server + +This is the core server component of Apache Iggy. You can run it directly with `cargo run --bin iggy-server --release` or use the Docker image `apache/iggy:latest` (the `edge` tag is for the latest development version). + +The configuration file is located at [core/configs/server.toml](https://github.com/apache/iggy/blob/master/core/configs/server.toml). You can customize the server settings by modifying this file or by using environment variables e.g. `IGGY_TCP_ADDRESS=0.0.0.0:8090`. + + + + diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..c0ca17b0 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,5 @@ +# Apache Iggy Examples + +Here you can find the examples of how to use Apache Iggy with the different programming languages. Please note that the features available in each language may vary. + + diff --git a/web/README.md b/web/README.md index 9e2c6e0e..733a2c86 100644 --- a/web/README.md +++ b/web/README.md @@ -1,12 +1,8 @@ -# Apache Iggy (Incubating) Web UI +# Apache Iggy Web UI -This proejcts hosts the web user interface for Apache Iggy. The web UI is built using SvelteKit. +This project hosts the web user interface for Apache Iggy. The web UI is built using SvelteKit. - - - - - + ## Overview @@ -24,20 +20,20 @@ The Iggy Web UI provides a user-friendly panel for managing various aspects of t docker run -p 3000:3000 -p 8090:8090 apache/iggy:latest ``` -1. **Clone the repository:** +2. **Clone the repository:** ```sh git clone https://github.com/apache/iggy.git ``` -1. **Build the project:** +3. **Build the project:** ```sh - cd iggy-web-ui + cd web npm install ``` -1. **Run the project:** +4. **Run the project:** ```sh npm run dev diff --git a/web/static/permissions.png b/web/static/permissions.png deleted file mode 100644 index aa05f7f2..00000000 Binary files a/web/static/permissions.png and /dev/null differ diff --git a/web/static/signIn.png b/web/static/signIn.png deleted file mode 100644 index 55462103..00000000 Binary files a/web/static/signIn.png and /dev/null differ diff --git a/web/static/stats.png b/web/static/stats.png deleted file mode 100644 index 57bedd80..00000000 Binary files a/web/static/stats.png and /dev/null differ diff --git a/web/static/streams.png b/web/static/streams.png deleted file mode 100644 index fa670894..00000000 Binary files a/web/static/streams.png and /dev/null differ diff --git a/web/static/streamsLight.png b/web/static/streamsLight.png deleted file mode 100644 index 46d52070..00000000 Binary files a/web/static/streamsLight.png and /dev/null differ
