From 2cc5e902ad5270665d5e32b1ed583da2b5d32caa Mon Sep 17 00:00:00 2001 From: Zack Brady Date: Fri, 20 Oct 2023 03:49:43 -0400 Subject: [PATCH] updated readme --- README.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5cba003..e474d8d 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,35 @@ -# Hauler: Airgap Swiss Army Knife +# Rancher Government Hauler -> ⚠️ This project is still in active development and _not_ GA. While a lot of the core features are ready, we're still adding a _ton_, and we may break API compatibility as we change features in newer versions. +## Airgap Swiss Army Knife -`hauler` simplifies the airgap experience without forcing you to adopt a specific workflow for your infrastructure or application. +> ⚠️ This project is still in active development and *not* Generally Available (GA). Most of the core functionality and features are ready, but may have breaking changes. Please review the [Release Notes](https://github.com/rancherfederal/hauler/releases) for more information! -To accomplish this, it focuses strictly on two of the biggest airgap pain points: +`Rancher Government Hauler` simplifies the airgap experience without requiring users to adopt a specific workflow. **Hauler** simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line. -* content collection -* content distribution +`Hauler` does this by storing contents and collections as OCI Objects and Specifications and allowing users to serve contents and collections via an embedded registry and fileserver. Additionally, `Hauler` has the ability to inspect and verify image attestations and warn when attestations are available for a specific image. For more information, please review the **[Hauler Documentation](https://rancherfederal.github.io/hauler-docs)!** -As OCI registries have become ubiquitous nowadays for storing and distributing containers. Their success and widespread adoption has led many projects to expand beyond containers. +## Latest Release +* [Hauler v0.3.0](https://github.com/rancherfederal/hauler/releases/tag/v0.3.0) + * [Download - Source](https://github.com/rancherfederal/hauler/archive/refs/tags/v0.3.0.zip) + * [Download - Linux AMD64](https://github.com/rancherfederal/hauler/releases/download/v0.3.0/hauler_0.3.0_linux_amd64.tar.gz) + * [Download - Linux ARM64](https://github.com/rancherfederal/hauler/releases/download/v0.3.0/hauler_0.3.0_linux_arm64.tar.gz) -`hauler` capitalizes on this, and leverages the [`oci`](https://github.com/opencontainers) spec to be a simple, zero dependency tool to collect, transport, and distribute your artifacts. +## Installation -## Getting started - -See the [quickstart](docs/walkthrough.md#Quickstart) for a quick way to get started with some of `haulers` capabilities. - -For a guided example of all of `haulers` capabilities, check out the [guided example](docs/walkthrough.md#guided-examples). +```bash +curl -#OL https://github.com/rancherfederal/hauler/releases/download/v0.3.0/hauler_0.3.0_linux_amd64.tar.gz +tar -xf hauler_0.3.0_linux_amd64.tar.gz +mv hauler /usr/bin/hauler +``` ## Acknowledgements -`hauler` wouldn't be possible without the open source community, but there are a few dependent projects that stand out: - +`Hauler` wouldn't be possible without the open-source community, but there are a few projects that stand out: * [go-containerregistry](https://github.com/google/go-containerregistry) -* [oras](https://github.com/oras-project/oras) +* [oras cli](https://github.com/oras-project/oras) * [cosign](https://github.com/sigstore/cosign) ## Notices +**WARNING: Upcoming Deprecated Command(s)** -*** WARNING: Deprecated Command *** - -The `hauler download (dl)` and `hauler serve (not the store version)` commands are deprecated and will be removed in a future release of Hauler. \ No newline at end of file +`hauler download (dl)` and `hauler serve (not the store version)` commands are deprecated and will be removed in a future release. \ No newline at end of file