refactor(io): Refactor network types into net::io modules

Author: XAMPPRocky

benches/shared.rs

@@ -319,7 +319,7 @@ impl QuilkinLoop {
     }
 
     fn spinup_inner(port: u16, endpoint: SocketAddr) -> Self {
-        let (shutdown_tx, shutdown_rx) =
+        let (shutdown_tx, mut shutdown_rx) =
             quilkin::signal::channel(quilkin::signal::ShutdownKind::Benching);
 
         let thread = spawn("quilkin", move || {
@@ -331,21 +331,15 @@ impl QuilkinLoop {
                 );
             });
 
-            let proxy = quilkin::cli::Proxy {
-                port,
-                qcmp_port: runtime
-                    .block_on(quilkin::test::available_addr(
-                        quilkin::test::AddressType::Random,
-                    ))
-                    .port(),
-                ..<_>::default()
-            };
-
             runtime.block_on(async move {
-                proxy
-                    .run(config, Default::default(), None, shutdown_rx)
-                    .await
+                quilkin::cli::Service::default()
+                    .udp()
+                    .udp_port(port)
+                    .qcmp()
+                    .qcmp_port(quilkin::test::available_port())
+                    .spawn_services(&config, &shutdown_rx)
                     .unwrap();
+                let _ = shutdown_rx.changed().await;
             });
         });
 

docs/src/SUMMARY.md

@@ -30,11 +30,14 @@
 
 ---
 
+- [Providers]()
+    - [Agones](./config/providers/agones.md)
+    - [Filesystem](./config/providers/filesystem.md)
+
+---
+
 - [Control Plane](./services/xds.md)
     - [Metrics](./services/xds/metrics.md)
-    - [Providers]()
-        - [Agones](./services/xds/providers/agones.md)
-        - [Filesystem](./services/xds/providers/filesystem.md)
     - [Protobuf Reference](./services/xds/proto/index.md)
 ---
 

docs/src/config/providers/agones.md

@@ -0,0 +1,83 @@
+# Agones xDS Provider
+
+The [Agones] xDS Provider is built to simplify Quilkin integration with Agones
+game server hosting on top of [Kubernetes](https://kubernetes.io).
+
+This provider watches for changes in Agones
+[`GameServer` resources](https://agones.dev/site/docs/getting-started/create-gameserver/) in a cluster, and
+utilises that information to provide [Endpoint][Endpoints] information to connected Quilkin proxies.
+
+To view all the options for the agones provider subcommand, run:
+```shell
+$ quilkin manage agones --help
+{{#include ../../../../../target/quilkin.manage.agones.commands}}
+```
+
+> Currently, the Agones provider can only discover resources within the cluster it is running in.
+
+## Endpoint Configuration
+
+This provider watches the Kubernetes clusters for `Allocated`
+[Agones GameServers](https://agones.dev/site/docs/reference/gameserver/#gameserver-state-diagram)
+and exposes their IP address and Port as [Endpoints] to any connected Quilkin proxies.
+
+> Since an Agones GameServer can have multiple ports exposed, if multiple ports are in
+> use, the server will pick the first port in the port list.
+
+By default the Agones xDS provider will look in the `default` namespace for any `GameServer` resources, but it can be
+configured via the `--gameservers-namespace` argument.
+
+### Access Tokens
+
+The set of [access tokens](../../proxy.md#specialist-endpoint-metadata) for the associated Endpoint can be
+set by adding a comma separated standard base64 encoded strings. This must be added under an annotation
+`quilkin.dev/tokens` in the
+[GameServer](https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer)'s metadata.
+
+For example:
+
+```yaml
+annotations:
+   # Sets two tokens for the corresponding endpoint with values 1x7ijy6 and 8gj3v2i respectively.
+   quilkin.dev/tokens: MXg3aWp5Ng==,OGdqM3YyaQ==
+```
+
+## Filter Configuration
+
+The Agones provider watches for a singular [`ConfigMap`](https://kubernetes.io/docs/concepts/configuration/configmap/) 
+that has the label of `quilkin.dev/configmap: "true"`, and any changes that happen to it, and use its contents to 
+send [Filter] configuration to any connected Quilkin proxies.
+
+The `ConfigMap` contents should be a valid Quilkin [file configuration][configuration], but with no 
+Endpoint data.
+
+For example:
+
+```yaml
+{{#include ../../../../../examples/agones-xonotic-xds/xds-control-plane.yaml:config-map}}
+```
+
+By default the Agones xDS provider will look in the `default` namespace for this `ConfigMap`, but it can be
+configured via the `--config-namespace` argument.
+
+## Usage
+
+As an example, the following runs the server with subcommnad `manage agones` against a cluster (using default
+kubeconfig authentication) where Quilkin pods run in the `quilkin` namespace and `GameServer` pods run in the
+`gameservers` namespace:
+
+```sh
+quilkin manage agones --config-namespace quilkin --gameservers-namespace gameservers
+```
+
+For a full referenmce of deploying this provider in a Kubernetes cluster, with appropriate [Deployments], [Services],
+and [RBAC] Rules, there is an [Agones, xDS and Xonotic example][example].
+
+[Agones]: https://agones.dev
+[Endpoints]: ../../proxy.md#endpoints
+[Deployments]: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
+[Services]: https://kubernetes.io/docs/concepts/services-networking/service/
+[RBAC]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
+[example]: https://github.com/googleforgames/quilkin/tree/{{GITHUB_REF_NAME}}/examples/agones-xonotic-xds
+[Filter]: ../../../services/proxy/filters.md
+[configuration]: ../../../services/proxy/configuration.md

docs/src/config/providers/filesystem.md

@@ -0,0 +1,45 @@
+# Filesystem xDS Provider
+
+The filesystem provider watches a configuration file on disk and sends updates to proxies whenever that file changes.
+
+To view all the options for the file provider subcommand, run:
+```shell
+$ quilkin manage agones --help
+{{#include ../../../../../target/quilkin.manage.file.commands}}
+```
+
+For example:
+```sh
+quilkin manage file quilkin.yaml
+```
+
+We run this on port 1800, in this example, in case you are running this locally, and the
+default port is taken up by an existing Quilkin proxy.
+
+After running this command, any proxy that connects to port 18000 will receive updates as configured in `config.yaml`
+file.
+
+You can find the configuration file schema in [Configuration File][configuration].
+
+Example:
+
+```rust
+# let yaml = "
+version: v1alpha1
+filters:
+  - name: quilkin.filters.debug.v1alpha1.Debug
+    config:
+      id: hello
+clusters:
+  - endpoints:
+     - address: 123.0.0.1:29
+       metadata:
+         'quilkin.dev':
+           tokens:
+             - 'MXg3aWp5Ng=='
+# ";
+# let config = quilkin::config::Config::from_reader(yaml.as_bytes()).unwrap();
+# assert_eq!(config.filters().unwrap().load().len(), 1);
+```
+
+[configuration]: ../../../services/proxy/configuration.md

src/cli.rs

@@ -26,10 +26,9 @@ pub use self::{
     agent::Agent,
     generate_config_schema::GenerateConfigSchema,
     manage::Manage,
-    proxy::Proxy,
     qcmp::Qcmp,
     relay::Relay,
-    service::{Finalizer, Service},
+    service::{Finalizer, Service, XdpOptions},
 };
 
 macro_rules! define_port {
@@ -45,7 +44,6 @@ macro_rules! define_port {
 pub mod agent;
 pub mod generate_config_schema;
 pub mod manage;
-pub mod proxy;
 pub mod qcmp;
 pub mod relay;
 mod service;
@@ -191,7 +189,6 @@ pub enum Commands {
     Manage(Manage),
     #[clap(subcommand)]
     Qcmp(Qcmp),
-    Proxy(Proxy),
     Relay(Relay),
 }
 
@@ -261,14 +258,6 @@ impl Cli {
                 agent.run(locality, config, old_ready, shutdown_rx).await
             }
 
-            Some(Commands::Proxy(runner)) => {
-                let old_ready = proxy::Ready {
-                    xds_is_healthy: parking_lot::RwLock::from(Some(ready.clone())).into(),
-                    ..<_>::default()
-                };
-                runner.run(config, old_ready, None, shutdown_rx).await
-            }
-
             Some(Commands::Manage(manager)) => {
                 let old_ready = agent::Ready {
                     provider_is_healthy: ready.clone(),