|
1 | | -# Release Notes for User Sync Tool Version 2.0 |
| 1 | +# Release Notes for User Sync Tool Version 2.1 |
2 | 2 |
|
3 | | -These notes apply to v2.0 of 2017-04-10. |
4 | | - |
5 | | -## New Arguments & Configuration Syntax |
6 | | - |
7 | | -There has been an extensive overhaul of both the configuration file |
8 | | -syntax and the command-line argument syntax. See |
9 | | -[Issue 95](https://github.com/adobe-apiplatform/user-sync.py/issues/95) |
10 | | -and the [docs](https://adobe-apiplatform.github.io/user-sync.py/) |
11 | | -for details. |
| 3 | +These notes apply to v2.1rc1 of 2017-05-05. |
12 | 4 |
|
13 | 5 | ## New Features |
14 | 6 |
|
15 | | -1. You can now exclude dashboard users from being updated or |
16 | | -deleted by User Sync. See the |
17 | | -[docs](https://adobe-apiplatform.github.io/user-sync.py/) for |
18 | | -details. |
19 | | -2. There is more robust reporting for errors in configuration |
20 | | -files. |
21 | | -3. The log now reports the User Sync version and gives the |
22 | | -details of how it was invoked. |
23 | | -4. You can now create and manage users of all identity types, |
24 | | -including Adobe IDs, both when operating from an LDAP |
25 | | -directory and from CSV files. |
26 | | -5. You can now distinguish, when a customer directory user is |
27 | | -disabled or removed, whether to remove the matching Adobe-side |
28 | | -user's product configurations and user groups, to remove the |
29 | | -user but leave his cloud storage, or to delete his storage as well. |
30 | | - |
31 | | -## Significant Bug Fixes |
32 | | - |
33 | | -1. There were many bugs fixed related to managing users of |
34 | | -identity types other than Federated ID. |
35 | | -2. There were many bugs fixes related to managing group |
36 | | -membership of all identity types. |
37 | | -3. There was a complete overhaul of how users who have |
38 | | -adobe group memberships in multiple organizations are |
39 | | -managed. |
40 | | - |
41 | | -## Changes in Behavior |
42 | | - |
43 | | -All options now apply to users of all identity types. Previously, |
44 | | -some had applied only to Federated ID and some to Enterprise ID. |
| 7 | +1. We now have full Unicode support. See [Issue 167](https://github.com/adobe-apiplatform/user-sync.py/issues/167) for details. |
| 8 | +2. We now support secure handling for all credential settings and credential files. See [Issue 159](https://github.com/adobe-apiplatform/user-sync.py/issues/159) for design discussion, and read [the docs](https://adobe-apiplatform.github.io/user-sync.py/) for associated config changes. |
45 | 9 |
|
46 | 10 | ## Compatibility with Prior Versions |
47 | 11 |
|
48 | | -All existing configuration files, user input files, |
49 | | -and command-line scripts will need to be revamped |
50 | | -to be compatible with the new formats. Here is a quick |
51 | | -cheat sheet of what needs to be done. |
52 | | - |
53 | | -### Configuration Files |
54 | | - |
55 | | -* replace `dashboard:` with `adobe_users:` |
56 | | -* replace `directory:` with `directory_users:` |
57 | | -* add a `connectors:` section under `adobe_users:` similar |
58 | | -to the one under `directory_users` |
59 | | -* change `owning` to be `umapi` and put it under `connectors` |
60 | | -* if you access multiple organizations, remove |
61 | | -`secondaries`, and put |
62 | | -all the umapi specifications under `umapi` as a list, |
63 | | -like this: |
64 | | -```yaml |
65 | | -adobe_users: |
66 | | - connectors: |
67 | | - umapi: |
68 | | - - primary-config.yml |
69 | | - - org1: org1-config.yml |
70 | | - - org2: org2-config.yml |
71 | | -``` |
72 | | -* change `dashboard_groups` to `adobe_groups` |
73 | | -* under `limits`, change `max_missing_users` to |
74 | | -`max_adobe_only_users` and remove all other |
75 | | -settings |
76 | | -* if you have an extension, do the following: |
77 | | - * remove the per-context: user setting |
78 | | - * move all the settings under it to the top level in |
79 | | -a new file, call it `extension.yaml` |
80 | | - * change `extensions` to `extension`, move it into |
81 | | -the `directory_users` section, and put the relative |
82 | | -path to the new `extension.yaml` file as its value. |
83 | | - |
84 | | -### User Input Files |
85 | | - |
86 | | -If you have a file that lists users for input (`--users file` _f_), |
87 | | -the column head `user` should be changed to `username`. |
88 | | - |
89 | | -### Removed User Input Files |
90 | | - |
91 | | -The format for files containing users to be removed/deleted has |
92 | | -changed, and you will need to regenerate these files rather than |
93 | | -using any existing ones. |
94 | | - |
95 | | -### Command Line Scripts |
96 | | - |
97 | | -* All of the options related to Adobe user removal have been |
98 | | -changed to use the new ``--adobe-only-user-action` argument. |
99 | | -* The `--source-filter` argument has been removed. Use the |
100 | | -configuration setting `all_users_filter` instead. |
| 12 | +This version is fully backward-compatible with version 2.0. There may be subtle behavioral changes due to bug fixes around support for non-Ascii characters. There are also new configuration file options and a new command line argument that didn't exist in 2.0. |
0 commit comments