Skip to content

Commit

Permalink
small updates and updated known limits (#38)
Browse files Browse the repository at this point in the history
* upgraded docusaurus version
* added more know limits
  • Loading branch information
zackbradys authored Dec 2, 2024
1 parent a90dad6 commit 59bc7b1
Show file tree
Hide file tree
Showing 4 changed files with 6,155 additions and 1,251 deletions.
13 changes: 9 additions & 4 deletions docs/known-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,15 @@ sidebar_label: Known Issues/Limits

## Limitations

- When using a `store` for `hauler` that has the same name of a `helm` chart, `hauler` will fail to fetch the chart.
- For example, if you tried to use a `store` name of `rancher` with a `helm` chart name `rancher`, the fetch will fail due to the fact that `helm` defaults to using an exisiting local directory, if it matches the name of the chart.
- https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815
- When using `hauler`, it will default to write temporary files to `/tmp`. If you do not have about 3x the amount of space available in your `/tmp` compared to the size of the `store` or the `haul`, then `hauler` may fail.
- `Hauler` may error when fetching a helm chart when using a `store` with the same name of the `helm chart`.
- For example, if you tried to use a custom `store` name of `rancher` when fetching a `helm chart` named `rancher`, it will fail due to the fact that `helm` defaults to fetching charts from an exisiting local directory.
- https://github.com/helm/helm/blob/main/pkg/action/install.go#L730-L831
---
- `Hauler` will default to write temporary directories and files to `/tmp`. If you do not have the same (or more) amount of space available in your `/tmp` compared to the size of the `store` or `haul`, then `hauler` may error.
- **Recommendation:** Ensure there is enough space availabe in `/tmp` or change the default temporary directory with `--tempdir`, before running the command `hauler store load <haul.tar.zst>`.
---
- `Hauler` may error when trying to run multiple commands (procceses) concurrently...
- Currently we leverage `cosign` for some functionality within `hauler`. If you try to run multiple proccesses at the same time that use the embedded `cosign`, then `hauler` may error on one or more of the procceses.

## Notices

Expand Down
Loading

0 comments on commit 59bc7b1

Please sign in to comment.