Skip to content

Commit 023936b

Browse files
committed
[DOCS] Updates information on connecting to Cloud
1 parent 2b5910f commit 023936b

File tree

5 files changed

+20
-4
lines changed

5 files changed

+20
-4
lines changed

docs/connecting.asciidoc

+20-4
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ providers.
2323
[[auth-ec]]
2424
==== Elastic Cloud
2525

26-
If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers
27-
an easy way to connect to it. You must pass the Cloud ID that you can find in
28-
the cloud console, then your username and password.
26+
If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers an easy way to connect to it. You need the Cloud ID that you can find in the cloud console, then your username and password.
2927

28+
image::docs/images/cloud_id.png["Cloud ID"]
29+
30+
Once you have collected the Cloud ID you can use the client to connect to your Elastic Cloud instance, as follows:
3031

3132
[source,ruby]
3233
------------------------------------
@@ -39,7 +40,22 @@ client = Elasticsearch::Client.new(
3940
)
4041
------------------------------------
4142

42-
You can also connect to the Cloud by using API Key authentication:
43+
You can also connect to the Cloud by using API Key authentication. You can generate an `API key` in the `Management` page under the section `Security`.
44+
45+
image::docs/images/cloud_api_key.png["API key"]
46+
47+
When you click on `Create API key` you can choose a name and set the other options (eg. restrict privileges, expire after time, etc).
48+
49+
image::docs/images/api_key_name.png["Choose an API name"]
50+
51+
After this step you will get the `API key` in the API keys page.
52+
53+
image::docs/images/cloud_api_key.png["API key"]
54+
55+
**IMPORTANT**: you need to copy and store the `API key`in a secure place, since you will not be able to view it again in Elastic Cloud.
56+
57+
Once you have collected the `Cloud ID` and the `API key` you can use the client
58+
to connect to your Elastic Cloud instance, as follows:
4359

4460
[source,ruby]
4561
------------------------------------

docs/images/api_key_name.png

32 KB
Loading

docs/images/cloud_api_key.png

117 KB
Loading

docs/images/cloud_id.png

163 KB
Loading

docs/images/create_api_key.png

78.7 KB
Loading

0 commit comments

Comments
 (0)