Skip to content

Commit

Permalink
fix: Removing references to OpenSearch proxy
Browse files Browse the repository at this point in the history
  • Loading branch information
@grlimacan
grlimacan committed Nov 1, 2024
1 parent eb42e30 commit 7f5eb55
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 44 deletions.
25 changes: 10 additions & 15 deletions optimize/self-managed/optimize-deployment/configuration/system-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,19 +198,14 @@ This section details everything related to building the connection to OpenSearch
You can define a number of connection points in a cluster. Therefore, everything under `opensearch.connection.nodes` is a list of nodes Optimize can connect to. If you have built an OpenSearch cluster with several nodes, it is recommended to define several connection points so if one node fails, Optimize is still able to talk to the cluster.
:::

| YAML path | Default value | Description |
| ----------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| opensearch.connection.timeout | 10000 | Maximum time without connection to OpenSearch that Optimize should wait until a timeout triggers. |
| opensearch.connection.responseConsumerBufferLimitInMb | 100 | Maximum size of the OpenSearch response consumer heap buffer. This can be increased to resolve errors from OpenSearch relating to the entity content being too long. |
| opensearch.connection.pathPrefix | | The path prefix under which OpenSearch is available. |
| opensearch.connection.nodes[*].host | localhost | The address/hostname under which the OpenSearch node is available. |
| opensearch.connection.nodes[*].httpPort | 9205 | A port number used by OpenSearch to accept HTTP connections. |
| opensearch.connection.proxy.enabled | false | Whether an HTTP proxy should be used for requests to OpenSearch. |
| opensearch.connection.proxy.host | null | The proxy host to use, must be set if `opensearch.connection.proxy.enabled = true`. |
| opensearch.connection.proxy.port | null | The proxy port to use, must be set if `opensearch.connection.proxy.enabled = true`. |
| opensearch.connection.proxy.sslEnabled | false | Whether this proxy is using a secured connection (HTTPS). |
| opensearch.connection.skipHostnameVerification | false | Determines whether the hostname verification should be skipped. |
| opensearch.connection.awsEnabled | false | Determines if AWS credentials shall be used for authentication |
| YAML path | Default value | Description |
| ---------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| opensearch.connection.timeout | 10000 | Maximum time without connection to OpenSearch that Optimize should wait until a timeout triggers. |
| opensearch.connection.pathPrefix | | The path prefix under which OpenSearch is available. |
| opensearch.connection.nodes[*].host | localhost | The address/hostname under which the OpenSearch node is available. |
| opensearch.connection.nodes[*].httpPort | 9205 | A port number used by OpenSearch to accept HTTP connections. |
| opensearch.connection.skipHostnameVerification | false | Determines whether the hostname verification should be skipped. |
| opensearch.connection.awsEnabled | false | Determines if AWS credentials shall be used for authentication |

#### Index settings

Expand All @@ -228,8 +223,8 @@ Define a secured connection to be able to communicate with a secured OpenSearch

| YAML path | Default value | Description |
| ----------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| opensearch.security.username | | The basic authentication (x-pack) username. |
| opensearch.security.password | | The basic authentication (x-pack) password. |
| opensearch.security.username | | The basic authentication username. |
| opensearch.security.password | | The basic authentication password. |
| opensearch.security.ssl.enabled | false | Used to enable or disable TLS/SSL for the HTTP connection. |
| opensearch.security.ssl.certificate | | The path to a PEM encoded file containing the certificate (or certificate chain) that will be presented to clients when they connect. |
| opensearch.security.ssl.certificate_authorities | [ ] | A list of paths to PEM encoded CA certificate files that should be trusted, for example ['/path/to/ca.crt']. <br /><br />NOTE: if you are using a public CA that is already trusted by the Java runtime, you do not need to set the certificate_authorities. |
Expand Down
23 changes: 9 additions & 14 deletions ...n-3.13.0/self-managed/optimize-deployment/configuration/system-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,18 +198,13 @@ This section details everything related to building the connection to OpenSearch
You can define a number of connection points in a cluster. Therefore, everything under `opensearch.connection.nodes` is a list of nodes Optimize can connect to. If you have built an OpenSearch cluster with several nodes, it is recommended to define several connection points so if one node fails, Optimize is still able to talk to the cluster.
:::

| YAML path | Default value | Description |
| ----------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| opensearch.connection.timeout | 10000 | Maximum time without connection to OpenSearch that Optimize should wait until a timeout triggers. |
| opensearch.connection.responseConsumerBufferLimitInMb | 100 | Maximum size of the OpenSearch response consumer heap buffer. This can be increased to resolve errors from OpenSearch relating to the entity content being too long. |
| opensearch.connection.pathPrefix | | The path prefix under which OpenSearch is available. |
| opensearch.connection.nodes[*].host | localhost | The address/hostname under which the OpenSearch node is available. |
| opensearch.connection.nodes[*].httpPort | 9200 | A port number used by OpenSearch to accept HTTP connections. |
| opensearch.connection.proxy.enabled | false | Whether an HTTP proxy should be used for requests to OpenSearch. |
| opensearch.connection.proxy.host | null | The proxy host to use, must be set if `opensearch.connection.proxy.enabled = true`. |
| opensearch.connection.proxy.port | null | The proxy port to use, must be set if `opensearch.connection.proxy.enabled = true`. |
| opensearch.connection.proxy.sslEnabled | false | Whether this proxy is using a secured connection (HTTPS). |
| opensearch.connection.skipHostnameVerification | false | Determines whether the hostname verification should be skipped. |
| YAML path | Default value | Description |
| ---------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| opensearch.connection.timeout | 10000 | Maximum time without connection to OpenSearch that Optimize should wait until a timeout triggers. |
| opensearch.connection.pathPrefix | | The path prefix under which OpenSearch is available. |
| opensearch.connection.nodes[*].host | localhost | The address/hostname under which the OpenSearch node is available. |
| opensearch.connection.nodes[*].httpPort | 9200 | A port number used by OpenSearch to accept HTTP connections. |
| opensearch.connection.skipHostnameVerification | false | Determines whether the hostname verification should be skipped. |

#### Index settings

Expand All @@ -227,8 +222,8 @@ Define a secured connection to be able to communicate with a secured OpenSearch

| YAML path | Default value | Description |
| ----------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| opensearch.security.username | | The basic authentication (x-pack) username. |
| opensearch.security.password | | The basic authentication (x-pack) password. |
| opensearch.security.username | | The basic authentication username. |
| opensearch.security.password | | The basic authentication password. |
| opensearch.security.ssl.enabled | false | Used to enable or disable TLS/SSL for the HTTP connection. |
| opensearch.security.ssl.certificate | | The path to a PEM encoded file containing the certificate (or certificate chain) that will be presented to clients when they connect. |
| opensearch.security.ssl.certificate_authorities | [ ] | A list of paths to PEM encoded CA certificate files that should be trusted, for example ['/path/to/ca.crt']. <br /><br />NOTE: if you are using a public CA that is already trusted by the Java runtime, you do not need to set the certificate_authorities. |
Expand Down
Loading

0 comments on commit 7f5eb55

Please sign in to comment.