merge pull request #8 from zackbradys/main

updated docs for latest release and new features
hauler-dev · Dec 21, 2023 · 51ffd5a · 51ffd5a
2 parents 29d904c + 33f1b47
commit 51ffd5a
Show file tree

Hide file tree

Showing 35 changed files with 1,124 additions and 28 deletions.
diff --git a/docs/core-concepts.md b/docs/core-concepts.md
@@ -8,7 +8,7 @@ sidebar_label: Core Concepts
 
 ## Haul
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Hauls` are Compressed Archive (Tarball) of Hauler Collections and Content.
 
@@ -18,7 +18,7 @@ At the heart of Hauler lies the concept of a `Haul`. A `Haul` is a compressed ar
 
 ## Collections
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Collections` are Grouping of one or more Hauler Contents.
 
@@ -36,7 +36,7 @@ While `collections` (and `contents`) are built into Hauler, our goal is to empow
 
 ## Content
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Contents` are Artifacts such as Images, Charts, or Files.
 

diff --git a/docs/guides-references/carbide-customers.md b/docs/guides-references/carbide-customers.md
@@ -0,0 +1,83 @@
+---
+title: RGS Carbide Customers
+description: RGS Carbide Customers Documentation
+sidebar_label: RGS Carbide Customers
+---
+
+For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within `Hauler`.
+
+`Hauler` has the the ability to reference pre-defined `Hauler` manifests from the Carbide Secured Registry (CSR). `Hauler` is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available `product` flags.
+
+RGS Carbide Setup Documentation: https://rancherfederal.github.io/carbide-docs/docs/intro
+
+RGS Carbide Public Key: https://github.com/rancherfederal/carbide-releases/releases/download/0.1.1/carbide-key.pub
+
+### Example Workflow for Carbide
+
+```bash
+# with signature verification
+hauler store sync --products carbide=v0.1.1 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products carbie=v0.1.1
+```
+
+### Example Workflow for RKE2
+
+```bash
+# with signature verification
+hauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products rke2=v1.26.11+rke2r1
+```
+
+### Example Workflow for K3S
+
+```bash
+# with signature verification
+hauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products k3s=v1.26.11-k3s2
+```
+
+### Example Workflow for Rancher
+
+```bash
+# with signature verification
+hauler store sync --products rancher=v2.8.0 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products rancher=v2.8.0
+```
+
+### Example Workflow for Cert-Manager
+
+```bash
+# with signature verification
+hauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products cert-manager=v1.13.3
+```
+
+### Example Workflow for Longhorn
+
+```bash
+# with signature verification
+hauler store sync --products longhorn=v1.5.3 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products longhorn=v1.5.3
+```
+
+### Example Workflow for NeuVector
+
+```bash
+# with signature verification
+hauler store sync --products neuvector=v2.6.6 --key carbide-key.pub
+
+# without signature verification
+hauler store sync --products neuvector=v2.6.6
+```
diff --git a/docs/guides-references/command-line/hauler-completion.md b/docs/guides-references/command-line/hauler-completion.md
@@ -13,10 +13,10 @@ Usage:
   hauler completion [command]
 
 Available Commands:
-  bash        Generate the autocompletion script for bash
-  fish        Generate the autocompletion script for fish
-  powershell  Generate the autocompletion script for powershell
-  zsh         Generate the autocompletion script for zsh
+  bash        Generates bash completion scripts
+  fish        Generates fish completion scripts
+  powershell  Generates powershell completion scripts
+  zsh         Generates zsh completion scripts
 
 Flags:
   -h, --help   help for completion

diff --git a/docs/guides-references/command-line/hauler-store.md b/docs/guides-references/command-line/hauler-store.md
@@ -82,7 +82,7 @@ Flags:
 Global Flags:
       --cache string       Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)
   -l, --log-level string    (default "info")
-  -s, --store string       Location to create store at (default "store")
+  -s, --store string       Location to create store at (default "store")h
 ```
 
 #### `hauler store extract`:
@@ -120,6 +120,7 @@ Aliases:
 Flags:
   -h, --help            help for info
   -o, --output string   Output format (table, json) (default "table")
+  -t, --type string     Filter on type (image, chart, file) (default "all")
 
 Global Flags:
       --cache string       Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)
@@ -200,5 +201,5 @@ Flags:
 Global Flags:
       --cache string       Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)
   -l, --log-level string    (default "info")
-  -s, --store string       Location to create store at (default "store")
+  -s, --store string       Location to create store at (default "store")h
 ```
diff --git a/docs/guides-references/command-line/hauler.md b/docs/guides-references/command-line/hauler.md
@@ -14,7 +14,7 @@ Usage:
   hauler [command]
 
 Available Commands:
-  completion  Generate the autocompletion script for the specified shell
+  completion  Generates completion scripts for various shells
   download    Download OCI content from a registry and populate it on disk
   help        Help about any command
   serve       Run one or more of hauler's embedded servers types

diff --git a/docs/guides-references/hauler-content/images.md b/docs/guides-references/hauler-content/images.md
@@ -8,7 +8,7 @@ Any OCI compatible image can be fetched remotely:
 
 ```yaml
 # "shorthand"  image references
-hauler store add image rancher/rancher:v2.7.9
+hauler store add image rancher/rancher:v2.8.0
 
 # fully qualified image references
 hauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd

diff --git a/docs/introduction/install.md b/docs/introduction/install.md
@@ -25,16 +25,18 @@ Hauler is a purpose built to be a single binary with no specific prerequistes or
 curl -sfL https://get.hauler.dev | bash
 
 # install specific release
-curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.1 bash
+curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.2 bash
 ```
 
-### Windows
+### Homebrew
 
 ```bash
-# coming soon
+# installs latest release
+brew tap rancherfederal/homebrew-tap
+brew install hauler
 ```
 
-### Homebrew
+### Windows
 
 ```bash
 # coming soon
@@ -43,7 +45,7 @@ curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.1 bash
 ## Manual Installation Steps
 
 ```bash
-# set the hauler version (i.e. "0.4.1")
+# set the hauler version (i.e. "0.4.2")
 export vHauler=HAULER_VERSION
 
 # set the specific platform (i.e. "linux")

diff --git a/docs/introduction/quickstart.md b/docs/introduction/quickstart.md
@@ -26,8 +26,8 @@ hauler store add image neuvector/scanner:latest
 # add a image with supply chain artifacts
 hauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub
 
-# add a chart: rancher-stable/rancher (v2.7.9)
-hauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9
+# add a chart: rancher-stable/rancher (v2.8.0)
+hauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.0
 
 # add a file: rke2-install.sh
 hauler store add file https://get.rke2.io --name install.sh
@@ -58,7 +58,7 @@ spec:
   charts:
     - name: rancher
       repoURL: https://releases.rancher.com/server-charts/stable
-      version: 2.7.9
+      version: 2.8.0
 ---
 apiVersion: content.hauler.cattle.io/v1alpha1
 kind: Files

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "hauler",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/sidebars.js b/sidebars.js
@@ -26,6 +26,7 @@ const sidebars = {
         'guides-references/overview',
         'guides-references/validation',
         'guides-references/cluster-images',
+        'guides-references/carbide-customers',
         {
           type: 'category',
           label: 'Hauler Collections',

diff --git a/versioned_docs/version-0.4.0/core-concepts.md b/versioned_docs/version-0.4.0/core-concepts.md
@@ -8,7 +8,7 @@ sidebar_label: Core Concepts
 
 ## Haul
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Hauls` are Compressed Archive (Tarball) of Hauler Collections and Content.
 
@@ -18,7 +18,7 @@ At the heart of Hauler lies the concept of a `Haul`. A `Haul` is a compressed ar
 
 ## Collections
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Collections` are Grouping of one or more Hauler Contents.
 
@@ -36,7 +36,7 @@ While `collections` (and `contents`) are built into Hauler, our goal is to empow
 
 ## Content
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Contents` are Artifacts such as Images, Charts, or Files.
 

diff --git a/versioned_docs/version-0.4.1/core-concepts.md b/versioned_docs/version-0.4.1/core-concepts.md
@@ -8,7 +8,7 @@ sidebar_label: Core Concepts
 
 ## Haul
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Hauls` are Compressed Archive (Tarball) of Hauler Collections and Content.
 
@@ -18,7 +18,7 @@ At the heart of Hauler lies the concept of a `Haul`. A `Haul` is a compressed ar
 
 ## Collections
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Collections` are Grouping of one or more Hauler Contents.
 
@@ -36,7 +36,7 @@ While `collections` (and `contents`) are built into Hauler, our goal is to empow
 
 ## Content
 
-:::tip TLDR:
+:::tip SUMMARY:
 
 `Contents` are Artifacts such as Images, Charts, or Files.
 

diff --git a/versioned_docs/version-0.4.2/airgap-workflow.md b/versioned_docs/version-0.4.2/airgap-workflow.md
@@ -0,0 +1,10 @@
+---
+title: Airgap Workflow
+description: Airgap Workflow Documentation for Hauler
+sidebar_label: Airgap Workflow
+---
+
+## Workflow Diagram
+![hauler-workflow-diagram](/img/hauler-workflow-diagram.png)
+
+Airgap Workflow Documentation pending a future release!
diff --git a/versioned_docs/version-0.4.2/core-concepts.md b/versioned_docs/version-0.4.2/core-concepts.md
@@ -0,0 +1,53 @@
+---
+title: Core Concepts
+description: Core Concepts Documentation for Hauler
+sidebar_label: Core Concepts
+---
+
+![hauler-diagram](/img/hauler-diagram.png)
+
+## Haul
+
+:::tip SUMMARY:
+
+`Hauls` are Compressed Archive (Tarball) of Hauler Collections and Content.
+
+:::
+
+At the heart of Hauler lies the concept of a `Haul`. A `Haul` is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem.
+
+## Collections
+
+:::tip SUMMARY:
+
+`Collections` are Grouping of one or more Hauler Contents.
+
+:::
+
+`Collections` are the building blocks of Hauler. These are groupings of one or more Hauler `contents`. Think of `collections` as organized sets of data that collectively represent something desirable.
+
+### Community Collections
+
+While `collections` (and `contents`) are built into Hauler, our goal is to empower users to define their own `collections`. This way, you can tailor Hauler to your unique requirements and take full control of your artifacts.
+
+### RGS Carbide Collections
+
+`Hauler` provides the ability to import `collections` for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out [here](https://ranchergovernment.com/carbide)!
+
+## Content
+
+:::tip SUMMARY:
+
+`Contents` are Artifacts such as Images, Charts, or Files.
+
+:::
+
+In Hauler's terminology, `content` refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:
+
+* `Content`: The fundamental type of artifacts that Hauler recognizes (images, charts, and files).
+* `Artifact`: Anything that can be represented as an OCI (Open Container Initiative) artifact.
+  * OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently.
+
+### Declaritive Content
+
+While manually adding content to `Hauler` is a straightforward way to get started, we recommend a much more sustainable approach. `Hauler` provides a declaritive approach for each `content` type, allowing you to define all the `content` within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your `hauls`.