Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate docs #1968

Merged
merged 1 commit into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
Expand Down
9 changes: 9 additions & 0 deletions docs/elemental_exit-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,13 @@
| 76 | Error occurred while creating the OS filesystem image|
| 77 | Error occurred while copying the filesystem image and setting new labels|
| 78 | Error setting persistent GRUB variables|
| 79 | Error occured on before-disk hook|
| 80 | Error occured on after-disk hook|
| 81 | Error occured on after-disk-chroot hook|
| 82 | Error occured on after-disk hook|
| 83 | Error occured checking configured size is bigger than minimum required size|
| 84 | Error occured initializing snapshotter|
| 85 | Error occured starting an snapshotter transaction|
| 86 | Error mounting EFI partition|
| 87 | Error mounting Persistent partition|
| 255 | Unknown error|
4 changes: 1 addition & 3 deletions docs/elemental_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,19 @@ elemental install DEVICE [flags]
--cosign-key string Sets the URL of the public key to be used by cosign validation
--disable-boot-entry Dont create an EFI entry for the system install.
--eject-cd Try to eject the cd on reboot, only valid if booting from iso
--firmware string Firmware to install for: 'efi' or 'bios'. (defaults to 'efi') (default "efi")
--force Force install
-h, --help help for install
-i, --iso string Performs an installation from the ISO url
--local Use an image from local cache
--no-format Don’t format disks. It is implied that COS_STATE, COS_RECOVERY, COS_PERSISTENT, COS_OEM are already existing
--part-table string Partition table type to use (default "gpt")
--platform string Platform to build the image for (default "linux/amd64")
--poweroff Shutdown the system after install
--reboot Reboot the system after install
--recovery-system.uri string Sets the recovery image source and its type (e.g. 'docker:registry.org/image:tag')
-x, --squash-compression stringArray cmd options for compression to pass to mksquashfs. Full cmd including --comp as the whole values will be passed to mksquashfs. For a full list of options please check mksquashfs manual. (default value: '-comp xz -Xbcj ARCH')
--squash-no-compression Disable squashfs compression. Overrides any values on squash-compression
--strict Enable strict check of hooks (They need to exit with 0)
--system.uri string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--system string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--verify Enable mtree checksum verification (requires images manifests generated with mtree separately)
```

Expand Down
2 changes: 1 addition & 1 deletion docs/elemental_reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ elemental reset [flags]
--reset-oem Clear OEM partitions
--reset-persistent Clear persistent partitions
--strict Enable strict check of hooks (They need to exit with 0)
--system.uri string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--system string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--verify Enable mtree checksum verification (requires images manifests generated with mtree separately)
```

Expand Down
5 changes: 3 additions & 2 deletions docs/elemental_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,19 @@ elemental upgrade [flags]
### Options

```
--bootloader Reinstall bootloader during the upgrade
--cosign Enable cosign verification (requires images with signatures)
--cosign-key string Sets the URL of the public key to be used by cosign validation
-h, --help help for upgrade
--local Use an image from local cache
--poweroff Shutdown the system after install
--reboot Reboot the system after install
--recovery Upgrade the recovery
--recovery Upgrade recovery image too
--recovery-system.uri string Sets the recovery image source and its type (e.g. 'docker:registry.org/image:tag')
-x, --squash-compression stringArray cmd options for compression to pass to mksquashfs. Full cmd including --comp as the whole values will be passed to mksquashfs. For a full list of options please check mksquashfs manual. (default value: '-comp xz -Xbcj ARCH')
--squash-no-compression Disable squashfs compression. Overrides any values on squash-compression
--strict Enable strict check of hooks (They need to exit with 0)
--system.uri string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--system string Sets the system image source and its type (e.g. 'docker:registry.org/image:tag')
--verify Enable mtree checksum verification (requires images manifests generated with mtree separately)
```

Expand Down
2 changes: 1 addition & 1 deletion pkg/error/exit-codes.go
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ const SnapshotterStart = 85
const MountEFIPartition = 86

// Error mounting Persistent partition
const MountPersistentPartition = 86
const MountPersistentPartition = 87

// Unknown error
const Unknown int = 255
Loading