From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 440A792073 for ; Tue, 28 Mar 2023 14:09:09 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 237BB1B682 for ; Tue, 28 Mar 2023 14:08:39 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 28 Mar 2023 14:08:38 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 2497C47095 for ; Tue, 28 Mar 2023 14:08:38 +0200 (CEST) Date: Tue, 28 Mar 2023 14:08:30 +0200 From: Fabian =?iso-8859-1?q?Gr=FCnbichler?= To: Proxmox VE development discussion References: <20221215142009.59496-1-n.ullreich@proxmox.com> In-Reply-To: <20221215142009.59496-1-n.ullreich@proxmox.com> MIME-Version: 1.0 User-Agent: astroid/0.16.0 (https://github.com/astroidmail/astroid) Message-Id: <1680005288.s85nfih7o1.astroid@yuna.none> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-SPAM-LEVEL: Spam detection results: 0 AWL -0.078 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] applied: [PATCH pve-docs v3] updated tags docs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 28 Mar 2023 12:09:09 -0000 with Stefan's R-b On December 15, 2022 3:20 pm, Noel Ullreich wrote: > updated the tags doc with slight rephrasing, corrected grammar, > and fixed typos. >=20 > Signed-off-by: Noel Ullreich > --- > changes since v1: > * removed changes in datacenter.cfg.5-opts.adoc since it is an > autogenerated file (thanks @Dominik;) ) >=20 > changes since v2: > * fixed two typos and rephrased two sentences (thanks @Sterzy) >=20 > pve-gui.adoc | 71 ++++++++++++++++++++++++++-------------------------- > 1 file changed, 35 insertions(+), 36 deletions(-) >=20 > diff --git a/pve-gui.adoc b/pve-gui.adoc > index ff95cfb..4292ca2 100644 > --- a/pve-gui.adoc > +++ b/pve-gui.adoc > @@ -386,68 +386,67 @@ Tags > =20 > [thumbnail=3D"screenshot/gui-qemu-summary-tags-edit.png", float=3D"left"= ] > =20 > -For organizational purposes, it is possible to set `tags` on guests. The= se have > -currently only informational value and they are display by default in th= e gui > -in two places, the `Resource Tree` and in the status line when a guest i= s > -selected. > +For organizational purposes, it is possible to set `tags` for guests. > +Currently, these only provide informational value to users. > +Tags are displayed in two places in the web interface: in the `Resource = Tree` and > +in the status line when a guest is selected. > =20 > -They can be added, edited and removed in that status line of the guest b= y > -clicking on the `pencil` icon. After the tags have the desired values, y= ou > -can click on the `check mark` button to apply the changes, or click the > -`X` button to cancel you editing. > +Tags can be added, edited, and removed in the status line of the guest b= y > +clicking on the `pencil` icon. You can add multiple tags by pressing the= `+` > +button and remove them by pressing the `-` button. To save or cancel the= changes, > +you can use the `=E2=9C=93` and `x` button respectively. > =20 > -The tags can also be set via the CLI, where multiple tags are semi-colon > -separated, for example: > +Tags can also be set via the CLI, where multiple tags are separated by s= emicolons. > +For example: > =20 > ---- > # qm set ID --tags myfirsttag;mysecondtag > ---- > =20 > -Styling > -~~~~~~~ > +Style Configuration > +~~~~~~~~~~~~~~~~~~~ > =20 > [thumbnail=3D"screenshot/gui-datacenter-tag-style.png"] > =20 > -To adapt to various use cases and preferences, there are some options in= the > -datacenter configuration that helps an admin control the behaviour and s= tyle > -of tags, such as the colors, ordering, and basic permission settings. > - > - > -By default the tag colors are derived from their text in a deterministic= way, > -but can be overridden in the datacenter configuration (The background co= lor as > -well as the text color) as hexadecimal RGB values. You can also set thes= e > -overrides via the CLI, for example: > +By default, the tag colors are derived from their text in a deterministi= c way. > +The color, shape in the resource tree, and case-sensitivity, as well as = how tags > +are sorted, can be customized. This can be done via the web interface un= der > +__Datacenter -> Options -> Tag Style Override__. Alternatively, this can= be done > +via the CLI. For example: > =20 > ---- > # pvesh set /cluster/options --tag-style color-map=3Dexample:000000:FFFF= FF > ---- > =20 > -Sets the background color of the tag `example` to black (#000000) and th= e text > +sets the background color of the tag `example` to black (#000000) and th= e text > color to white (#FFFFFF). > =20 > -You can also change the style of the tags in the tree and if the tags sh= ould > -be alphabetically sorted (the default) or should retain their order from= the > -guest configuration. > - > Permissions > ~~~~~~~~~~~ > =20 > [thumbnail=3D"screenshot/gui-datacenter-options.png"] > =20 > By default, users with the privilege `VM.Config.Options` on a guest (`/v= ms/ID`) > -can set any tags they want. If you want to restrict this behaviour, it i= s > -possible to set various modes via the datacenter configuration: > +can set any tags they want (see > +xref:pveum_permission_management[Permission Management]). If you want to > +restrict this behavior, appropriate permissions can be set under > +__Datacenter -> Options -> User Tag Access__: > + > +* `free`: users are not restricted in setting tags (Default) > +* `list`: users can set tags based on a predefined list of tags > +* `existing`: like list but users can also use already existing tags > +* `none`: users are restricted from using tags > + > +The same can also be done via the CLI. > =20 > -* a list of allowed tags > -* existing tags > -* no tags at all > +Note that a user with the `Sys.Modify` privileges on `/` is always able = to set > +or delete any tags, regardless of the settings here. Additionally, there= is a > +configurable list of `registered tags` which can only be added and remov= ed by > +users with the privilege `Sys.Modify` on `/`. The list of registered tag= s can be > +edited under __Datacenter -> Options -> Registered Tags__ or via the CLI= . > =20 > -Note that a user with `Sys.Modify` on `/` is always able to set or delet= e > -any tags, regardless of the settings here. Additionally, there is a conf= igurable > -list of `registered tags` which will also require the privilege `Sys.Mod= ify` > -on `/` to be added or removed independent of the mode. > =20 > -For more details on the exact options, see the > +For more details on the exact options and how to invoke them in the CLI,= see > xref:datacenter_configuration_file[Datacenter Configuration]. > =20 > ifdef::wiki[] > --=20 > 2.30.2 >=20 >=20 >=20 > _______________________________________________ > pve-devel mailing list > pve-devel@lists.proxmox.com > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel >=20