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

Improve the deployment elasticsearch keystore documentation #507

Closed
marclop opened this issue Aug 31, 2021 · 1 comment · Fixed by #508
Closed

Improve the deployment elasticsearch keystore documentation #507

marclop opened this issue Aug 31, 2021 · 1 comment · Fixed by #508
Assignees
Labels
documentation Improvements or additions to documentation Team:Delivery

Comments

@marclop
Copy link
Collaborator

marclop commented Aug 31, 2021

Description

The current ecctl help for the keystore commands isn't very good and leads to users of ecctl being confused as to what the exact format of the specified file should be.

$ ecctl deployment elasticsearch keystore set -h
Changes the contents of the Elasticsearch resource keystore from the
specified deployment by using the PATCH method. The payload is a partial payload where
any ignored current keystore items are not removed, unless the secrets are
set to "null": {"secrets": {"my-secret": null}}.

Usage:
  ecctl deployment elasticsearch keystore update <deployment id> [--ref-id <ref-id>] {--file=<filename>.json} [flags]

Aliases:
  update, set

Flags:
  -p, --file string     Required json formatted file path with the keystore secret contents.
  -h, --help            help for update
      --ref-id string   Optional ref_id to use for the Elasticsearch resource, auto-discovered if not specified.

Implementation

We should at least add a couple of examples to the documentation and define the expected file format.

References

@marclop marclop added documentation Improvements or additions to documentation Team:Delivery labels Aug 31, 2021
@marclop marclop self-assigned this Aug 31, 2021
@marclop
Copy link
Collaborator Author

marclop commented Aug 31, 2021

Just noticed that the shorthand --file flag is incorrectly set to -p, I'll fix it in the same PR to be -f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Team:Delivery
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant