Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/clickhouse/clickhouse-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ The coercions a source value gets on the way: a zoned timestamp lands at the ins
- An encoder refusal (`EncodingError` naming its column) is the payload's, and goes to salvage.
- A column type the crate cannot encode is a loader gap, so the rows are held.

Both client crates come from crates.io, with no `[patch]` and no git source:
Both client crates come from crates.io, with no `[patch]` and no git source. `Cargo.toml` carries the version ranges:

```toml
clickhouse = { version = ">=0.15.3, <0.16", features = ["lz4", "time", "rustls-tls", "rustls-tls-native-roots", "inserter"] }
dfe-clickhouse = { version = ">=0.1.9, <0.2", default-features = false, features = ["ext", "tls", "dynamic"] }
clickhouse = { version = "...", features = ["lz4", "time", "rustls-tls", "rustls-tls-native-roots", "inserter"] }
dfe-clickhouse = { version = "...", default-features = false, features = ["ext", "tls", "dynamic"] }
```

From `dfe-clickhouse` the loader also takes `ServerException::parse` (`ext`), which reads the code and message out of the `Code: N. DB::Exception: ...` text the HTTP client returns as `Error::BadResponse`, and `TcpClient` with its rustls trust (`tls`, which implies `tcp`) for `clickhouse.protocol: native`. `src/clickhouse/error.rs` classifies every insert rejection by the server's code and keeps at most 1 MiB of any error text.
Expand Down
16 changes: 8 additions & 8 deletions docs/deployment/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ release:
helm:
enabled: true
contract: emit
library: "2.14.3"
library: "<contract version>"
container:
enabled: true
dockerfile: Dockerfile
Expand All @@ -56,23 +56,23 @@ The `Dockerfile` is generated from the app's deployment contract by scalo and co

## Tags generated

For a stable release `v1.6.13`:
For a stable release `v<version>`:

- `ghcr.io/hyperi-io/dfe-loader:v1.6.13`
- `ghcr.io/hyperi-io/dfe-loader:v<version>`
- `ghcr.io/hyperi-io/dfe-loader:latest`
- `ghcr.io/hyperi-io/dfe-loader:sha-<commit>`

A prerelease (e.g. `v1.6.13-rc.1`) gets its version tag and `sha-<commit>`
A prerelease (e.g. `v<version>-rc.1`) gets its version tag and `sha-<commit>`
only. It never moves `latest`.

## Verification

After a release:

```bash
docker pull ghcr.io/hyperi-io/dfe-loader:v1.6.13
docker run --rm ghcr.io/hyperi-io/dfe-loader:v1.6.13 --help
docker manifest inspect ghcr.io/hyperi-io/dfe-loader:v1.6.13
docker pull ghcr.io/hyperi-io/dfe-loader:v<version>
docker run --rm ghcr.io/hyperi-io/dfe-loader:v<version> --help
docker manifest inspect ghcr.io/hyperi-io/dfe-loader:v<version>
```

## Consumer usage
Expand All @@ -94,7 +94,7 @@ services:
```yaml
containers:
- name: dfe-loader
image: ghcr.io/hyperi-io/dfe-loader:v1.6.13
image: ghcr.io/hyperi-io/dfe-loader:v<version>
ports:
- containerPort: 9090
```
2 changes: 1 addition & 1 deletion docs/transport/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ dfe-archiver) a server that receives event batches, and gives dfe-receiver (and
transformers) a client that pushes batches directly -- a Kafka-less path when you
want one.

- **Wire protocol:** gRPC (Protobuf over HTTP/2) via `tonic` 0.14.x.
- **Wire protocol:** gRPC (Protobuf over HTTP/2) via `tonic`, at the version scalo-rs's `Cargo.toml` pins.
- **Scope:** scalo transport module + dfe-loader, dfe-archiver, dfe-receiver.
- **Feature flag:** `transport-grpc` (optional `tonic` + `prost` deps).

Expand Down
Loading