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

docs: clarify behavior of launchctl stop and unload for client agent #5265

Merged
merged 4 commits into from
Dec 4, 2024

Conversation

Mohit0233
Copy link
Contributor

This pull request updates the macOS client agent documentation to clarify the behavior of launchctl stop and launchctl unload. It adds a note explaining that launchctl stop stops the agent temporarily, but the agent will automatically restart after 60 seconds due to the StartInterval setting. Additionally, the update provides information on using launchctl unload to permanently disable the client agent, in case users need to do so for specific reasons.

@Mohit0233 Mohit0233 requested a review from a team as a code owner November 20, 2024 15:02
Copy link

hashicorp-cla-app bot commented Nov 20, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Looks good, lets just make the reload command easier too

website/content/docs/api-clients/client-agent.mdx Outdated Show resolved Hide resolved
johanbrandhorst
johanbrandhorst previously approved these changes Dec 4, 2024
@johanbrandhorst
Copy link
Collaborator

Thanks for the docs update, we'll be able to merge once @Dan-Heath has had a look.

@Dan-Heath Dan-Heath self-assigned this Dec 4, 2024
@Dan-Heath Dan-Heath added the backport/website Backport changes to `stable-website` and the latest release-branch label Dec 4, 2024
Copy link
Contributor

@Dan-Heath Dan-Heath 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 all your work on this @Mohit0233 and @johanbrandhorst ! It makes sense to me. I pushed an update to capitalize Client Agent, but otherwise it LGTM. I will get this published.

@Dan-Heath Dan-Heath merged commit 1cf231a into main Dec 4, 2024
6 checks passed
@Dan-Heath Dan-Heath deleted the docs/client-agent-launchctl-note branch December 4, 2024 20:24
hugoghx pushed a commit that referenced this pull request Dec 6, 2024
…5265)

* docs: clarify behavior of launchctl stop and unload for client agent

* docs: update unload command and clarify permanent disabling of Boundary client agent

* docs: remove "Note" wrapper and clarify unload/reload command for Boundary client agent

* docs: Capitalize Client Agent

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/website Backport changes to `stable-website` and the latest release-branch website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants