Skip to content

Commit

Permalink
prepare 0.9.0 release (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmc-msft authored Oct 3, 2022
1 parent 627c802 commit 02d55f8
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 31 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "avml"
version = "0.8.0"
version = "0.9.0"
license = "MIT"
description = "A portable volatile memory acquisition tool"
authors = ["[email protected]"]
Expand All @@ -21,7 +21,7 @@ status = ["atty", "indicatif"]
bytes = "1.2"
elf = "0.0.11"
byteorder = "1.3"
clap = { version = "4.0.8", default-features = false, features=["derive", "std", "usage", "error-context", "help"]}
clap = { version = "4.0", default-features = false, features=["derive", "std", "usage", "error-context", "help"]}
http = "0.2"
snap = "1.0"
futures = "0.3"
Expand Down
64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ If the memory source is not specified on the commandline, AVML will iterate over
## Tested Distributions
* Ubuntu: 12.04, 14.04, 16.04, 18.04, 18.10, 19.04, 19.10, 20.04, 21.04, 22.04
* Centos: 6.5, 6.6, 6.7, 6.8, 6.9, 6.10, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.9
* RHEL: 6.7, 6.8, 6.9, 7.0, 7.2, 7.3, 7.4, 7.5, 7.7, 8.5
* Debian: 8, 9, 10, 11
* Oracle Linux: 6.8, 6.9, 6.10, 7.3, 7.4, 7.5, 7.6, 7.9, 8.5
* [CBL-Mariner](https://github.com/microsoft/CBL-Mariner): 1.0
* RHEL: 6.7, 6.8, 6.9, 7.0, 7.2, 7.3, 7.4, 7.5, 7.7, 8.5, 9.0
* Debian: 8, 9, 10, 11, 12
* Oracle Linux: 6.8, 6.9, 6.10, 7.3, 7.4, 7.5, 7.6, 7.9, 8.5, 9.0
* [CBL-Mariner](https://github.com/microsoft/CBL-Mariner): 1.0, 2.0

# Getting Started

Expand Down Expand Up @@ -101,39 +101,49 @@ avml-convert --source-format lime --format lime_compressed ./uncompressed.lime .
# Usage

```
USAGE:
avml [OPTIONS] <FILENAME>
A portable volatile memory acquisition tool
ARGS:
<FILENAME> name of the file to write to on local system
Usage: avml [OPTIONS] <FILENAME>
OPTIONS:
--compress
compress via snappy
Arguments:
<FILENAME>
name of the file to write to on local system
--delete
delete upon successful upload
Options:
--compress
compress via snappy
-h, --help
Print help information
--source <SOURCE>
specify input source
--sas-block-concurrency <SAS_BLOCK_CONCURRENCY>
specify blob upload concurrency
Possible values:
- /dev/crash:
Provides a read-only view of physical memory. Access to memory using this device must be paged aligned and read one page at a time
- /dev/mem:
Provides a read-write view of physical memory, though AVML opens it in a read-only fashion. Access to to memory using this device can be disabled using the kernel configuration options `CONFIG_STRICT_DEVMEM` or `CONFIG_IO_STRICT_DEVMEM`
- /proc/kcore:
Provides a virtual ELF coredump of kernel memory. This can be used to access physical memory
--sas-block-size <SAS_BLOCK_SIZE>
specify maximum block size in MiB
--url <URL>
upload via HTTP PUT upon acquisition
--sas-url <SAS_URL>
upload via Azure Blob Store upon acquisition
--delete
delete upon successful upload
--source <SOURCE>
specify input source [possible values: /dev/crash, /dev/mem, /proc/kcore]
--sas-url <SAS_URL>
upload via Azure Blob Store upon acquisition
--url <URL>
upload via HTTP PUT upon acquisition
--sas-block-size <SAS_BLOCK_SIZE>
specify maximum block size in MiB
-V, --version
Print version information
--sas-block-concurrency <SAS_BLOCK_CONCURRENCY>
specify blob upload concurrency
-h, --help
Print help information (use `-h` for a summary)
-V, --version
Print version information
```

# Building on Ubuntu
Expand Down
6 changes: 5 additions & 1 deletion eng/images.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ Canonical:0001-com-ubuntu-server-hirsute:21_04:latest
Canonical:0001-com-ubuntu-server-jammy-daily:22_04-daily-lts:latest
OpenLogic:CentOS:6.10:latest
OpenLogic:CentOS:7_9:latest
OpenLogic:CentOS:8_4:latest
OpenLogic:CentOS:8_5:latest
Oracle:Oracle-Linux:6.9:latest
Oracle:Oracle-Linux:ol79:latest
Oracle:Oracle-Linux:ol85-lvm:latest
Oracle:Oracle-Linux:ol9-lvm:9.0.1
RedHat:RHEL:6.10:latest
RedHat:RHEL:7.7:latest
RedHat:RHEL:8_5:latest
RedHat:RHEL:9_0:latest
credativ:Debian:8:latest
credativ:Debian:9:latest
Debian:debian-10:10:latest
Debian:debian-11:11:latest
Debian:debian-12-daily:12:latest
MicrosoftCBLMariner:cbl-mariner:cbl-mariner-1:latest
MicrosoftCBLMariner:cbl-mariner:cbl-mariner-2:latest

0 comments on commit 02d55f8

Please sign in to comment.