Bug 2098167 - Missing overrides information in cockpit/web console documentation
Summary: Missing overrides information in cockpit/web console documentation
Keywords:
Status: NEW
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: Documentation
Version: 8.7
Hardware: All
OS: Linux
high
medium
Target Milestone: rc
: ---
Assignee: Mayur Patil
QA Contact:
Mayur Patil
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-06-17 13:24 UTC by Steve Barcomb
Modified: 2023-07-11 11:47 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed:
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHELPLAN-125594 0 None None None 2022-06-17 13:39:41 UTC

Description Steve Barcomb 2022-06-17 13:24:22 UTC
A customer has recently asked about disabling all widgets in the cockpit/web console except for the terminal application.  This lead to https://cockpit-project.org/guide/latest/packages.html#package-manifest-override which details how to use overrides.

A correction to the upstream documentation though.  The above links says to put this information into /etc/cockpit, but in testing this looks to be required in /usr/share/cockpit in each directory within that a customer wishes to disable.

Additionally, the version of cockpit that I think is coming in RHEL8.7 cockpit-271 seems to allow disablement on a per user basis with those overrides files being placed in ~/.config/cockpit/<system> which does not yet seems to be documented upstream.

Comment 5 Martin Pitt 2022-11-07 06:32:14 UTC
> A correction to the upstream documentation though.  The above links says to put this information into /etc/cockpit, but in testing this looks to be required in /usr/share/cockpit in each directory within that a customer wishes to disable.

/usr/share/cockpit/$page/override.json was indeed the old location, before cockpit 265 [1]. That is refered to with "A file called override.json may be placed next to the manifest". But this is awkward, as /usr/share/ is package manager territory, and users/admins really should not write there. It's not even possible with OSTree systems like RHEL Edge or Fedora CoreOS. So possibly you tested on RHEL 8.6 or earlier? RHEL 8.7 supports this new path.


> Additionally, the version of cockpit that I think is coming in RHEL8.7 cockpit-271 seems to allow disablement on a per user basis with those overrides files being placed in ~/.config/cockpit/<system> which does not yet seems to be documented upstream.

If you mean that ~/.config/cockpit/systemd/override.json could override /usr/share/cockpit/systemd/manifest.json, then no, that's not supported (and not planned). See [2]. We only support ~/.config/cockpit/systemd.override.json (i.e. flat hierarchy in the cockpit/ directory, not a tree), and that is documented.



[1] https://cockpit-project.org/blog/cockpit-265.html
[2] https://github.com/cockpit-project/cockpit/commit/f0f497655b62b4efcef3ad0b31bb6d9137d184b5#diff-a5bc1c4fb29285eb87cb819cca5fb3183d556933bf927a0224ee12bbc7c2c634R409


Note You need to log in before you can comment on or make changes to this bug.