summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #2705 from cgwalters/always-bootJoseph Marrero Corchado2023-03-171-0/+9
|\ | | | | Add `sysroot.bootprefix` option
| * Add `sysroot.bootprefix` optionColin Walters2022-08-311-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | This is a follow up to https://github.com/ostreedev/ostree/pull/2149/commits/0ced9fde7649271d9458ca424aa8c41908634b02 "sysroot: Support /boot on root or as seperate filesystem for syslinux and u-boot" What we should have done at the time is changed our bootloader entries to be prefixed with `/boot`. This means that the GRUB2 BLS support will Just Work. For now, I'm making this option default to off out of a lot of conservatism. I think in the future we should flip this on by default.
* | bin/show: Add options to list metadata keysDan Nicholson2023-02-071-0/+16
| | | | | | | | | | While `--print-metadata-key` is very useful, it's not that helpful if you don't know what the keys are.
* | bin/remote-refs: Add option to print revisionsDan Nicholson2023-02-071-0/+11
| | | | | | | | | | | | | | The only other way to get the remote ref revision from the CLI is to scrape the output of `ostree remote summary` or pull the commit. The revision is already there in the summary's ref map, so might as well add an option to show it.
* | bin/refs: Add option to print revisionsDan Nicholson2023-02-071-0/+9
| | | | | | | | | | | | Allow printing the revision along with the ref. This is very convenient for looping over the refs in a shell as well as for quickly seeing which refs are pointed to the same commit.
* | bin: Cleanup documentation of --cache-dir optionDan Nicholson2023-02-073-0/+38
| | | | | | | | | | In all cases documentation was missing from the manual and the bash completion was incorrectly assigning it as a boolean option.
* | Support overlayfs whiteouts on checkoutMiguel Angel Ajo2022-09-281-0/+11
|/ | | | | | | | | | | | Introduces an intermediate format for overlayfs storage, where .wh-ostree. prefixed files will be converted into char 0:0 whiteout devices used by overlayfs to mark deletions across layers. The CI scripts now uses a volume for the scratch directories previously in /var/tmp otherwise we cannot create whiteout devices into an overlayfs mounted filesystem. Related-Issue: #2712
* cli/rev-parse: Add `--single` optionColin Walters2022-08-181-0/+13
| | | | | | | | | | | | In the current "ostree native container" flow, we're inserting a commit object into the repo but with no refs. We have hacks in a few places to find the commit digest via e.g. `find repo/objects -name *.commit` but that's a horrible hack. Add `ostree rev-parse --single` which will print the single commit, and error out if there is not exactly one commit. Co-authored-by: Jonathan Lebon <jonathan@jlebon.com>
* Merge pull request #2613 from GuiltyDoggy/man-updateLuca Bruno2022-05-301-6/+4
|\ | | | | man: Fix ostree-admin-instutil subcommands
| * man: Fix ostree-admin-instutil subcommandsYosuke Matsumura2022-05-191-6/+4
| | | | | | | | | | | | | | | | | | | | <term><cmdsynopsis> is not valid, causing the command to not be rendered correctly. Create one <variablelist> per <cmdsynopsis>. Inelegant but maintains desired formatting. Closes #2581
* | man/ostree.repo-config.xml: add docs for bls-append-except-default keySaqib Ali2022-05-191-0/+11
|/ | | | Relevant: https://github.com/coreos/fedora-coreos-tracker/issues/134
* man: Create an HTML indexDan Nicholson2022-04-081-0/+202
| | | | | This provides something that can serve at the root of the HTML man pages tree.
* man: Use custom XSL stylesheet for HTML outputDan Nicholson2022-04-081-0/+37
| | | | | This allows using a template stolen from systemd to turn references into links.
* man: Remove unnecessary nbsp's from ostree man pageDan Nicholson2022-04-081-33/+33
| | | | | | | I really don't know what these were for. In both man and HTML output with a recent version of the Docbook XSL, the command synopses are already indented. I don't see any reason why they'd need to be manually indented more.
* man/prune, bash: Add --commit-only flag for ostree pruneSaqib Ali2022-02-251-0/+11
| | | | | Update the man page and the auto-complete script to include the --commit-only flag
* Merge pull request #2541 from melix99/find-remotes-fix-typoColin Walters2022-02-131-1/+1
|\ | | | | man: Fix typo in ostree-find-remotes
| * man: Fix typo in ostree-find-remotesMarco Melorio2022-02-121-1/+1
| |
* | man: Fix typo in ostree-admin-switchMarco Melorio2022-02-121-1/+1
|/
* lib/repo: Add commit version metadata to summary metadataDan Nicholson2022-02-041-0/+1
| | | | | | | | The commit metadata `version` key is well established but getting it for a remote commit is cumbersome since the commit object needs to be fetched and loaded. Including it in the summary additional metadata allows a much more convenient view of what each of the remote refs represents.
* Update FSF license notices to use URL instead of addressJoseph Marrero2021-12-0744-132/+44
|
* Merge pull request #2434 from cgwalters/custom-remoteColin Walters2021-09-081-0/+8
|\ | | | | Add support for "custom remotes"
| * Add support for "custom remotes"Colin Walters2021-09-081-0/+8
| | | | | | | | | | | | | | | | | | | | This will be helpful for the "ostree native container" work in https://github.com/ostreedev/ostree-rs-ext/ Basically in order to reuse GPG/signapi verification, we need to support adding a remote, even though it can't be used via `ostree pull`. (At least, not until we merge ostree-rs-ext into ostree, but even then I think the principle stands)
* | upgrade: Stabilize deployment stagingColin Walters2021-09-071-0/+10
|/ | | | | | | | | | We're waaay overdue for this, it's been the default in rpm-ostree for years, and solves several important bugs around not capturing `/etc` while things are running. Also, `ostree admin upgrade --stage` (should) become idempotent. Closes: https://github.com/ostreedev/ostree/issues/2389
* bin/remote: Rename list-gpg-keys to gpg-list-keysDan Nicholson2021-08-231-2/+2
| | | | | | | | | | | | | | | As pointed out in the original review, `gpg-list-keys` fits better alongside the existing `gpg-import`. Changes were done with: ``` git grep -l list-gpg-keys | xargs sed -i 's/list-gpg-keys/gpg-list-keys/' for src in $(git ls-files '*list-gpg-keys*'); do dst=${src/list-gpg-keys/gpg-list-keys} git mv "$src" "$dst" done ```
* Merge pull request #2401 from dbnicholson/gpg-key-infoColin Walters2021-08-201-1/+8
|\ | | | | Remote GPG key info
| * bin/remote: Add list-gpg-keys subcommandDan Nicholson2021-07-151-1/+8
| | | | | | | | | | | | | | | | This provides a wrapper for the `ostree_repo_remote_get_gpg_keys` function to show the GPG keys associated with a remote. This is particularly useful for validating that GPG key updates have been applied. Tests are added, which checks the `ostree_repo_remote_get_gpg_keys` API by extension.
* | man: improve statoverride descriptionBenjamin Gilbert2021-07-141-1/+3
|/ | | | | A statoverride file written in the obvious way will produce incorrect results for two independent reasons. Document them.
* *: rename master to main in tests & examplesTimothée Ravier2021-05-075-12/+12
|
* Add an API+CLI to inject metadata for bootable OSTree commitsColin Walters2021-03-121-0/+7
| | | | | | | | | | | | | | | | | | | | | I was doing some rpm-ostree work and I wanted to compare two OSTree commits to see if the kernel has changed. I think this should be a lot more natural. Add `ostree commit --bootable` which calls into a new generic library API `ostree_commit_metadata_for_bootable()` that discovers the kernel version and injects it as an `ostree.linux` metadata key. And for extra clarity, add an `ostree.bootable` key. It's interesting because the "core" OSTree layer is all about generic files, but this is adding special APIs around bootable OSTree commits (as opposed to e.g. flatpak as well as things like rpm-ostree's pkgcache refs). Eventually, I'd like to ensure everyone is using this and hard require this metadata key for the `ostree admin deploy` flow - mainly to prevent accidents.
* man: Add missing repo mode in config docsfix-repo-modes-docsPhaedrus Leeds2021-03-081-1/+1
|
* pull: Allow disabling commit binding verificationDan Nicholson2020-12-172-0/+16
| | | | | | | | | | | | | | | | In some cases such as backups or mirroring you may want to pull commits from one repo to another even if there commits that have incorrect bindings. Fixing the commits in the source repository to have correct bindings may not be feasible, so provide a pull option to disable verification. For Endless we have several repositories that predate collection IDs and ref bindings. Later these repositories gained collection IDs to support the features they provide and ref bindings as the ostree tooling was upgraded. These repositories contain released commits that were valid to the clients they were targeting at the time. Correcting the bindings is not really an option as it would mean invalidating the repository history.
* Add support for explicitly requesting any specific bootloader typeWilliam Manley2020-10-261-1/+8
| | | | | | | | | ...with the `sysroot.bootloader` configuration option. This can be useful when converting a system to use `ostree` which doesn't currently have a bootloader configuration that `ostree` can automatically detect, and is also useful in combination with the `--sysroot` option when provisioning a rootfs for systems other than the one you're running `ostree admin deploy` on.
* deltas: Add and document no-deltas-in-summary config optionAlexander Larsson2020-10-231-0/+14
| | | | By default this is FALSE to keep existing clients working.
* Merge pull request #2198 from cgwalters/no-hardlink-zerosizeOpenShift Merge Robot2020-10-051-1/+1
|\ | | | | checkout: Don't hardlink zero sized files
| * checkout: Don't hardlink zero sized filesColin Walters2020-10-011-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Alternative to https://github.com/ostreedev/ostree/pull/2197 Python's (usually) zero-sized `__init__.py` files can provoke us hitting the hardlink limits on some filesystems (`EMLINK`). At least one Fedora rpm-ostree user hit this. The benefits of hardlinking here are quite marginal; lots of hardlinks can behave suboptimally in particular filesystems like BTRFS too. This builds on prior code which made this an option, introduced in https://github.com/ostreedev/ostree/commit/673cacd633f9d6b653cdea530657d3e780a41bbd Now we just do it uncondtionally. Also this provoked a different bug in a very obscure user mode checkout case; when the "real" permissions were different from the "physical" permissions, we would still hardlink. Fix the test case for this.
* | bin/static-delta: Add signature parameters to apply-offlineFrédéric Danis2020-09-141-1/+60
| | | | | | | | | | | | This allows to check the delta signature before applying it. Signed-off-by: Frédéric Danis <frederic.danis@collabora.com>
* | bin/static-delta: Add command to verify delta signatureFrédéric Danis2020-09-141-0/+64
| | | | | | | | | | | | | | Add new "static-delta verify" sub-command. This supports multiple keys to verify the static-delta file. Signed-off-by: Frédéric Danis <frederic.danis@collabora.com>
* | bin/static-delta: Add support to sign superblockFrédéric Danis2020-09-141-0/+33
|/ | | | | | Add signing ability to "static-delta generate" builtin. Signed-off-by: Frédéric Danis <frederic.danis@collabora.com>
* man: add missing options to the ostree-commit man pageStefan Agner2020-07-311-1/+33
| | | | | | Add missing parameter to the ostree-commit man page. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* man: add glossary to main man pageStefan Agner2020-07-311-0/+64
| | | | | | | Add glossary to define some commonly used literals throughout the ostree man pages. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* pull: Add --per-object-fsyncColin Walters2020-07-181-0/+12
| | | | | | | | | | | | This is the opposite of https://github.com/ostreedev/ostree/issues/1184 Motivated by OpenShift seeing etcd performance issues during OS updates: https://github.com/openshift/machine-config-operator/issues/1897 Basically, if we switch to invoking `fsync()` as we go, it makes ostree performance worse (in my tests, 31s to write 2G versus 7s if we delay sync) but it avoids *huge* outliers in `fsync()` time for etcd.
* man/checkout: document missing optionsStefan Agner2020-06-081-0/+71
| | | | | | Document missing options in the ostree checkout man page. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* man/checkout: fix short name option of --user-modeStefan Agner2020-06-081-1/+1
| | | | | | The short name option of --user-mode is -U. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
* commit: Add --base argumentColin Walters2020-04-061-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I was trying to followup the `--selinux-policy-from-base` work to add a `cosa build --fast=overlay` for coreos-assembler, but hit on the fact that using e.g. `--owner-uid` disables commit optimizations. A while ago, https://github.com/ostreedev/ostree/pull/1643 landed which optimized this for the case where no modifications are provided. But, we really need the SELinux policy bits, and it's super convenient to run `ostree commit` as non-root. It's fairly surprising actually that it's taken us so long to iterate on a good interface for this "commit changes on top of a base" model. In practice, many nontrivial cases really end up needing to do a (hardlink) checkout, and that case is optimized. But for this coreos-assembler work I want to directly overlay onto a commit object another commit object. That previous PR above added exactly the API we need, so let's expose it in the CLI. What you can see happening in the test is that we provide `--owner-uid 42`, but that only applies to directories/files that were added in the commit. And now that I look at this, I think what we really want here is to avoid changing directories that exist in the base, but eh; in practice the main use here is for `--owner-uid 0` while committing as non-root; and that works fine with this since the baseline uid will be zero as well.
* Merge pull request #1878 from d4s/wip/d4s/no_gpgOpenShift Merge Robot2020-04-043-1/+219
|\ | | | | Alternative signing system
| * man: add signature options for ostree summaryDenis Pynkin2020-03-251-1/+34
| | | | | | | | | | | | | | Add a description of new options `--sign-type` and `--sign` for `ostree summary` command. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
| * man: document commit signingDenis Pynkin2020-03-251-0/+33
| | | | | | | | | | | | | | Added options descriptions for `ostree-commit` allowing to sign the commit. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
| * man: document `ostree sign`Denis Pynkin2020-03-251-0/+152
| | | | | | | | | | | | Add man page for `ostree sign`. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
* | find-remotes: Add a --mirror optionMatthew Leeds2020-03-281-0/+10
|/ | | | | | This will be useful in the unit test added by the next commit. It just passes OSTREE_REPO_PULL_FLAGS_MIRROR to the call to ostree_repo_pull_from_remotes_async().
* bin/diff: Clarify documentation around REV and DIR syntaxJonathan Lebon2020-03-181-2/+2
| | | | Related: #2032
View Lorry Controller Status