Skip to content

Commit 34f25a0

Browse files
committed
Update docs to use "project" instead of "cluster" or "node" where reasonable
1 parent 75d1e7c commit 34f25a0

File tree

6 files changed

+20
-24
lines changed

6 files changed

+20
-24
lines changed

docs/guide/configuration.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,38 @@ The options in this section will only be necessary when connecting to Elasticsea
1313
[discrete]
1414
==== Verifying certificates
1515

16-
The typical route to verify a cluster certificate is via a "CA bundle" which can be specified via the `ca_certs` parameter. If no options are given and the https://github.com/certifi/python-certifi[certifi package] is installed then certifi's CA bundle is used by default.
16+
The typical route to verify a certificate is via a "CA bundle" which can be specified via the `ca_certs` parameter. If no options are given and the https://github.com/certifi/python-certifi[certifi package] is installed then certifi's CA bundle is used by default.
1717

1818
If you have your own CA bundle to use you can configure via the `ca_certs` parameter:
1919

2020
[source,python]
2121
------------------------------------
2222
es = Elasticsearch(
23-
cloud_id='deployment-name:ABCD...',
23+
cloud_id='project-name:ABCD...',
2424
ca_certs="/path/to/certs.pem"
2525
)
2626
------------------------------------
2727

2828
If using a generated certificate or certificate with a known fingerprint you can use the `ssl_assert_fingerprint` to specify the fingerprint which tries to match the server's leaf certificate during the TLS handshake. If there is any matching certificate the connection is verified, otherwise a `TlsError` is raised.
2929

30-
In Python 3.9 and earlier only the leaf certificate will be verified but in Python 3.10+ private APIs are used to verify any certificate in the certificate chain. This helps when using certificates that are generated on a multi-node cluster.
30+
In Python 3.9 and earlier only the leaf certificate will be verified but in Python 3.10+ private APIs are used to verify any certificate in the certificate chain.
3131

3232
[source,python]
3333
------------------------------------
3434
es = Elasticsearch(
35-
cloud_id='deployment-name:ABCD...',
35+
cloud_id='project-name:ABCD...',
3636
ssl_assert_fingerprint=(
3737
"315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3"
3838
)
3939
)
4040
------------------------------------
4141

42-
To disable certificate verification use the `verify_certs=False` parameter. This option should be avoided in production, instead use the other options to verify the clusters' certificate.
42+
To disable certificate verification use the `verify_certs=False` parameter. This option should be avoided in production, instead use the other options to verify the certificate.
4343

4444
[source,python]
4545
------------------------------------
4646
es = Elasticsearch(
47-
cloud_id='deployment-name:ABCD...',
47+
cloud_id='project-name:ABCD...',
4848
verify_certs=False
4949
)
5050
------------------------------------
@@ -117,7 +117,7 @@ es = Elasticsearch(
117117
[[timeouts]]
118118
=== Request timeouts
119119

120-
Requests can be configured to timeout if taking too long to be serviced. The `request_timeout` parameter can be passed via the client constructor or the client `.options()` method. When the request times out the node will raise a `ConnectionTimeout` exception which can trigger retries.
120+
Requests can be configured to timeout if taking too long to be serviced. The `request_timeout` parameter can be passed via the client constructor or the client `.options()` method. When the request times out the project will raise a `ConnectionTimeout` exception which can trigger retries.
121121

122122
Setting `request_timeout` to `None` will disable timeouts.
123123

@@ -305,7 +305,7 @@ es = Elasticsearch(
305305
[discrete]
306306
==== HTTP connections
307307

308-
The client maintains a pool of HTTP connections to the Elasticsearch Serverless instance to allow for concurrent requests. This value is configurable via the `connections` parameter:
308+
The client maintains a pool of HTTP connections to the Elasticsearch Serverless project to allow for concurrent requests. This value is configurable via the `connections` parameter:
309309

310310
[source,python]
311311
------------------------------------

docs/guide/connecting.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html[Elastic Cl
1111
is the easiest way to get started with {es}. When connecting to Elastic Cloud
1212
with the Python {es} client you should always use the `cloud_id`
1313
parameter to connect. You can find this value within the "Manage Deployment"
14-
page after you've created a cluster (look in the top-left if you're in Kibana).
14+
page after you've created a project (look in the top-left if you're in Kibana).
1515

1616
We recommend using a Cloud ID whenever possible because your client will be
1717
automatically configured for optimal use with Elastic Cloud including HTTPS and
@@ -22,9 +22,9 @@ HTTP compression.
2222
from elasticsearch_serverless import Elasticsearch
2323
2424
# Found in the 'Manage Deployment' page
25-
CLOUD_ID = "deployment-name:dXMtZWFzdDQuZ2Nw..."
25+
CLOUD_ID = "project-name:dXMtZWFzdDQuZ2Nw..."
2626
27-
# Create the client instance
27+
# Create the client project
2828
client = Elasticsearch(
2929
cloud_id=CLOUD_ID,
3030
api_key=("api-key-id", "api-key-secret")
@@ -72,7 +72,7 @@ from elasticsearch_serverless import Elasticsearch
7272
7373
# Client initialization
7474
client = Elasticsearch(
75-
cloud_id="deployment-name:ABCD...",
75+
cloud_id="project-name:ABCD...",
7676
api_key=...
7777
)
7878
@@ -92,7 +92,7 @@ from elasticsearch_serverless import Elasticsearch
9292
9393
# Client initialization
9494
client = Elasticsearch(
95-
cloud_id="deployment-name:ABCD...",
95+
cloud_id="project-name:ABCD...",
9696
api_key=...
9797
)
9898
@@ -113,7 +113,7 @@ from elasticsearch_serverless import Elasticsearch
113113
114114
# Client initialization
115115
client = Elasticsearch(
116-
cloud_id="deployment-name:ABCD...",
116+
cloud_id="project-name:ABCD...",
117117
api_key=...
118118
)
119119

docs/guide/examples.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To index a document, you need to specify three pieces of information: `index`,
2222
----------------------------
2323
from datetime import datetime
2424
from elasticsearch_serverless import Elasticsearch
25-
es = Elasticsearch(cloud_id='deployment-name:ABCD...')
25+
es = Elasticsearch(cloud_id='project-name:ABCD...')
2626
2727
doc = {
2828
'author': 'author_name',
@@ -86,7 +86,7 @@ To update a document, you need to specify three pieces of information: `index`,
8686
from datetime import datetime
8787
from elasticsearch_serverless import Elasticsearch
8888
89-
client = Elasticsearch(cloud_id='deployment-name:ABCD...')
89+
client = Elasticsearch(cloud_id='project-name:ABCD...')
9090
9191
doc = {
9292
'author': 'author_name',

docs/guide/getting-started.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ endpoint.
3535
from elasticsearch_serverless import Elasticsearch
3636
3737
client = Elasticsearch(
38-
cloud_id="deployment-name:ABCD...", # Cloud ID provided by Elastic
38+
cloud_id="project-name:ABCD...", # Cloud ID provided by Elastic
3939
api_key=('api-key-id', 'api-key-secret'), # API key ID and secret
4040
)
4141
----
4242

4343
Your Elasticsearch endpoint can be found on the **My deployment** page of your
44-
deployment:
44+
project:
4545

4646
image::images/es-endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"]
4747

docs/guide/overview.asciidoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,9 @@ The client's features include:
4646

4747
* Translating basic Python data types to and from JSON
4848

49-
* Configurable automatic discovery of cluster nodes
50-
5149
* Persistent connections
5250

53-
* Load balancing (with pluggable selection strategy) across all available nodes
54-
55-
* Node timeouts on transient errors
51+
* Timeouts on transient errors
5652

5753
* Thread safety
5854

docs/guide/release-notes.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[release-notes]]
22
== Release notes
33

4-
=== 0.1.0+20231031
4+
=== 0.1.0.20231031
55

66
Initial release

0 commit comments

Comments
 (0)