Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You use the console to manage your cluster from a web browser. Tasks that are av

To access the console in a browser from the Heroku CLI:

```term
```bash
heroku addons:open foundelasticsearch --app MY_APP
Opening https://addons-sso.heroku.com/apps/e286f875-cbdb-47a9-b445-e94bnnnnnnnn/addons/9b883e93-3db3-4491-b620-c3dfnnnnnnnn...
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To find which Elasticsearch versions and plugins are currently available, you ca

For example: Install the add-on version 6.8.23 and include the phonetic analysis plugin for MY_APP:

```term
```bash
heroku addons:create foundelasticsearch --elasticsearch-version 6.8.23 --plugins analysis-phonetic --app MY_APP
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ If you prefer to install the add-on through your web browser, go to the [Elastic

To install the latest add-on for MY_APP using the Heroku CLI:

```term
```bash
heroku addons:create foundelasticsearch --app MY_APP
```

After the Elasticsearch Add-On for Heroku gets added, you can find the canonical URL you use to access your newly provisioned cluster in the configuration for the app. Look for the `FOUNDELASTICSEARCH_URL` setting when you grep on the output of the `heroku config` command:

```term
```bash
heroku config --app MY_APP | grep FOUNDELASTICSEARCH_URL
FOUNDELASTICSEARCH_URL: https://74f176887fdef36bb51e6e37nnnnnnnn.us-east-1.aws.found.io
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This action will destroy all associated data and cannot be undone.

To remove the add-on from MY_APP using the Heroku CLI:

```term
```bash
heroku addons:destroy foundelasticsearch --app MY_APP

▸ WARNING: Destructive Action
Expand Down
4 changes: 2 additions & 2 deletions deploy-manage/deploy/elastic-cloud/ech-migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You should time the migration to a new plan to ensure proper application functio

To migrate to a new plan, use the `heroku addons:upgrade` command and include one of the available plans:

```term
```bash
foundelasticsearch:dachs-standard
foundelasticsearch:beagle-standard
foundelasticsearch:dachs-ha
Expand All @@ -33,7 +33,7 @@ foundelasticsearch:husky-ha

For example: Migrate from the smallest, default `dachs-standard` plan to the larger `beagle-ha` plan that includes high availability for MY_APP:

```term
```bash
heroku addons:upgrade foundelasticsearch:beagle-ha --app MY_APP
Changing foundelasticsearch-defined-nnnnn on MY_APP from foundelasticsearch:dachs-standard to foundelasticsearch:beagle-ha... done, $201/month
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you are looking for a user interface for {{es}} and your data, head on over t

To find out what the ELASTICSEARCH_URL is for your {{es}} cluster, grep on the output of the `heroku config` command for your app:

```term
```bash
heroku config --app MY_APP | grep ELASTICSEARCH_URL
ELASTICSEARCH_URL: https://74f176887fdef36bb51e6e37nnnnnnnn.us-east-1.aws.found.io
```
Expand All @@ -31,7 +31,7 @@ To use these examples, you also need to have the [curl](http://curl.haxx.se/) co

To index a document into {{es}}, `POST` your document:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc -XPOST -H 'Content-Type: application/json' -d '{
"title": "One", "tags": ["ruby"]
}'
Expand All @@ -48,7 +48,7 @@ To achieve the best possible performance, use the bulk API.

To index some additional documents with the bulk API:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/_bulk -XPOST -H 'Content-Type: application/json' -d '
{"index": {}}
{"title": "Two", "tags": ["ruby", "python"] }
Expand All @@ -72,7 +72,7 @@ To update an existing document in {{es}}, `POST` the updated document to `http:/

For example, to update the last document indexed from the previous example with `"_id":"06NqhW4BnhCSymaqFHQn"`:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/06NqhW4BnhCSymaqFHQn -XPOST -H 'Content-Type: application/json' -d '{
"title": "Four updated", "tags": ["ruby", "php", "python"]
}'
Expand All @@ -85,7 +85,7 @@ The JSON response shows that the version counter for the document got incremente

To take a look at a specific document you indexed, here the last document we updated with the ID `0KNPhW4BnhCSymaq_3SI`:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/06NqhW4BnhCSymaqFHQn
```

Expand All @@ -96,22 +96,22 @@ This request didn’t include `GET`, as the method is implied if you don’t spe

You issue search requests for documents with one of these {{es}} endpoints:

```term
```bash
https://ELASTICSEARCH_URL/_search
https://ELASTICSEARCH_URL/INDEX_NAME/_search
```

Either a `GET` or a `POST` request with some URI search parameters works, or omit the method to default to `GET` request:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/_search?q=title:T*
```

For an explanation of the allowed parameters, check [URI Search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search).

To make {{es}} return a more human readable JSON response, add `?pretty=true` to the request:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/_search?pretty=true -H 'Content-Type: application/json' -d '{
"query": {
"query_string": {"query": "*"}
Expand All @@ -130,13 +130,13 @@ You delete documents from {{es}} by sending `DELETE` requests.

To delete a single document by ID from an earlier example:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index/_doc/06NqhW4BnhCSymaqFHQn -XDELETE
```

To delete a whole index, here `my_index`:

```term
```bash
curl -u USER:PASSWORD https://ELASTICSEARCH_URL/my_index -XDELETE
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The health monitoring API provides a reliable endpoint that can be monitored. Co

Each {{kib}} instance exposes its own endpoint at:

```kibana
```bash
$ curl -X GET api/task_manager/_health
```

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/remote-clusters/ec-enable-ccs.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The steps, information, and authentication method required to configure CCS and

* [From another deployment of your Elasticsearch Service organization](ec-remote-cluster-same-ess.md)
* [From a deployment of another Elasticsearch Service organization](ec-remote-cluster-other-ess.md)
* [From an ECE deployment](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/ece-enable-ccs.html)
* [From an ECE deployment](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-enable-ccs.html)
* [From a self-managed cluster](https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters.html)


Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/remote-clusters/ec-remote-cluster-ece.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ A deployment can be configured to trust all or specific deployments in a remote

7. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s Security page.
8. Select **Create trust** to complete the configuration.
9. Configure the corresponding deployments of the ECE environment to [trust this deployment](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/ece-enable-ccs.html). You will only be able to connect 2 deployments successfully when both of them trust each other.
9. Configure the corresponding deployments of the ECE environment to [trust this deployment](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-enable-ccs.html). You will only be able to connect 2 deployments successfully when both of them trust each other.

Note that the environment ID and cluster IDs must be entered fully and correctly. For security reasons, no verification of the IDs is possible. If cross-environment trust does not appear to be working, double-checking the IDs is a good place to start.

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/remote-clusters/ece-migrate-ccs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ You can make this change in the user Cloud UI. The only drawback of this method
:class: screenshot
:::

4. Finally, [configure the remote clusters](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/ece-remote-cluster-other-ece.html).
4. Finally, [configure the remote clusters](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-remote-cluster-other-ece.html).

Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ Now, deployments in those environments will be able to configure trust with depl
* Specific deployments - Specify which of the existing deployments you want to trust in the ECE environment. The full Elasticsearch cluster ID must be entered for each remote cluster. The Elasticsearch `Cluster ID` can be found in the deployment overview page under **Applications**.

6. Select **Create trust** to complete the configuration.
7. Configure the corresponding deployments of the ECE environment to [trust this deployment](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/ece-enable-ccs.html). You will only be able to connect 2 deployments successfully when both of them trust each other.
7. Configure the corresponding deployments of the ECE environment to [trust this deployment](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-enable-ccs.html). You will only be able to connect 2 deployments successfully when both of them trust each other.

Note that the environment ID and cluster IDs must be entered fully and correctly. For security reasons, no verification of the IDs is possible. If cross-environment trust does not appear to be working, double-checking the IDs is a good place to start.

::::{dropdown} **Using the API**
You can update a deployment using the appropriate trust settings for the {{es}} payload.

Establishing the trust between the two {{ece}} environments can be done using the [trust relationships API](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/Platform_-_Configuration_-_Trust_relationships.html). For example, the list of trusted environments can be obtained calling the [list trust relationships endpoint](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/get-trust-relationships.html):
Establishing the trust between the two {{ece}} environments can be done using the [trust relationships API](https://www.elastic.co/guide/en/cloud-enterprise/current/Platform_-_Configuration_-_Trust_relationships.html). For example, the list of trusted environments can be obtained calling the [list trust relationships endpoint](https://www.elastic.co/guide/en/cloud-enterprise/current/get-trust-relationships.html):

```sh
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443//api/v1/regions/ece-region/platform/configuration/trust-relationships?include_certificate=false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ TLS certificate

By default, any deployment that you or your users create trusts all other deployments in the same Elastic Cloud Enterprise environment. You can change this behavior in the Cloud UI under **Platform** > **Trust Management**, so that when a new deployment is created it does not automatically trust any other deployment. You can choose one of the following options:

* Trust all my deployments - All of your organization’s deployments created while this option is selected already trust each other. If you keep this option, that includes any deployments you’ll create in the future. You can directly jump to [Connect to the remote cluster](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}/ece-remote-cluster-same-ece.html#ece_connect_to_the_remote_cluster) to finalize the CCS or CCR configuration.
* Trust all my deployments - All of your organization’s deployments created while this option is selected already trust each other. If you keep this option, that includes any deployments you’ll create in the future. You can directly jump to [Connect to the remote cluster](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-remote-cluster-same-ece.html#ece_connect_to_the_remote_cluster) to finalize the CCS or CCR configuration.
* Trust no deployment - New deployments won’t trust any other deployment when they are created. You can instead configure trust individually for each of them in their security settings, as described in the next section.

:::{image} ../../images/cloud-enterprise-ce-environment-trust-management.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Provide your key identifier without the key version identifier so Elastic Cloud
* Get the ARN of the symmetric AWS KMS key or of its alias. Use an alias if you are planning to do manual key rotations as specified in the [AWS documentation](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.md).
* Use these parameters to create a new deployment with the [Elastic Cloud API](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments). For example:

```curl
```bash
curl -XPOST \
-H 'Content-Type: application/json' \
-H "Authorization: ApiKey <replace with encoded API key>" \
Expand Down Expand Up @@ -248,7 +248,7 @@ After you have created the service principal and granted it the necessary permis
* [Get a valid Elastic Cloud API key](https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html) with the **Organization owner** role or the **Admin** role on deployments. These roles allow you to create new deployments.
* Use these parameters to create a new deployment with the [Elastic Cloud API](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments). For example:

```curl
```bash
curl -XPOST \
-H 'Content-Type: application/json' \
-H "Authorization: ApiKey <replace with encoded API key>" \
Expand Down Expand Up @@ -327,7 +327,7 @@ After you have granted the Elastic principals the necessary roles, you can finis
* [Get a valid Elastic Cloud API key](https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html) with the **Organization owner** role or the **Admin** role on deployments. These roles allow you to create new deployments.
* Use these parameters to create a new deployment with the [Elastic Cloud API](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments). For example:

```curl
```bash
curl -XPOST \
-H 'Content-Type: application/json' \
-H "Authorization: ApiKey <replace with encoded API key>" \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You must create a service token to use a service account. You can create a servi
* The [create service account token API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token), which saves the new service token in the `.security` index and returns the bearer token in the HTTP response.
* The [elasticsearch-service-tokens](https://www.elastic.co/guide/en/elasticsearch/reference/current/service-tokens-command.html) CLI tool, which saves the new service token in the `$ES_HOME/config/service_tokens` file and outputs the bearer token to your terminal

We recommend that you create service tokens via the REST API rather than the CLI. The API stores service tokens within the `.security` index which means that the tokens are available for authentication on all nodes, and will be backed up within cluster snapshots. The use of the CLI is intended for cases where there is an external orchestration process (such as [{{ece}}](https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}}) or [{{eck}}](https://www.elastic.co/guide/en/cloud-on-k8s/current)) that will manage the creation and distribution of the `service_tokens` file.
We recommend that you create service tokens via the REST API rather than the CLI. The API stores service tokens within the `.security` index which means that the tokens are available for authentication on all nodes, and will be backed up within cluster snapshots. The use of the CLI is intended for cases where there is an external orchestration process (such as [{{ece}}](https://www.elastic.co/guide/en/cloud-enterprise/current) or [{{eck}}](https://www.elastic.co/guide/en/cloud-on-k8s/current)) that will manage the creation and distribution of the `service_tokens` file.

Both of these methods (API and CLI) create a service token with a guaranteed secret string length of `22`. The minimal, acceptable length of a secret string for a service token is `10`. If the secret string doesn’t meet this minimal length, authentication with {{es}} will fail without even checking the value of the service token.

Expand Down
Loading
Loading