122 lines
4.5 KiB
Markdown
122 lines
4.5 KiB
Markdown
# CoreTraffic
|
|
|
|
CoreTraffic is the serve.zone ingress component that receives routing updates from Coreflow and applies them to `@push.rocks/smartproxy`. It runs as a small TypeScript service inside the cluster and keeps HTTP redirects, HTTPS termination, backend routing, default response headers, and optional basic authentication in sync with the control plane.
|
|
|
|
## Issue Reporting and Security
|
|
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
|
|
## What It Does
|
|
|
|
CoreTraffic is intentionally focused:
|
|
|
|
- Starts a `SmartProxy` instance for cluster ingress.
|
|
- Connects to Coreflow over `@api.global/typedsocket`.
|
|
- Registers the `updateRouting` typed request handler.
|
|
- Converts `IReverseProxyConfig[]` updates into SmartProxy route configs.
|
|
- Adds an HTTP-to-HTTPS redirect route on port `7999`.
|
|
- Adds HTTPS reverse-proxy routes on port `8000` with per-domain certificates.
|
|
- Adds the `servezone_coretraffic_version` response header to managed routes.
|
|
|
|
## Runtime Flow
|
|
|
|
```text
|
|
Coreflow
|
|
-> TypedSocket updateRouting
|
|
-> CoreflowConnector
|
|
-> CoretrafficTaskManager buffered setupRouting task
|
|
-> SmartProxy.updateRoutes(...)
|
|
```
|
|
|
|
Routing updates are buffered so fast repeated changes collapse into the most recent route state instead of overwhelming the proxy engine.
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { CoreTraffic } from 'coretraffic';
|
|
|
|
const coreTraffic = new CoreTraffic();
|
|
await coreTraffic.start();
|
|
|
|
// later
|
|
await coreTraffic.stop();
|
|
```
|
|
|
|
In production, CoreTraffic is normally started through `runCli()` and expects Coreflow to be reachable at `http://coreflow:3000`.
|
|
|
|
## Routing Input
|
|
|
|
CoreTraffic consumes `@tsclass/tsclass` reverse proxy configs:
|
|
|
|
```typescript
|
|
const reverseConfig = {
|
|
hostName: 'app.example.com',
|
|
destinationIps: ['10.0.0.10'],
|
|
destinationPorts: [3000],
|
|
privateKey: '-----BEGIN PRIVATE KEY-----...',
|
|
publicKey: '-----BEGIN CERTIFICATE-----...',
|
|
authentication: {
|
|
type: 'Basic',
|
|
user: 'admin',
|
|
pass: 'secret',
|
|
},
|
|
};
|
|
```
|
|
|
|
Each config becomes one HTTPS SmartProxy route with TLS termination and one or more backend targets generated from the destination IP/port combinations.
|
|
|
|
## Development
|
|
|
|
Install dependencies with pnpm:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Build TypeScript:
|
|
|
|
```bash
|
|
pnpm run build
|
|
```
|
|
|
|
Run tests:
|
|
|
|
```bash
|
|
pnpm test
|
|
```
|
|
|
|
Check outdated dependencies:
|
|
|
|
```bash
|
|
pnpm outdated
|
|
```
|
|
|
|
## Important Dependencies
|
|
|
|
- `@push.rocks/smartproxy`: route-based proxy engine used for redirects, TLS termination, and forwarding.
|
|
- `@api.global/typedsocket`: Coreflow connection transport.
|
|
- `@api.global/typedrequest`: typed RPC handler registration.
|
|
- `@serve.zone/interfaces`: typed Coreflow/CoreTraffic routing request contract.
|
|
- `@push.rocks/taskbuffer`: buffered routing update execution.
|
|
|
|
## License and Legal Information
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|