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 GCS docs for using keystore #40605

Merged
merged 1 commit into from
Apr 3, 2019

Conversation

rjernst
Copy link
Member

@rjernst rjernst commented Mar 28, 2019

This commit tweaks the wording on using the keystore to store GCS
credentials to note it requires a different key type/command.

closes #39993

This commit tweaks the wording on using the keystore to store GCS
credentials to note it requires a different key type/command.

closes elastic#39993
@rjernst rjernst added >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v7.0.0 v8.0.0 v7.2.0 labels Mar 28, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM.

@@ -88,8 +88,9 @@ A JSON service account file looks like this:
----
// NOTCONSOLE

To provide this file to the plugin, it must be stored in the {ref}/secure-settings.html[Elasticsearch keystore]. You must add a setting name of the form `gcs.client.NAME.credentials_file`, where `NAME`
is the name of the client configuration for the repository. The implicit client
To provide this file to the plugin, it must be stored in the {ref}/secure-settings.html[Elasticsearch keystore]. You must
Copy link
Contributor

@jrodewig jrodewig Mar 29, 2019

Choose a reason for hiding this comment

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

Not blocking, but we can use the {es} attribute instead of Elasticsearch here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure what the {es} attribute is. Can you suggest a specific change to the text?

Copy link
Contributor

Choose a reason for hiding this comment

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

{es} here will expand to Elasticsearch.

Suggested change
To provide this file to the plugin, it must be stored in the {ref}/secure-settings.html[Elasticsearch keystore]. You must
To provide this file to the plugin, it must be stored in the {ref}/secure-settings.html[{es} keystore]. You must

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going to skip this for now, as there are other uses of "Elasticsearch" in this file and I don't want to create an inconsistency.

@rjernst rjernst merged commit ba9ea6a into elastic:master Apr 3, 2019
@rjernst rjernst deleted the gcs_keystore_file_docs branch April 3, 2019 14:21
rjernst added a commit that referenced this pull request Apr 3, 2019
This commit tweaks the wording on using the keystore to store GCS
credentials to note it requires a different key type/command.

closes #39993
rjernst added a commit that referenced this pull request Apr 3, 2019
This commit tweaks the wording on using the keystore to store GCS
credentials to note it requires a different key type/command.

closes #39993
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Apr 3, 2019
…leniency

* elastic/master:
  SQL: Fix deserialisation issue of TimeProcessor (elastic#40776)
  Improve GCS docs for using keystore (elastic#40605)
  Add Restore Operation to SnapshotResiliencyTests (elastic#40634)
  Small refactorings to analysis components (elastic#40745)
  SQL: Fix display size for DATE/DATETIME (elastic#40669)
  add HLRC protocol tests for transform state and stats (elastic#40766)
  Inline TransportReplAction#registerRequestHandlers (elastic#40762)
  remove experimental label from search_as_you_type documentation (elastic#40744)
  Remove some abstractions from `TransportReplicationAction` (elastic#40706)
  Upgrade to latest build scan plugin (elastic#40702)
  Use default memory lock setting in testing (elastic#40730)
  Add Bulk Delete Api to BlobStore (elastic#40322)
  Remove yaml skips older than 7.0 (elastic#40183)
  Docs: Move id in the java-api (elastic#40748)
gurkankaymak pushed a commit to gurkankaymak/elasticsearch that referenced this pull request May 27, 2019
This commit tweaks the wording on using the keystore to store GCS
credentials to note it requires a different key type/command.

closes elastic#39993
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes v7.0.0-rc2 v7.2.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

elasticsearch-keystore add --stdin does not behave like add-file
4 participants