Setup experience guide: document current behavior #24736
Conversation
Planning future improvements here:
noahtalerman
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
|
Hey @jahzielv can you please sanity check me here for accuracy? @Drew-P-drawers as someone who lives further from the code, can you please check for clarity / understandability? |
articles/macos-setup-experience.md
Outdated
| @@ -178,6 +178,8 @@ If you configure software and/or a script for setup experience, users will see a | |||
|
|
|||
| This window shows the status of the software installations as well as the script exectution. Once all steps have completed, the window can be closed and Setup Assistant will proceed as usual. | |||
|
|
|||
| > Currently, software set to [automatic install](https://fleetdm.com/guides/automatic-software-install-in-fleet) is also installed during Setup Assistant but won't appear in the window. All software, automatic and setup experience, isn't installed in any particular order. The script always runs after setup experience software is installed. | |||
There was a problem hiding this comment.
@noahtalerman this sounds right to me, but I would like to double check
All software, automatic and setup experience, isn't installed in any particular order
Can I get back to you tomorrow morning on this?
There was a problem hiding this comment.
@jahzielv sounds good 👍
Heads up that I updated the language in this commit.
Is there a good spot on the Setup experience page in the UI so IT admins are aware?
There was a problem hiding this comment.
@noahtalerman dug into the details this morning. It's a little complicated 😅
TL;DR - technically there is no particular order that software will be installed. In most situations though, automatic install software will install before setup experience software. I think the "no order" language is best since it's the truth/least confusing. I'll leave it up to you if we want to get more into the weeds.
The only order we enforce re: software installations is here, where we list the software installations that are pending. This list, ordered by creation time, is what gets sent to Orbit so it knows what software to install.
If setup experience is supposed to be run, we currently pause all software installations until after swiftDialog is installed on the host (see here).
We also do not create a software installation request for setup experience software until swiftDialog is installed on the host (see here).
Downloading and installing swiftDialog can take a while, and on top of that Orbit only re-checks the config every 30s, so in practice the host's queries (including the automatic install policy queries) will have run long before swiftDialog is in place and the above checks pass.
Since pending software installations are listed in order of creation (like noted at the top), and since in practice the automatic policy installation requests will be created before the setup experience installation requests (because we're waiting on swiftDialog), in practice automatic installations will run before setup experience ones.
But this order isn't enforced by code, it's just happening because typically time to download swiftDialog < time to run policies.
There was a problem hiding this comment.
Is there a good spot on the Setup experience page in the UI so IT admins are aware?
Could we add a link to the doc updated in this PR under/next to this one? Maybe something like Learn about how Fleet installs software on hosts?
noahtalerman
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
|
I think let's add a tooltip on the Setup experience page (underline under "installed during setup"): |
Document current behavior.
Planning future improvements here: #24508 (comment)