Skip to content

Commit

Permalink
Merge pull request #9 from rancherfederal/updates-0.4.3
Browse files Browse the repository at this point in the history
updates for v0.4.3
  • Loading branch information
amartin120 authored Feb 1, 2024
2 parents 51ffd5a + 63a9dfe commit ab9523e
Show file tree
Hide file tree
Showing 33 changed files with 1,294 additions and 39 deletions.
28 changes: 14 additions & 14 deletions docs/guides-references/carbide-customers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,68 +16,68 @@ RGS Carbide Public Key: https://github.com/rancherfederal/carbide-releases/relea

```bash
# with signature verification
hauler store sync --products carbide=v0.1.1 --key carbide-key.pub
hauler store sync --products carbide=v0.1.1 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products carbie=v0.1.1
hauler store sync --products carbide=v0.1.1 --platform linux/amd64
```

### Example Workflow for RKE2

```bash
# with signature verification
hauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub
hauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products rke2=v1.26.11+rke2r1
hauler store sync --products rke2=v1.26.11+rke2r1 --platform linux/amd64
```

### Example Workflow for K3S

```bash
# with signature verification
hauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub
hauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products k3s=v1.26.11-k3s2
hauler store sync --products k3s=v1.26.11-k3s2 --platform linux/amd64
```

### Example Workflow for Rancher

```bash
# with signature verification
hauler store sync --products rancher=v2.8.0 --key carbide-key.pub
hauler store sync --products rancher=v2.8.1 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products rancher=v2.8.0
hauler store sync --products rancher=v2.8.1 --platform linux/amd64
```

### Example Workflow for Cert-Manager

```bash
# with signature verification
hauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub
hauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products cert-manager=v1.13.3
hauler store sync --products cert-manager=v1.13.3 --platform linux/amd64
```

### Example Workflow for Longhorn

```bash
# with signature verification
hauler store sync --products longhorn=v1.5.3 --key carbide-key.pub
hauler store sync --products longhorn=v1.5.3 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products longhorn=v1.5.3
hauler store sync --products longhorn=v1.5.3 --platform linux/amd64
```

### Example Workflow for NeuVector

```bash
# with signature verification
hauler store sync --products neuvector=v2.6.6 --key carbide-key.pub
hauler store sync --products neuvector=v2.6.6 --key carbide-key.pub --platform linux/amd64

# without signature verification
hauler store sync --products neuvector=v2.6.6
hauler store sync --products neuvector=v2.6.6 --platform linux/amd64
```
125 changes: 121 additions & 4 deletions docs/guides-references/command-line/hauler-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,83 @@ Global Flags:
Use "hauler store add [command] --help" for more information about a command.
```

#### `hauler store add chart`:

* Add a local or remote chart to the content store.

```yaml
Usage:
hauler store add chart [flags]

Examples:

# add a local chart
hauler store add chart path/to/chart/directory

# add a local compressed chart
hauler store add chart path/to/chart.tar.gz

# add a remote chart
hauler store add chart longhorn --repo "https://charts.longhorn.io"

# add a specific version of a chart
hauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"


Flags:
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
-h, --help help for chart
--insecure-skip-tls-verify skip tls certificate checks for the chart download
--key-file string identify HTTPS client using this SSL key file
--password string chart repository password where to locate the requested chart
--repo string chart repository url where to locate the requested chart
--username string chart repository username where to locate the requested chart
--verify verify the package before using it
--version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used

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")
```

#### `hauler store add file`:

* Add a file to the content store.

```yaml
Usage:
hauler store add file [flags]

Flags:
-h, --help help for file
-n, --name string (Optional) Name to assign to file in store

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")
```

#### `hauler store add image`:

* Add an image to the content store.

```yaml
Usage:
hauler store add image [flags]

Flags:
-h, --help help for image
-k, --key string (Optional) Path to the key for digital signature verification
-p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.

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")
```

#### `hauler store copy`:

Expand Down Expand Up @@ -171,12 +248,51 @@ Global Flags:
Usage:
hauler store serve [flags]

Available Commands:
fileserver Serve the file server
registry Serve the embedded registry

Flags:
-c, --config string Path to a config file, will override all other configs
-d, --daemon Toggle serving as a daemon
--directory string Directory to use for registry backend (defaults to '$PWD/registry') (default "registry")
-h, --help help for serve
-p, --port int Port to listen on (default 5000)

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")
```

#### `hauler store serve registry`:

* Serve the embedded registry

```yaml
Usage:
hauler store serve registry [flags]

Flags:
-c, --config string Path to a config file, will override all other configs
--directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")
-h, --help help for registry
-p, --port int Port to listen on. (default 5000)

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")
```

#### `hauler store serve fileserver`:

* Serve the fileserver

```yaml
Usage:
hauler store serve fileserver [flags]

Flags:
--directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")
-h, --help help for fileserver
-p, --port int Port to listen on. (default 8080)

Global Flags:
--cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)
Expand All @@ -196,6 +312,7 @@ Flags:
-f, --files strings Path to content files
-h, --help help for sync
-k, --key string (Optional) Path to the key for signature verification
-p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.
--products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. '--product rancher=v2.7.6'

Global Flags:
Expand Down
5 changes: 4 additions & 1 deletion docs/guides-references/hauler-content/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ Any OCI compatible image can be fetched remotely:

```yaml
# "shorthand" image references
hauler store add image rancher/rancher:v2.8.0
hauler store add image rancher/rancher:v2.8.1

# fully qualified image references
hauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd

# adds an arch/platform specific version of a multi-arch image to the haul/store. by default, hauler will pull and save all archs/platforms contained in the image manifest.
hauler store add image rancher/rancher:v2.8.1 --platform linux/amd64
```
4 changes: 2 additions & 2 deletions docs/introduction/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ 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.2 bash
curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.3 bash
```

### Homebrew
Expand All @@ -45,7 +45,7 @@ brew install hauler
## Manual Installation Steps

```bash
# set the hauler version (i.e. "0.4.2")
# set the hauler version (i.e. "0.4.3")
export vHauler=HAULER_VERSION

# set the specific platform (i.e. "linux")
Expand Down
18 changes: 11 additions & 7 deletions docs/introduction/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ curl -sfL https://get.hauler.dev | bash

```bash
# add a image: neuvector/scanner:latest
hauler store add image neuvector/scanner:latest
hauler store add image neuvector/scanner:latest --platform linux/amd64

# add a image with supply chain artifacts
hauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub
hauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub --platform linux/amd64

# 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 chart: rancher-stable/rancher (v2.8.1)
hauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.1

# add a file: rke2-install.sh
hauler store add file https://get.rke2.io --name install.sh
Expand All @@ -36,7 +36,7 @@ hauler store add file https://get.rke2.io --name install.sh
#### Using a Hauler Manifest:

```bash
hauler store sync --files hauler-manfiest.yaml
hauler store sync --files hauler-manfiest.yaml
```

```yaml title="hauler-manfiest.yaml"
Expand All @@ -49,6 +49,7 @@ spec:
- name: neuvector/scanner:latest
- name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1
key: carbide-key.pub
platform: linux/amd64
---
apiVersion: content.hauler.cattle.io/v1alpha1
kind: Charts
Expand All @@ -58,7 +59,7 @@ spec:
charts:
- name: rancher
repoURL: https://releases.rancher.com/server-charts/stable
version: 2.8.0
version: 2.8.1
---
apiVersion: content.hauler.cattle.io/v1alpha1
kind: Files
Expand Down Expand Up @@ -101,7 +102,10 @@ hauler store load haul.tar.zst

```bash
# serve the content as a registry from the hauler store
hauler store serve
hauler store serve registry

# serve the file content as a fileserver from the hauler store
hauler store serve fileserver
```

### Copy the Hauler Store to a Registry
Expand Down
3 changes: 1 addition & 2 deletions docs/known-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ sidebar_label: Known Issues/Limits

## Limitations

- Display of Information in the Hauler Store:
- When using `hauler store info` with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. **We are actively working to address and fix this issue.**
- No "known" limitations at this time but as a reminder, Hauler and it's documentation are in active development and not Generally Available (GA).

## Notices

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hauler",
"version": "0.4.2",
"version": "0.4.3",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ hauler store sync --products k3s=v1.26.11-k3s2

```bash
# with signature verification
hauler store sync --products rancher=v2.8.0 --key carbide-key.pub
hauler store sync --products rancher=v2.7.9 --key carbide-key.pub

# without signature verification
hauler store sync --products rancher=v2.8.0
hauler store sync --products rancher=v2.7.9
```

### Example Workflow for Cert-Manager
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Any OCI compatible image can be fetched remotely:

```yaml
# "shorthand" image references
hauler store add image rancher/rancher:v2.8.0
hauler store add image rancher/rancher:v2.7.9

# fully qualified image references
hauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-0.4.2/introduction/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0)
hauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.0
# 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 file: rke2-install.sh
hauler store add file https://get.rke2.io --name install.sh
Expand Down Expand Up @@ -58,7 +58,7 @@ spec:
charts:
- name: rancher
repoURL: https://releases.rancher.com/server-charts/stable
version: 2.8.0
version: 2.7.9
---
apiVersion: content.hauler.cattle.io/v1alpha1
kind: Files
Expand Down
Loading

0 comments on commit ab9523e

Please sign in to comment.