mirror of
https://github.com/imjasonh/krust
synced 2026-07-06 22:12:32 +00:00
Fix documentation inaccuracies in README and CLAUDE.md
- Remove phantom `-i, --image` CLI flag that doesn't exist in code - Fix default base image from gcr.io/distroless/static:nonroot to cgr.dev/chainguard/static:latest - Update --platform description to reflect auto-detection from base image - Move -v/--verbose to Global Options (it's a global flag, not per-command) - Add missing `version` command to CLI reference - Fix non-existent `make test-verbose` reference - Mark multi-platform image manifests as implemented in CLAUDE.md https://claude.ai/code/session_019QkKmgPcFYaLwKe34EMFJy
This commit is contained in:
parent
e9db7bfe11
commit
b531cfebd6
2 changed files with 24 additions and 11 deletions
|
|
@ -204,7 +204,7 @@ Convenience wrapper that combines `resolve` with `kubectl apply`:
|
|||
Potential enhancements identified:
|
||||
1. ~~Registry authentication support~~ ✓ Implemented (supports Docker credential helpers)
|
||||
2. ~~YAML resolution for Kubernetes deployments~~ ✓ Implemented (`krust resolve`)
|
||||
3. Multi-platform image manifests
|
||||
3. ~~Multi-platform image manifests~~ ✓ Implemented (OCI image index with concurrent builds)
|
||||
4. ~~Build caching~~ ✓ Implemented (persistent `target/krust/` directory)
|
||||
5. Image layer optimization
|
||||
6. Support for custom Dockerfile-like configs
|
||||
|
|
|
|||
33
README.md
33
README.md
|
|
@ -147,7 +147,7 @@ krust builds your Rust application and packages it into a container image:
|
|||
krust builds fully static binaries by default using:
|
||||
- musl libc for Linux targets
|
||||
- `RUSTFLAGS="-C target-feature=+crt-static"` for static linking
|
||||
- Distroless static base image (`gcr.io/distroless/static:nonroot`)
|
||||
- Distroless static base image (`cgr.dev/chainguard/static:latest`)
|
||||
|
||||
This ensures your applications work across all Linux distributions without dependency issues.
|
||||
|
||||
|
|
@ -289,13 +289,14 @@ Arguments:
|
|||
[CARGO_ARGS]... Additional cargo build arguments
|
||||
|
||||
Options:
|
||||
-i, --image <IMAGE> Target image reference (overrides KRUST_REPO)
|
||||
--platform <PLATFORM> Target platform [default: linux/amd64]
|
||||
--platform <PLATFORM> Target platforms (comma-separated, auto-detected from base image if not specified)
|
||||
--no-push Skip pushing the image to registry
|
||||
--tag <TAG> Tag to apply to the image (e.g., latest, v1.0.0)
|
||||
--repo <REPO> Repository prefix (uses KRUST_REPO env var)
|
||||
-v, --verbose Enable verbose logging
|
||||
--repo <REPO> Repository prefix (defaults to KRUST_REPO env var)
|
||||
-h, --help Print help
|
||||
|
||||
Global Options:
|
||||
-v, --verbose Enable verbose logging
|
||||
```
|
||||
|
||||
### Resolve Command
|
||||
|
|
@ -310,10 +311,12 @@ Arguments:
|
|||
|
||||
Options:
|
||||
--platform <PLATFORM> Target platforms (comma-separated)
|
||||
--repo <REPO> Repository prefix (uses KRUST_REPO env var)
|
||||
--repo <REPO> Repository prefix (defaults to KRUST_REPO env var)
|
||||
--tag <TAG> Tag to apply to built images
|
||||
-v, --verbose Enable verbose logging
|
||||
-h, --help Print help
|
||||
|
||||
Global Options:
|
||||
-v, --verbose Enable verbose logging
|
||||
```
|
||||
|
||||
#### Usage Examples
|
||||
|
|
@ -374,10 +377,12 @@ Arguments:
|
|||
|
||||
Options:
|
||||
--platform <PLATFORM> Target platforms (comma-separated)
|
||||
--repo <REPO> Repository prefix (uses KRUST_REPO env var)
|
||||
--repo <REPO> Repository prefix (defaults to KRUST_REPO env var)
|
||||
--tag <TAG> Tag to apply to built images
|
||||
-v, --verbose Enable verbose logging
|
||||
-h, --help Print help
|
||||
|
||||
Global Options:
|
||||
-v, --verbose Enable verbose logging
|
||||
```
|
||||
|
||||
#### Usage Examples
|
||||
|
|
@ -399,6 +404,14 @@ The `apply` command is equivalent to:
|
|||
krust resolve -f deployment.yaml | kubectl apply -f -
|
||||
```
|
||||
|
||||
### Version Command
|
||||
|
||||
```
|
||||
krust version
|
||||
```
|
||||
|
||||
Prints the current krust version.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "linking with `cc` failed" or linker errors
|
||||
|
|
@ -488,7 +501,7 @@ make test-e2e # End-to-end tests only
|
|||
cargo test -- --test-threads=1
|
||||
|
||||
# Run with verbose output
|
||||
make test-verbose
|
||||
cargo test --verbose -- --test-threads=1
|
||||
```
|
||||
|
||||
## License
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue