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

Update Agent static install on macOS topic #4006

Merged
merged 6 commits into from
May 31, 2023

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented May 29, 2023

PR Description

Updated the Agent install on macOS topic

  • Reorganized content and cleaned up existing documentation
  • Aligned a bit better with Agent Flow on macOS content

TODO:

  • Fill in missing information for binary install steps - removed ref to binary install
  • Expose UI section from flow is not included in static, is it applicable to static? No change

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG updated
  • Documentation added
  • Tests updated

@clayton-cornell clayton-cornell added type/docs Docs Squad label across all Grafana Labs repos backport release-v0.33 labels May 29, 2023
@clayton-cornell clayton-cornell self-assigned this May 29, 2023
@clayton-cornell
Copy link
Contributor Author

@rfratto The Agent static install steps do not cover the binary install. Do we need this? Also the Flow docs detail exposing the UI to other machines. Is this applicable to Static or a Flow-only thing?

@rfratto
Copy link
Member

rfratto commented May 30, 2023

The Agent static install steps do not cover the binary install. Do we need this?

What binary install are you referring to here?

Also the Flow docs detail exposing the UI to other machines. Is this applicable to Static or a Flow-only thing?

That's Flow-only, there's no web UI in static mode.

@clayton-cornell
Copy link
Contributor Author

@rfratto the original text has a line You can also install Grafana Agent on macOS using the macOS binary. GitHub has grafana-agent-darwin-amd64.zip which is what I'm guessing this line is referring to?

@rfratto
Copy link
Member

rfratto commented May 30, 2023

@rfratto the original text has a line You can also install Grafana Agent on macOS using the macOS binary. GitHub has grafana-agent-darwin-amd64.zip which is what I'm guessing this line is referring to?

Ah. Yeah, that's what it was referring to. I'm tempted to say we should remove it so that we only document one preferred option for installing on macOS. What do you think?

@clayton-cornell
Copy link
Contributor Author

@rfratto I agree. I've removed the note about the binary version. It's no just the Homebrew solution - one other point in the Homebrew steps.. there's a note about v2 and v3 Homebrew. I question if we need this. Homebrew is on v4 now and v3 was released in Feb 2021. Is it safe to assume everyone would most likely be on at least v3.x by now? and we could simplify by removing the references to v2?

@rfratto
Copy link
Member

rfratto commented May 30, 2023

and we could simplify by removing the references to v2?

Yes, this makes sense to me 👍

@clayton-cornell clayton-cornell enabled auto-merge (squash) May 30, 2023 21:58
@clayton-cornell clayton-cornell merged commit 274af0d into main May 31, 2023
@clayton-cornell clayton-cornell deleted the doc/update_static_install_osx branch May 31, 2023 12:31
grafanabot pushed a commit that referenced this pull request May 31, 2023
* Reorganize content and fix typos

* Remove note about binary install

* Remove obsolete v2 homebrew note

* Small simplification of sentences

(cherry picked from commit 274af0d)
clayton-cornell added a commit that referenced this pull request May 31, 2023
* Reorganize content and fix typos

* Remove note about binary install

* Remove obsolete v2 homebrew note

* Small simplification of sentences

(cherry picked from commit 274af0d)

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
clayton-cornell added a commit that referenced this pull request Aug 14, 2023
* Reorganize content and fix typos

* Remove note about binary install

* Remove obsolete v2 homebrew note

* Small simplification of sentences
clayton-cornell added a commit that referenced this pull request Aug 14, 2023
* Reorganize content and fix typos

* Remove note about binary install

* Remove obsolete v2 homebrew note

* Small simplification of sentences
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 23, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.33 frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants