Skip to content

Commit

Permalink
Merge branch 'main' of github.com:rancherfederal/hauler into oci-haul…
Browse files Browse the repository at this point in the history
…er-manifests
  • Loading branch information
amartin120 committed Nov 3, 2023
2 parents 65426ff + 4772657 commit 5b8caac
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 284 deletions.
26 changes: 14 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
name: Bug Report
about: Create a report to help us improve!
title: '[BUG]'
labels: 'kind/bug'
assignees: ''

---

<!-- Thanks for helping us to improve Hauler! We welcome all bug reports. Please fill out each area of the template so we can better help you. Comments like this will be hidden when you post but you can delete them if you wish. -->
<!-- Thank you for helping us to improve Hauler! We welcome all bug reports. Please fill out each area of the template so we can better help you. Comments like this will be hidden when you post but you can delete them if you wish. -->

**Environmental Info:**
**Environmental Info:**
*

**Hauler Version:**
*

**System CPU architecture, OS, and Version:**
<!-- Provide the output from "uname -a" on the system where Hauler is installed -->
* <!-- Provide the output from "uname -a" on the system where Hauler is installed -->

**Describe the bug:**
<!-- A clear and concise description of what the bug is. -->
* <!-- A clear and concise description of the bug. -->

**Steps To Reproduce:**
* <!-- A clear and concise way to reproduce the bug. -->

**Expected behavior:**
<!-- A clear and concise description of what you expected to happen. -->
* <!-- A clear and concise description of what you expected to happen, without the bug. -->

**Actual behavior:**
<!-- A clear and concise description of what actually happened. -->
* <!-- A clear and concise description of what actually happened. -->

**Additional context / logs:**
<!-- Add any other context and/or logs about the problem here. -->
* <!-- Add any other context and/or logs about the problem here. -->
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature Request
about: Create a report to help us improve!
title: '[RFE]'
labels: 'kind/rfe'
assignees: ''
---

<!-- Thanks for helping us to improve Hauler! We welcome all requests for enhancements (RFEs). Please fill out each area of the template so we can better help you. Comments like this will be hidden when you post but you can delete them if you wish. -->

**Is your feature request related to a problem? Please describe.**
* <!-- A clear and concise description of the problem. -->

**Describe the solution you'd like**
* <!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
* <!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
* <!-- Add any other context or screenshots about the feature request here. -->
31 changes: 14 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
* **Please check if the PR fulfills these requirements**
- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
**Please check below, if the PR fulfills these requirements:**
- [ ] The commit message follows the guidelines.
- [ ] Tests for the changes have been added (for bug fixes / features).
- [ ] Docs have been added / updated (for bug fixes / features).


* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
**What kind of change does this PR introduce?**
* <!-- Bug fix, feature, docs update, ... -->

**What is the current behavior?**
* <!-- You can also link to an open issue here -->

**What is the new behavior (if this is a feature change)?**
* <!-- What changes did this PR introduce? -->

* **What is the current behavior?** (You can also link to an open issue here)
**Does this PR introduce a breaking change?**
* <!-- What changes might users need to make in their application due to this PR? -->



* **What is the new behavior (if this is a feature change)?**



* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)



* **Other information**:
**Other information**:
* <!-- Any additional information -->
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,31 @@
# 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 Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, `Hauler` has the ability to store and inspect various non-image OCI Artifacts.

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.
For more information, please review the **[Hauler Documentation](https://rancherfederal.github.io/hauler-docs)!**

`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
sudo 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.
`hauler download` (alternatively, `dl`) and `hauler serve` (_not_ `hauler store serve`) commands are deprecated and will be removed in a future release.
236 changes: 0 additions & 236 deletions docs/walkthrough.md

This file was deleted.

0 comments on commit 5b8caac

Please sign in to comment.