Skip to content

Commit 6518877

Browse files
authored
docs: change to specify that ecctl is no longer ECE specific (#190)
Documentation change to specify that ecctl is no longer ECE specific. The docs have also been slightly modified to cater to our largest user base which will be ESS.
1 parent 167b041 commit 6518877

File tree

2 files changed

+9
-25
lines changed

2 files changed

+9
-25
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
NOTE: **You are looking at the documentation for a beta release. Please keep in mind that backwards-incompatible changes might be introduced in future releases.**
66

7-
`ecctl` is the CLI on steroids for the Elastic Cloud Enterprise API. It wraps typical operations commonly needed by ECE operators within a single command line tool.
7+
`ecctl` is the CLI on steroids for the Elasticsearch Service and Elastic Cloud Enterprise APIs. It wraps typical operations commonly needed by operators within a single command line tool.
88

9-
The goal of this project is to provide an easier way to interact with the ECE API, ensuring each one of the provided commands is thoroughly tested.
10-
11-
Note that, right now, `ecctl` targets ECE installations only. There are, however, plans to support public Elasticsearch Service API in the future.
9+
The goal of this project is to provide an easier way to interact with the Elasticsearch Service and Elastic Cloud Enterprise APIs, ensuring each one of the provided commands is thoroughly tested.
1210

1311
To get started with Elastic Cloud Control, see the [official documentation](https://www.elastic.co/guide/en/ecctl/current/index.html).
1412

docs/ecctl-getting-started.asciidoc

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,15 @@
33

44
beta[]
55

6-
{p} is the CLI on steroids for the Elastic Cloud Enterprise API. It wraps
7-
typical operations commonly needed by ECE operators within a
8-
single command line tool.
6+
{p} is the CLI on steroids for the Elasticsearch Service and Elastic Cloud Enterprise APIs.
7+
It wraps typical operations commonly needed by operators within a single command line tool.
98

109
Benefits of {p}:
1110

1211
* Easier to use than the Cloud UI or using the RESTful API directly
1312
* Helps you automate the deployment lifecycle
1413
* Provides a foundation for integration with other tools, such as Terraform and Ansible
1514

16-
Right now, {p} supports ECE installations only.
17-
18-
//, but we plan to support a public Elasticsearch Service API in the future.
19-
2015
[id="{p}-installing"]
2116
== Installing
2217

@@ -123,21 +118,14 @@ Please enter your choice: 1
123118
124119
Using "https://api.elastic-cloud.com" as the API endpoint.
125120
121+
Paste your API Key and press enter: xxxxx
122+
126123
What default output format would you like?
127124
[1] text - Human-readable output format, commands with no output templates defined will fall back to JSON.
128125
[2] json - JSON formatted output API responses.
129126
130127
Please enter a choice: 1
131128
132-
133-
Which authentication mechanism would you like to use?
134-
[1] API Keys (Recommended).
135-
[2] Username and Password login.
136-
137-
Please enter your choice: 1
138-
139-
Paste your API Key and press enter: xxxxx
140-
141129
Your credentials seem to be valid, and show you're authenticated as "user".
142130
143131
You're all set! Here is a command to try:
@@ -151,7 +139,7 @@ Elastic Cloud uses API keys to authenticate users against its API.
151139
Additionally, it supports the usage of https://jwt.io/[JWT] to validate
152140
authenticated clients. The preferred authentication method is API keys.
153141

154-
There are two ways to authenticate against the Elastic Cloud API using
142+
There are two ways to authenticate against the Elasticsearch Service or the Elastic Cloud Enterprise APIs
155143
{p}:
156144

157145
* By specifying an API key using the `--apikey` flag
@@ -176,7 +164,7 @@ the binary for Elastic Cloud:
176164

177165
[source,yaml]
178166
----
179-
host: https://api.elastic-cloud.com # URL of your ECE API endpoint
167+
host: https://api.elastic-cloud.com # URL of your Elasticsearch Service or Elastic Cloud Enterprise API endpoint
180168
181169
# Credentials
182170
## apikey is the preferred authentication mechanism.
@@ -327,10 +315,8 @@ $ unset EC_FORMAT
327315

328316
{n} includes commands to administer:
329317

330-
* Platform components
331-
* Platform authentication
332-
* Platform users
333318
* Elastic Stack deployments
319+
* Platform components
334320
* And more
335321

336322
:leveloffset: +1

0 commit comments

Comments
 (0)