Skip to content

Commit

Permalink
restore keystore section in command reference
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Nov 27, 2023
1 parent 1479581 commit d4e9212
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 2 deletions.
63 changes: 63 additions & 0 deletions docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ ifdef::serverless[]
endif::serverless[]

:help-command-short-desc: Shows help for any command
:keystore-command-short-desc: Manages the <<keystore,secrets keystore>>
:modules-command-short-desc: Manages configured modules
:package-command-short-desc: Packages the configuration and executable into a zip file
:remove-command-short-desc: Removes the specified function from your serverless environment
Expand Down Expand Up @@ -106,6 +107,9 @@ ifdef::apm-server[]
endif::[]
|<<export-command,`export`>> |{export-command-short-desc}.
|<<help-command,`help`>> |{help-command-short-desc}.
ifndef::serverless[]
|<<keystore-command,`keystore`>> |{keystore-command-short-desc}.
endif::[]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<package-command,`package`>> |{package-command-short-desc}.
|<<remove-command,`remove`>> |{remove-command-short-desc}.
Expand Down Expand Up @@ -430,6 +434,65 @@ Specifies the name of the command to show help for.
{beatname_lc} help export
-----

ifndef::serverless[]
[float]
[[keystore-command]]
==== `keystore` command

{keystore-command-short-desc}.

*SYNOPSIS*

["source","sh",subs="attributes"]
----
{beatname_lc} keystore SUBCOMMAND [FLAGS]
----

*`SUBCOMMAND`*

*`add KEY`*::
Adds the specified key to the keystore. Use the `--force` flag to overwrite an
existing key. Use the `--stdin` flag to pass the value through `stdin`.

*`create`*::
Creates a keystore to hold secrets. Use the `--force` flag to overwrite the
existing keystore.

*`list`*::
Lists the keys in the keystore.

*`remove KEY`*::
Removes the specified key from the keystore.

*FLAGS*

*`--force`*::
Valid with the `add` and `create` subcommands. When used with `add`, overwrites
the specified key. When used with `create`, overwrites the keystore.

*`--stdin`*::
When used with `add`, uses the stdin as the source of the key's value.

*`-h, --help`*::
Shows help for the `keystore` command.


{global-flags}

*EXAMPLES*

["source","sh",subs="attributes"]
-----
{beatname_lc} keystore create
{beatname_lc} keystore add ES_PWD
{beatname_lc} keystore remove ES_PWD
{beatname_lc} keystore list
-----

See <<keystore>> for more examples.

endif::[]

ifeval::["{beatname_lc}"=="functionbeat"]
[float]
[[package-command]]
Expand Down
4 changes: 2 additions & 2 deletions docs/keystore.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ name, the APM Server keystore lets you specify arbitrary names that you can
reference in the APM Server configuration.

To create and manage keys, use the `keystore` command.
// See the <<keystore-command,command reference>> for the full command syntax,
// including optional flags.
See the <<keystore-command,command reference>> for the full command syntax,
including optional flags.

NOTE: The `keystore` command must be run by the same user who will run
APM Server.
Expand Down

0 comments on commit d4e9212

Please sign in to comment.