Skip to content

Commit

Permalink
replace asciidocalypse elasticsearch-java links
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Feb 28, 2025
1 parent 69766d0 commit f2e9be3
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Custom aliases for your deployment endpoints on Elastic Cloud Enterprise allow y
Before setting up your custom alias, your platform administrator must enable the feature. Check [Enable custom endpoint aliases](enable-custom-endpoint-aliases.md) for more information.


## Create a custom endpoint alias for a deployment [ece-create-regional-deployment-alias]
## Create a custom endpoint alias for a deployment [ece-create-regional-deployment-alias]

To add an alias to an existing deployment:

Expand All @@ -19,14 +19,14 @@ To add an alias to an existing deployment:
3. Under **Custom endpoint alias**, select **Edit**.
4. Define a new alias. Make sure you choose something meaningful to you.

::::{tip}
::::{tip}
Make the alias as unique as possible to avoid collisions. Aliases might have been already claimed by other users for deployments in the region.
::::

5. Select **Update alias**.


## Remove a custom endpoint alias [ece-delete-regional-deployment-alias]
## Remove a custom endpoint alias [ece-delete-regional-deployment-alias]

To remove an alias from your deployment, or if you want to re-assign an alias to another deployment, follow these steps:

Expand All @@ -37,17 +37,17 @@ To remove an alias from your deployment, or if you want to re-assign an alias to
5. Select **Update alias**.


## Using the custom endpoint URL [ece-using-regional-deployment-alias]
## Using the custom endpoint URL [ece-using-regional-deployment-alias]

To use your new custom endpoint URL to access your Elastic products, note that each has its own alias to use in place of the default application UUID. For example, if you configured the custom endpoint alias for your deployment to be `test-alias`, the corresponding alias for the Elasticsearch cluster in that deployment is `test-alias.es`.

::::{note}
::::{note}
You can get the application-specific custom endpoint alias by selecting **Copy endpoint** for that product. It should contain a subdomain for each application type, for example `es`, `kb`, `apm`, or `ent`.
::::



### With the REST Client [ece-rest-regional-deployment-alias]
### With the REST Client [ece-rest-regional-deployment-alias]

* As part of the host name:

Expand All @@ -61,7 +61,7 @@ You can get the application-specific custom endpoint alias by selecting **Copy e
For more information on setting up a load balancer to ensure proper routing, check [Load balancers](ece-load-balancers.md).


### With the `TransportClient` [ece-transport-regional-deployment-alias]
### With the `TransportClient` [ece-transport-regional-deployment-alias]

While the `TransportClient` is deprecated, your custom endpoint aliases still work with it. Similar to the REST Client, there are two ways to use your custom endpoint alias with the `TransportClient`:

Expand Down Expand Up @@ -99,5 +99,5 @@ While the `TransportClient` is deprecated, your custom endpoint aliases still wo
```


For more information on configuring the `TransportClient`, see [Configure the Java Transport Client](asciidocalypse://docs/elasticsearch-java/docs/reference/index.md).
For more information on configuring the `TransportClient`, see [Configure the Java Transport Client](elasticsearch-java://reference/index.md).

8 changes: 4 additions & 4 deletions deploy-manage/security/httprest-clients-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Authorization: Basic <TOKEN> <1>
Alternatively, you can use [token-based authentication services](../users-roles/cluster-or-deployment-auth/token-based-authentication-services.md).


## Client examples [http-clients-examples]
## Client examples [http-clients-examples]

This example uses `curl` without basic auth to create an index:

Expand Down Expand Up @@ -45,7 +45,7 @@ curl --user rdeniro:taxidriver -XPUT 'localhost:9200/idx'
```


## Secondary authorization [http-clients-secondary-authorization]
## Secondary authorization [http-clients-secondary-authorization]

Some APIs support secondary authorization headers for situations where you want tasks to run with a different set of credentials. For example, you can send the following header in addition to the basic authentication header:

Expand All @@ -66,11 +66,11 @@ es-secondary-authorization: ApiKey <TOKEN> <1>



## Client libraries over HTTP [http-clients-libraries]
## Client libraries over HTTP [http-clients-libraries]

For more information about using {{security-features}} with the language specific clients, refer to:

* [Java](asciidocalypse://docs/elasticsearch-java/docs/reference/_basic_authentication.md)
* [Java](elasticsearch-java://reference/_basic_authentication.md)
* [JavaScript](asciidocalypse://docs/elasticsearch-js/docs/reference/connecting.md)
* [.NET](asciidocalypse://docs/elasticsearch-net/docs/reference/configuration.md)
* [Perl](https://metacpan.org/pod/Search::Elasticsearch::Cxn::HTTPTiny#CONFIGURATION)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ Security


Connections ({{ech}} only)
: If your application connecting to {{ech}} runs under the Java security manager, you should at least disable the caching of positive hostname resolutions. To learn more, check the [Java API Client documentation](asciidocalypse://docs/elasticsearch-java/docs/reference/_others.md).
: If your application connecting to {{ech}} runs under the Java security manager, you should at least disable the caching of positive hostname resolutions. To learn more, check the [Java API Client documentation](elasticsearch-java://reference/_others.md).

Schema
: When the example code was run an index mapping was created automatically. The field types were selected by {{es}} based on the content seen when the first record was ingested, and updated as new fields appeared in the data. It would be more efficient to specify the fields and field types in advance to optimize performance. Refer to the Elastic Common Schema documentation and Field Type documentation when you are designing the schema for your production use cases.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Security


Connections
: If your application connecting to {{ech}} runs under the Java security manager, you should at least disable the caching of positive hostname resolutions. To learn more, check the [Java API Client documentation](asciidocalypse://docs/elasticsearch-java/docs/reference/_others.md).
: If your application connecting to {{ech}} runs under the Java security manager, you should at least disable the caching of positive hostname resolutions. To learn more, check the [Java API Client documentation](elasticsearch-java://reference/_others.md).

Schema
: When the example code was run an index mapping was created automatically. The field types were selected by {{es}} based on the content seen when the first record was ingested, and updated as new fields appeared in the data. It would be more efficient to specify the fields and field types in advance to optimize performance. Refer to the Elastic Common Schema documentation and Field Type documentation when you are designing the schema for your production use cases.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Minor version upgrades, upgrades from 8.17 to 9.0.0-beta1, and cluster configura

If you use a separate [monitoring deployment](../../../deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md), you should upgrade the monitoring deployment before the production deployment. In general, the monitoring deployment and the deployments being monitored should be running the same version of the Elastic Stack. A monitoring deployment cannot monitor production deployments running newer versions of the stack. If necessary, the monitoring deployment can monitor production deployments running the latest release of the previous major version.

::::{important}
::::{important}
Although it’s simple to upgrade an Elastic Cloud deployment, the new version might include breaking changes that affect your application. Make sure you review the deprecation logs, make any necessary changes, and test against the new version before upgrading your production deployment.
::::

Expand Down Expand Up @@ -43,7 +43,7 @@ Security realm settings



## Perform the upgrade [perform-cloud-upgrade]
## Perform the upgrade [perform-cloud-upgrade]

Log in to your Elastic Cloud environment:

Expand Down Expand Up @@ -230,23 +230,23 @@ To upgrade a deployment:
2. Select version 9.0.0-beta1.
3. Click **Upgrade** and then **Confirm upgrade**. The new configuration takes a few minutes to create.

::::{note}
::::{note}
If any incompatibilities are detected when you attempt to upgrade to 9.0.0-beta1, the UI provides a link to the Upgrade Assistant, which checks for deprecated settings in your cluster and indices and helps you resolve them. After resolving the issues, return to the **Deployments** page and restart the upgrade.
::::



## Upgrading {{es}} clients and ingest components [upgrading-clients-ingest]
## Upgrading {{es}} clients and ingest components [upgrading-clients-ingest]

Once you have upgraded from 8.17, you need to update your {{es}} clients and ingest components in the following order:

1. Java API Client: [dependency configuration](asciidocalypse://docs/elasticsearch-java/docs/reference/installation.md#maven)
1. Java API Client: [dependency configuration](elasticsearch-java://reference/installation.md#maven)
2. Logstash: [upgrade instructions](asciidocalypse://docs/logstash/docs/reference/upgrading-logstash.md)
3. Beats: [upgrade instructions](asciidocalypse://docs/beats/docs/reference/libbeat/upgrading.md)
4. {{agent}}: [upgrade instructions](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/upgrade-elastic-agent.md)


## Reindex to upgrade [upgrading-reindex]
## Reindex to upgrade [upgrading-reindex]

If you are running a pre-8.x version, you might need to perform multiple upgrades or a full-cluster restart to get to 8.17 to prepare to upgrade to 9.0.0-beta1.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Once you are [prepared to upgrade](../../../deploy-manage/upgrade/deployment-or-
1. {{es}} Hadoop: [install instructions](elasticsearch-hadoop://reference/installation.md)
2. {{es}}: [upgrade instructions](../../../deploy-manage/upgrade/deployment-or-cluster.md)
3. Kibana: [upgrade instructions](../../../deploy-manage/upgrade/deployment-or-cluster.md)
4. Java API Client: [dependency configuration](asciidocalypse://docs/elasticsearch-java/docs/reference/installation.md#maven)
4. Java API Client: [dependency configuration](elasticsearch-java://reference/installation.md#maven)
5. Logstash: [upgrade instructions](asciidocalypse://docs/logstash/docs/reference/upgrading-logstash.md)
6. Beats: [upgrade instructions](asciidocalypse://docs/beats/docs/reference/libbeat/upgrading.md)
7. {{agent}}: [upgrade instructions](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/upgrade-elastic-agent.md)
Expand Down
2 changes: 1 addition & 1 deletion solutions/search/site-or-app/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ applies_to:
{{es}} provides official client libraries for popular programming languages. These libraries simplify the process of interacting with your {{es}} deployment.

- [Go](asciidocalypse://docs//go-elasticsearch/docs/reference/elasticsearch/elasticsearch-client-go-api/index.md)
- [Java](asciidocalypse://docs/elasticsearch-java/docs/reference/index.md)
- [Java](elasticsearch-java://reference/index.md)
- [JavaScript](asciidocalypse://docs/elasticsearch-js/docs/reference/index.md)
- [.NET](asciidocalypse://docs/elasticsearch-net/docs/reference/index.md)
- [PHP](asciidocalypse://docs/elasticsearch-php/docs/reference/index.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This method was introduced in `elasticsearch-rest-client` version 7.16.0. The er

This happens in particular when the project is using the [Spring Boot Maven Plugin](https://docs.spring.io/spring-boot/docs/current/maven-plugin/reference/htmlsingle/), as this plugin [defines versions for commonly used libraries](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-dependencies/build.gradle), including `elasticsearch-rest-client`. Depending on the version of Spring Boot used in the project, that version may be outdated.

To solve this issue, you have to add the `elasticsearch-rest-client` dependency explicitly in your project, with the same version as `elasticsearch-java` (see also [Installation](asciidocalypse://docs/elasticsearch-java/docs/reference/installation.md)).
To solve this issue, you have to add the `elasticsearch-rest-client` dependency explicitly in your project, with the same version as `elasticsearch-java` (see also [Installation](elasticsearch-java://reference/installation.md)).

Using Gradle:

Expand Down

0 comments on commit f2e9be3

Please sign in to comment.