From: Dominik Csapak <d.csapak@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH docs v3 1/1] update documentation about sync-options
Date: Thu, 24 Mar 2022 13:45:24 +0100 [thread overview]
Message-ID: <20220324124524.3633145-4-d.csapak@proxmox.com> (raw)
In-Reply-To: <20220324124524.3633145-1-d.csapak@proxmox.com>
describe the new 'remove-vanished' option and what the options are doing
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
pveum.adoc | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/pveum.adoc b/pveum.adoc
index a5c8906..99e1a45 100644
--- a/pveum.adoc
+++ b/pveum.adoc
@@ -355,13 +355,21 @@ The main options for syncing are:
* `Enable new` (`enable-new`): If set, the newly synced users are enabled and
can log in. The default is `true`.
-* `Full` (`full`): If set, the sync uses the LDAP directory as a source of
- truth, overwriting information set manually in the `user.cfg` and deleting
- users and groups which are not present in the LDAP directory. If not set, only
- new data is written to the configuration, and no stale users are deleted.
+* `Remove Vanished` (`remove-vanished`): This is a list of options which, when
+ activated, determine if they are removed when they are not returned from
+ the sync response. The options are:
-* `Purge ACLs` (`purge`): If set, sync removes all corresponding ACLs when
- removing users and groups. This is only useful with the option `full`.
+ - `ACL` (`acl)`: Remove ACLs of users and groups which were not returned
+ returned in the sync response. This most often makes sense together with
+ `Entry`.
+
+ - `Entry` (`entry`): Removes entries (i.e. users and groups) when they are
+ not returned in the sync response.
+
+ - `Properties` (`properties`): Removes properties of entries which were
+ not returned in the sync response. This includes custom properties
+ which were never set by the sync. Exceptions are tokens and the enable
+ flag. Those will be retained even with this option.
* `Preview` (`dry-run`): No data is written to the config. This is useful if you
want to see which users and groups would get synced to the `user.cfg`.
--
2.30.2
prev parent reply other threads:[~2022-03-24 12:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-24 12:45 [pve-devel] [PATCH access-control/manager/docs v3] fix #3668: improving realm sync Dominik Csapak
2022-03-24 12:45 ` [pve-devel] [PATCH access-control v3 1/1] fix #3668: realm-sync: replace 'full' and 'purge' options with 'remove-vanished' Dominik Csapak
2022-03-24 12:45 ` [pve-devel] [PATCH manager v3 1/1] ui: realm sync: replace 'full' and 'purge' " Dominik Csapak
2022-03-24 12:45 ` Dominik Csapak [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220324124524.3633145-4-d.csapak@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox