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 Elastic Agent command reference with Fleet Server flags #667

Merged
merged 16 commits into from
May 25, 2021

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented May 14, 2021

Closes #527

Adds fleet server-related settings to the CLI docs. Note that we will also have a topic that explores custom certificates in more detail. This content is meant to be quick reference info.

TODO:

@blakerouse Can you provide some realistic examples that show the certs-related flags? (It's nice to show full commands with dummy values.

@dedemorton dedemorton added the docs Improvements or additions to documentation label May 14, 2021
@dedemorton dedemorton self-assigned this May 14, 2021
@dedemorton dedemorton requested a review from a team as a code owner May 14, 2021 02:54
@apmmachine
Copy link
Contributor

apmmachine commented May 14, 2021

A documentation preview will be available soon:

@dedemorton dedemorton changed the title Issue#527 Update Elastic Agent command reference with Fleet Server flags May 14, 2021
@dedemorton
Copy link
Contributor Author

I've taken this as far as I can without input from development. I think we need more details and examples for the enroll/install flags related to passing certs.

@dedemorton dedemorton requested review from blakerouse and ph May 14, 2021 17:53
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Outdated Show resolved Hide resolved
docs/en/ingest-management/commands.asciidoc Show resolved Hide resolved
@dedemorton
Copy link
Contributor Author

@EricDavisX @blakerouse Can I get one of you to approve? Would like to get this merged asap. Thanks!

Copy link
Contributor

@EricDavisX EricDavisX left a comment

Choose a reason for hiding this comment

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

i made some suggestions, but it is great content as is and can be merged as is and iterated on later as desired

@dedemorton dedemorton merged commit 8005ef2 into elastic:master May 25, 2021
@dedemorton dedemorton deleted the issue#527 branch May 25, 2021 17:37
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request May 25, 2021
…ic#667)

* Update command reference with new fleet commands

* remove todo

* Add more detail about cert-related flags

* Mention install command in the line about the root user

Co-authored-by: Eric Davis <[email protected]>

* Make it clear that you are required to enroll after installing from deb/rpm

Co-authored-by: Eric Davis <[email protected]>

* Mention that installing as a service is more common than enrolling

* Clarify that the enroll command can be used to enroll an agent in a different policy

* Clarify what you can do with enroll command

* Change order of flags and optionality in the command sytnax

Co-authored-by: Eric Davis <[email protected]>

* Change order of flags and optionality in the command syntax

Co-authored-by: Eric Davis <[email protected]>

* Remove outdated info about passing username/password in URL

* Finalize command reference with updates from review

* Add links to related docs

* Apply suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Apply additional suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Remove redundant wording

Co-authored-by: Eric Davis <[email protected]>
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request May 25, 2021
…ic#667)

* Update command reference with new fleet commands

* remove todo

* Add more detail about cert-related flags

* Mention install command in the line about the root user

Co-authored-by: Eric Davis <[email protected]>

* Make it clear that you are required to enroll after installing from deb/rpm

Co-authored-by: Eric Davis <[email protected]>

* Mention that installing as a service is more common than enrolling

* Clarify that the enroll command can be used to enroll an agent in a different policy

* Clarify what you can do with enroll command

* Change order of flags and optionality in the command sytnax

Co-authored-by: Eric Davis <[email protected]>

* Change order of flags and optionality in the command syntax

Co-authored-by: Eric Davis <[email protected]>

* Remove outdated info about passing username/password in URL

* Finalize command reference with updates from review

* Add links to related docs

* Apply suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Apply additional suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Remove redundant wording

Co-authored-by: Eric Davis <[email protected]>
dedemorton added a commit that referenced this pull request May 25, 2021
…#711)

* Update command reference with new fleet commands

* remove todo

* Add more detail about cert-related flags

* Mention install command in the line about the root user

Co-authored-by: Eric Davis <[email protected]>

* Make it clear that you are required to enroll after installing from deb/rpm

Co-authored-by: Eric Davis <[email protected]>

* Mention that installing as a service is more common than enrolling

* Clarify that the enroll command can be used to enroll an agent in a different policy

* Clarify what you can do with enroll command

* Change order of flags and optionality in the command sytnax

Co-authored-by: Eric Davis <[email protected]>

* Change order of flags and optionality in the command syntax

Co-authored-by: Eric Davis <[email protected]>

* Remove outdated info about passing username/password in URL

* Finalize command reference with updates from review

* Add links to related docs

* Apply suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Apply additional suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Remove redundant wording

Co-authored-by: Eric Davis <[email protected]>

Co-authored-by: Eric Davis <[email protected]>
dedemorton added a commit that referenced this pull request May 25, 2021
…#710)

* Update command reference with new fleet commands

* remove todo

* Add more detail about cert-related flags

* Mention install command in the line about the root user

Co-authored-by: Eric Davis <[email protected]>

* Make it clear that you are required to enroll after installing from deb/rpm

Co-authored-by: Eric Davis <[email protected]>

* Mention that installing as a service is more common than enrolling

* Clarify that the enroll command can be used to enroll an agent in a different policy

* Clarify what you can do with enroll command

* Change order of flags and optionality in the command sytnax

Co-authored-by: Eric Davis <[email protected]>

* Change order of flags and optionality in the command syntax

Co-authored-by: Eric Davis <[email protected]>

* Remove outdated info about passing username/password in URL

* Finalize command reference with updates from review

* Add links to related docs

* Apply suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Apply additional suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Remove redundant wording

Co-authored-by: Eric Davis <[email protected]>

Co-authored-by: Eric Davis <[email protected]>
bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 11, 2023
…ic#667)

* Update command reference with new fleet commands

* remove todo

* Add more detail about cert-related flags

* Mention install command in the line about the root user

Co-authored-by: Eric Davis <[email protected]>

* Make it clear that you are required to enroll after installing from deb/rpm

Co-authored-by: Eric Davis <[email protected]>

* Mention that installing as a service is more common than enrolling

* Clarify that the enroll command can be used to enroll an agent in a different policy

* Clarify what you can do with enroll command

* Change order of flags and optionality in the command sytnax

Co-authored-by: Eric Davis <[email protected]>

* Change order of flags and optionality in the command syntax

Co-authored-by: Eric Davis <[email protected]>

* Remove outdated info about passing username/password in URL

* Finalize command reference with updates from review

* Add links to related docs

* Apply suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Apply additional suggestions from code review

Co-authored-by: Eric Davis <[email protected]>

* Remove redundant wording

Co-authored-by: Eric Davis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document new Fleet server CLI options
4 participants