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.

Sign up for GitHub

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] Explain how to set the data path for CM enrollment on windows #10503

Merged
merged 1 commit into from
Feb 7, 2019
Merged

[Docs] Explain how to set the data path for CM enrollment on windows #10503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions libbeat/docs/shared-central-management.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,33 @@ The URL of the {kib} instance you will use for central management.
The enrollment token generated by the {cm-ui} UI. The enrollment token will
expire as soon as it's used.

For example:
["source","shell",subs="attributes"]
----------------------------------------------------------------------
{beatname_lc} enroll http://xyz.gov:5601 70f4b584e8024b96b682c46125a8d81
----------------------------------------------------------------------

Repeat this process to enroll additional {beats}.

// Maintainers: If you update the following note, also update the note that
// appears later in this file.

[IMPORTANT]
=====
*Windows users:* If you installed {beatname_uc} as a service, you must also set
`-path.data` to +"C:{backslash}ProgramData{backslash}{beatname_lc}"+ when you
run the enroll command. For example:

+.{backslash}{beatname_lc}.exe enroll http://xyz.gov:5601 70f4b584e8024b96b682c46125a8d81a
-path.data "C:{backslash}ProgramData{backslash}{beatname_lc}"+

Why? The service installation script, +install-service-{beatname_lc}.ps1+,
changes the default data path to match the convention used for Windows. If you
run the enroll command without specifying the correct data path, {beatname_uc}
will be enrolled in central management with the wrong UUID and unable to receive
the configuration.
=====

[float]
[[username-password-enrollment]]
=== Username and password-based enrollment
Expand All @@ -203,6 +228,30 @@ The method to use for getting the password. Available options are:
*`--force`*::
Overwrites the current settings without asking for confirmation.

For example:

["source","shell",subs="attributes"]
----------------------------------------------------------------------
{beatname_lc} enroll http://xyz.gov:5601 --username myuser --password stdin
----------------------------------------------------------------------

[IMPORTANT]
=====
*Windows users:* If you installed {beatname_uc} as a service, you must also set
`-path.data` to +"C:{backslash}ProgramData{backslash}{beatname_lc}"+ when you
run the enroll command. For example:

+.{backslash}{beatname_lc}.exe enroll http://xyz.gov:5601 --username myuser --password stdin
-path.data "C:{backslash}ProgramData{backslash}{beatname_lc}"+

Why? The service installation script, +install-service-{beatname_lc}.ps1+,
changes the default data path to match the convention used for Windows. If you
run the enroll command without specifying the correct data path, {beatname_uc}
will be enrolled in central management with the wrong UUID and unable to receive
the configuration.
=====



//[[central-management-API]]
//== Enrollment API (not documented for beta)
Expand Down