Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): How-to guides about UP4W agent startup #944

Merged
merged 11 commits into from
Nov 13, 2024

Conversation

CarlosNihelton
Copy link
Contributor

@CarlosNihelton CarlosNihelton commented Oct 17, 2024

As agreed in WS037, I'm bringing two pieces of documentation about how system administrators can have UP4W background agent start without explicit end user interaction.

One guide relies on being able to start the agent via CLI (reason why this PR is based on #941 ) by deploying an one-shot PowerShell script via Intune to be executed with the current user's credentials.

The other guide relies on the registry, but leverages Intune Remediations to make that approach more reliable, by having that tool automatically checking and fixing non-compliant state, thus multi-shot (should end users disable the startup task, Intune would eventually find it and fix it).


This PR completes UDENG-4623 and closes #912 .

Using Intune Remediations sysadmins can monitor the value of the desired
key and reduce the likelyhood of the inherent race condition of
installing the MSIX and setting the registry value causing silent
issues.
Eventually Intune would pick up the non-compliant state and fix it up.
More descriptive, making more sense when read in the registry.
Including

- Remediations: most often uncountable, in this case it is a countable
  word.

- Center: mispelled in en_GB, but the portal name is en_US (Intune Admin
  Center)
and cross reference the other guide.
@CarlosNihelton CarlosNihelton marked this pull request as ready for review October 17, 2024 13:35
@CarlosNihelton CarlosNihelton requested a review from a team as a code owner October 17, 2024 13:35
@CarlosNihelton CarlosNihelton self-assigned this Oct 17, 2024
Copy link
Collaborator

@edibotopic edibotopic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this @CarlosNihelton -- this is very useful information!

I have included several suggestions, mainly focused on wording and clarity.

Two broader, non-blocking points I would like us to think about (in subsequent discussions and PRs):

  • Explanatory content: there is quite a bit of explanatory content. While this is good material, I think it might be better placed in a dedicated explanation article in the docs (something focused on remote management). This would ensure that the how-to guides flow and mainly contain the information necessary for someone to complete the tasks involved. In addition, this would help prevent some duplication across the two guides.
  • Separation of guides: I think the guides might need a cleaner separation in their titles. When thinking about that in the future, we should also think whether they would be better combined.

docs/howto/enforce-agent-startup-remotely-registry.md Outdated Show resolved Hide resolved
docs/howto/enforce-agent-startup-remotely-registry.md Outdated Show resolved Hide resolved
docs/howto/enforce-agent-startup-remotely-registry.md Outdated Show resolved Hide resolved
docs/howto/enforce-agent-startup-remotely-registry.md Outdated Show resolved Hide resolved
docs/howto/enforce-agent-startup-remotely-registry.md Outdated Show resolved Hide resolved
docs/howto/start-agent-remotely.md Outdated Show resolved Hide resolved
docs/howto/start-agent-remotely.md Outdated Show resolved Hide resolved
docs/howto/start-agent-remotely.md Outdated Show resolved Hide resolved
docs/howto/start-agent-remotely.md Outdated Show resolved Hide resolved
docs/howto/start-agent-remotely.md Show resolved Hide resolved
Instead of 'end user'.
... Enforcing with Intune & Registry guide.
... Guide on starting the agent with Intune.
For better searchability.
Now a heading for the action of applying the scripts is needed.
Copy link
Collaborator

@edibotopic edibotopic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Much thanks.

Base automatically changed from agent-app-alias to main November 13, 2024 13:55
@CarlosNihelton CarlosNihelton merged commit e02b29f into main Nov 13, 2024
9 checks passed
@CarlosNihelton CarlosNihelton deleted the howto-startup-registry branch November 13, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Start the agent upon installation with starting the App
2 participants