Merge pull request kurrent-io#4151 from EventStore/yoeight/remove-pub-tcp-in-docs

YoEight · web-flow · commit 164821b067c0 · 2024-02-26T09:28:33.000-05:00
[DB-657] Remove mentions of external TCP in the docs.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -232,24 +232,17 @@ DEFAULT OPTIONS:
          ADVERTISE HOST TO CLIENT AS:             <empty> (<DEFAULT>)
          ADVERTISE HTTP PORT TO CLIENT AS:        0 (<DEFAULT>)
          ADVERTISE NODE PORT TO CLIENT AS:        0 (<DEFAULT>)
-         ADVERTISE TCP PORT TO CLIENT AS:         0 (<DEFAULT>)
          CONNECTION PENDING SEND BYTES THRESHOLD: 10485760 (<DEFAULT>)
          CONNECTION QUEUE SIZE THRESHOLD:         50000 (<DEFAULT>)
          DISABLE ADMIN UI:                        False (<DEFAULT>)
-         DISABLE EXTERNAL TCP TLS:                False (<DEFAULT>)
          DISABLE GOSSIP ON HTTP:                  False (<DEFAULT>)
          DISABLE INTERNAL TCP TLS:                False (<DEFAULT>)
          DISABLE STATS ON HTTP:                   False (<DEFAULT>)
          ENABLE ATOM PUB OVER HTTP:               False (<DEFAULT>)
-         ENABLE EXTERNAL TCP:                     False (<DEFAULT>)
          ENABLE TRUSTED AUTH:                     False (<DEFAULT>)
          ENABLE UNIX SOCKET:                      False (<DEFAULT>)
          EXT HOST ADVERTISE AS:                   <empty> (<DEFAULT>)
          EXT IP:                                  127.0.0.1 (<DEFAULT>)
-         EXT TCP HEARTBEAT INTERVAL:              2000 (<DEFAULT>)
-         EXT TCP HEARTBEAT TIMEOUT:               1000 (<DEFAULT>)
-         EXT TCP PORT:                            1113 (<DEFAULT>)
-         EXT TCP PORT ADVERTISE AS:               0 (<DEFAULT>)
          GOSSIP ON SINGLE NODE:                   <empty> (<DEFAULT>)
          HTTP PORT:                               2113 (<DEFAULT>)
          HTTP PORT ADVERTISE AS:                  0 (<DEFAULT>)
@@ -265,8 +258,6 @@ DEFAULT OPTIONS:
          NODE IP:                                 127.0.0.1 (<DEFAULT>)
          NODE PORT:                               2113 (<DEFAULT>)
          NODE PORT ADVERTISE AS:                  0 (<DEFAULT>)
-         NODE TCP PORT:                           1113 (<DEFAULT>)
-         NODE TCP PORT ADVERTISE AS:              0 (<DEFAULT>)
          REPLICATION HEARTBEAT INTERVAL:          700 (<DEFAULT>)
          REPLICATION HEARTBEAT TIMEOUT:           700 (<DEFAULT>)
          REPLICATION HOST ADVERTISE AS:           <empty> (<DEFAULT>)
diff --git a/docs/installation.md b/docs/installation.md
@@ -160,27 +160,12 @@ The following command will start the EventStoreDB node using default HTTP port,
 connect to it using one of the clients and the `esdb://localhost:2113?tls=false` connection string. You can also access the Admin UI by opening http://localhost:2113 in your browser.
 
 ```bash:no-line-numbers
-docker run --name esdb-node -it -p 2113:2113 -p 1113:1113 \
+docker run --name esdb-node -it -p 2113:2113 \
     eventstore/eventstore:latest --insecure --run-projections=All
     --enable-atom-pub-over-http
 ```
 
-If you want to start the node with legacy TCP client protocol enabled, add the following:
-
-```bash:no-line-numbers
-docker run --name esdb-node -it -p 2113:2113 -p 1113:1113 \
-    eventstore/eventstore:latest --insecure --run-projections=All \
-    --enable-external-tcp  --enable-atom-pub-over-http
-```
-
-::: warning
-The legacy TCP protocol will no longer be available from 24.2. 
-:::
-
-The command above runs EventStoreDB as a single node without SSL and with the legacy TCP protocol
-enabled, so you can try out your existing apps with the latest database version.
-
-Then, you'd be able to connect to EventStoreDB with gRPC and TCP clients. Also, the Stream Browser will work
+Then, you'd be able to connect to EventStoreDB with gRPC clients. Also, the Stream Browser will work
 in the Admin UI.
 
 In order to sustainably keep the data, we also recommend mapping the database and index volumes.
@@ -241,22 +226,21 @@ docker-compose up
 
 Watching the log messages, you will see that after some time, the elections process completes. Then you're able to connect to each
 node using the Admin UI. Nodes should be accessible on the loopback address (`127.0.0.1` or `localhost`) over
-HTTP and TCP, using ports specified below:
+HTTP, using ports specified below:
 
-| Node  | TCP port | HTTP port |
-| :---- | :------- | :-------- |
-| node1 | 1111     | 2111      |
-| node2 | 1112     | 2112      |
-| node3 | 1113     | 2113      |
+| Node  | HTTP port |
+| :---- | :-------- |
+| node1 | 2111      |
+| node2 | 2112      |
+| node3 | 2113      |
 
-You have to tell your client to use secure connection for both TCP and gRPC.
+You have to tell your client to use secure connection.
 
 | Protocol | Connection string                                                                                     |
 | :------- | :---------------------------------------------------------------------------------------------------- |
-| TCP      | `GossipSeeds=localhost:1111,localhost:1112,localhost:1113;ValidateServer=False;UseSslConnection=True` |
 | gRPC     | `esdb://localhost:2111,localhost:2112,localhost:2113?tls=true&tlsVerifyCert=false`                    |
 
-As you might've noticed, both connection strings have a setting to disable the certificate validation (`ValidateServer=False` for `TCP` and `tlsVerifyCert=false` for `gRPC`). It would prevent the invalid certificate error since the cluster uses a private, auto-generated CA.
+As you might've noticed, the connection string has a setting to disable the certificate validation (`tlsVerifyCert=false`). It would prevent the invalid certificate error since the cluster uses a private, auto-generated CA.
 
 However, **we do not recommend using this setting in production**. Instead, you can either add the CA certificate to the trusted root CA store or instruct your application to use such a certificate. See the [security section](security.md#certificate-installation-on-a-client-environment) for detailed instructions.
 
@@ -266,7 +250,6 @@ Depending on how your EventStoreDB instance is configured, some features might n
 
 | Feature                       | Options impact                                                                                                                                                                          |
 | :---------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Connection for TCP clients    | External TCP is disabled by default. You need to enable it explicitly by using the `EnableExternalTcp` option.                                                                          |
 | Connection without SSL or TLS | EventStoreDB 20.6+ is secure by default. Your clients need to establish a secure connection, unless you use the `Insecure` option.                                                      |
 | Authentication and ACLs       | When using the `Insecure` option for the server, all security is disabled. The `Users` menu item is also disabled in the Admin UI.                                                      |
 | Projections                   | Running projections is disabled by default and the `Projections` menu item is disabled in the Admin UI. You need to enable projections explicitly by using the `RunProjections` option. |
diff --git a/docs/networking.md b/docs/networking.md
@@ -6,7 +6,7 @@ title: Networking
 
 EventStoreDB provides two interfaces: 
 - HTTP(S) for gRPC communication and REST APIs
-- TCP for cluster replication (internal) and legacy clients (external) 
+- TCP for cluster replication (internal)
 
 Nodes in the cluster replicate with each other using the TCP protocol, but use gRPC for [discovering other cluster nodes](cluster.md#discovering-cluster-members).
 
@@ -136,7 +136,7 @@ This is configured with `Kestrel.Limits.Http2.InitialStreamWindowSize` in the se
 
 ## TCP configuration
 
-The TCP protocol is used internally for cluster nodes to replicate with each other. It happens over the [internal](#internal) TCP communication. In addition, you can enable [external](#external) TCP if you use the TCP client library in your applications.
+The TCP protocol is used internally for cluster nodes to replicate with each other. It happens over the [internal](#internal) TCP communication.
 
 ### Internal
 
@@ -172,32 +172,6 @@ By default, EventStoreDB uses port `1112` for internal TCP. You can change this
 Please note that the `IntTcpPort` parameter has been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `ReplicationPort` parameter instead.
 :::
 
-### External
-
-By default, TCP protocol is not exposed externally. If you use a TCP client library in your applications, you need to enable external TCP explicitly using the setting below.
-
-| Format               | Syntax                           |
-|:---------------------|:---------------------------------|
-| Command line         | `--enable-external-tcp`          |
-| YAML                 | `EnableExternalTcp`              |
-| Environment variable | `EVENTSTORE_ENABLE_EXTERNAL_TCP` |
-
-**Default**: `false`, TCP is disabled externally.
-
-When enabled, the external TCP will be exposed on the `NodeIp` address (described [here](#http-configuration)) using port `1113`. You can change the external TCP port using the `NodeTcpPort` setting.
-
-| Format               | Syntax                    |
-|:---------------------|:--------------------------|
-| Command line         | `--node-tcp-port`         |
-| YAML                 | `NodeTcpPort`             |
-| Environment variable | `EVENTSTORE_NODE_TCP_PORT`|
-
-**Default**: `1113`
-
-::: warning
-Please note that the `ExtTcpPort` parameter has been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `NodeTcpPort` parameter instead.
-:::
-
 ### Security
 
 When the node is secured (by default), all the TCP traffic will use TLS. You can disable TLS for TCP internally and externally using the settings described below.
@@ -210,15 +184,7 @@ When the node is secured (by default), all the TCP traffic will use TLS. You can
 
 **Default**: `false`
 
-| Format               | Syntax                                |
-|:---------------------|:--------------------------------------|
-| Command line         | `--disable-external-tcp-tls`          |
-| YAML                 | `DisableExternalTcpTls`               |
-| Environment variable | `EVENTSTORE_DISABLE_EXTERNAL_TCP_TLS` |
-
-**Default**: `false`
-
-If your network setup requires any kind of IP address, DNS name and port translation for internal or external communication, you can use available [address translation](#network-address-translation) settings.
+If your network setup requires any kind of IP address, DNS name and port translation for internal communication, you can use available [address translation](#network-address-translation) settings.
 
 ## Network address translation
 
@@ -268,14 +234,8 @@ Both internal and external TCP ports can be advertised using custom values:
 | YAML                 | `ReplicationTcpPortAdvertiseAs`               |
 | Environment variable | `EVENTSTORE_REPLICATION_TCP_PORT_ADVERTISE_AS`| 
 
-| Format               | Syntax                                 |
-|:---------------------|:---------------------------------------|
-| Command line         | `--node-tcp-port-advertise-as`         |
-| YAML                 | `NodeTcpPortAdvertiseAs`               |
-| Environment variable | `EVENTSTORE_NODE_TCP_PORT_ADVERTISE_AS`| 
-
 ::: warning
-Please note that the `IntTcpPortAdvertiseAs` and `ExtTcpPortAdvertiseAs` parameters have been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `ReplicationTcpPortAdvertiseAs` and `NodeTcpPortAdvertiseAs` parameters instead, respectively.
+Please note that the `IntTcpPortAdvertiseAs` parameter has been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `ReplicationTcpPortAdvertiseAs` and `NodeTcpPortAdvertiseAs` parameters instead, respectively.
 :::
 
 If you want to change how the node TCP address is advertised internally, use the `ReplicationHostAdvertiseAs` setting (previously `IntHostAdvertiseAs` setting). You can use an IP address or a hostname.
@@ -290,8 +250,6 @@ If you want to change how the node TCP address is advertised internally, use the
 Please note that the `IntHostAdvertiseAs` parameter has been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `ReplicationHostAdvertiseAs` parameter instead.
 :::
 
-Externally, TCP is advertised using the address specified in the `NodeIp` or `NodeHostAdvertiseAs` (as for HTTP).
-
 ### Advertise to clients
 
 In some cases, the cluster needs to advertise itself to clients using a completely different set of addresses and ports. Usually, you need to do it because addresses and ports configured for the HTTP protocol are not available as-is to the outside world. One of the examples is running a cluster in Docker Compose. In such environment, HTTP uses internal hostnames in the Docker network, which isn't accessible on the host. So, in order to connect to the cluster from the host machine, you need to use `localhost` and translated HTTP ports to reach the cluster nodes.
@@ -318,14 +276,6 @@ Specify the advertised HTTP(S) port (previously `AdvertiseHttpPortToClientAs` se
 Please note that the `AdvertiseHttpPortToClientAs` parameter has been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `AdvertiseNodePortToClientAs` parameter instead.
 :::
 
-Specify the advertised TCP port (only if external TCP is enabled):
-
-| Format               | Syntax                                       |
-|:---------------------|:---------------------------------------------|
-| Command line         | `--advertise-tcp-port-to-client-as`          |
-| YAML                 | `AdvertiseTcpPortToClientAs`                 |
-| Environment variable | `EVENTSTORE_ADVERTISE_TCP_PORT_TO_CLIENT_AS` | 
-
 ## Heartbeat timeouts
 
 EventStoreDB uses heartbeats over all TCP connections to discover dead clients and nodes. Heartbeat timeouts should not be too short, as short timeouts will produce false positives. At the same time, setting too long timeouts will prevent discovering dead nodes and clients in time.
@@ -365,28 +315,6 @@ Replication/Internal TCP heartbeat (between cluster nodes):
 Please note that the `IntTcpHeartbeatInterval` and `IntTcpHeartbeatTimeout` parameters have been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `ReplicationHeartbeatInterval` and `ReplicationHeartbeatTimeout` parameters instead, respectively.
 :::
 
-Node/External TCP heartbeat (between client and server):
-
-| Format               | Syntax                              |
-|:---------------------|:------------------------------------|
-| Command line         | `--node-heartbeat-interval`         |
-| YAML                 | `NodeHeartbeatInterval`             |
-| Environment variable | `EVENTSTORE_NODE_HEARTBEAT_INTERVAL`| 
-
-**Default**: `2000` (ms)
-
-| Format               | Syntax                             |
-|:---------------------|:-----------------------------------|
-| Command line         | `--node-heartbeat-timeout`         |
-| YAML                 | `NodeHeartbeatTimeout`             |
-| Environment variable | `EVENTSTORE_NODE_HEARTBEAT_TIMEOUT`| 
-
-**Default**: `1000` (ms)
-
-::: warning
-Please note that the `ExtTcpHeartbeatInterval` and `ExtTcpHeartbeatTimeout` parameters have been deprecated as of version 23.10.0 and will be removed in future versions. It is recommended to use the `NodeHeartbeatInterval` and `NodeHeartbeatTimeout` parameters instead, respectively.
-:::
-
 ### gRPC heartbeats
 
 For the gRPC heartbeats, EventStoreDB and its gRPC clients use the protocol feature called _Keepalive ping_. Read more about it on the [HTTP configuration page](#keep-alive-pings).
diff --git a/docs/security.md b/docs/security.md
@@ -571,14 +571,6 @@ You can, however, disable TLS for both internal and external TCP.
 
 **Default**: `false`
 
-| Format               | Syntax                                |
-|:---------------------|:--------------------------------------|
-| Command line         | `--disable-external-tcp-tls`          |
-| YAML                 | `DisableExternalTcpTls`               |
-| Environment variable | `EVENTSTORE_DISABLE_EXTERNAL_TCP_TLS` |
-
-**Default**: `false`
-
 ## Authentication
 
 EventStoreDB supports authentication based on usernames and passwords out of the box. The Enterprise version
diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md
@@ -88,19 +88,15 @@ Follow the [upgrade procedure](#upgrade-procedure) and ensure that the Leader no
 
 ### Deprecated configuration options
 
-Several options are deprecated and slated for removal in version 24.10 next year. See the table below for guidance.
+Several options are deprecated and slated for removal in future releases. See the table below for guidance.
 
 | Deprecated Option | Use Instead |
 |:------------------|:-------------|
 | ExtIp | NodeIp |
 | ExtPort | NodePort |
-| ExtTcpPort | NodeTcpPort |
 | HttpPortAdvertiseAs | NodePortAdvertiseAs |
 | ExtHostAdvertiseAs | NodeHostAdvertiseAs |
-| ExtTcpPortAdvertiseAs | NodeTcpPortAdvertiseAs |
 | AdvertiseHttpPortToClientAs | AdvertiseNodePortToClientAs |
-| ExtTcpHeartbeatTimeout | NodeHeartbeatTimeout |
-| ExtTcpHeartbeatInterval | NodeHeartbeatInterval |
 | IntIp | ReplicationIp |
 | IntTcpPort | ReplicationTcpPort |
 | IntTcpPortAdvertiseAs | ReplicationTcpPortAdvertiseAs |
