diff --git a/AGENTS.md b/AGENTS.md index cd25ab13..4d4b8dd3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -13,7 +13,7 @@ This document orients any AI coding agent working in this repository. Follow the ## Project Overview This is Speedscale's documentation website built with Docusaurus 3 (currently 3.8.1). Speedscale is an API testing platform that uses traffic capture and replay for stress testing APIs with real-world scenarios. The documentation covers two main products: - **Speedscale Platform**: Full enterprise API testing platform -- **ProxyMock**: Local development tool for mocking APIs +- **proxymock**: Local development tool for mocking APIs ## Development Commands @@ -101,7 +101,7 @@ When deleting pages, always add redirects to `docusaurus.config.js` to prevent b #### **Phase 1: Critical Content Gaps** - **Setup/Upgrade Documentation**: Expand beyond operator upgrades to include CLI/Docker procedures, rollback guides -- **ProxyMock Guides**: Currently minimal (4 files) - needs comprehensive getting started guides, troubleshooting, integration examples +- **proxymock Guides**: Currently minimal (4 files) - needs comprehensive getting started guides, troubleshooting, integration examples - **Transform Documentation Consolidation**: Content split between `/transform/` and `/reference/transform-traffic/` - consolidate for clarity #### **Phase 2: Information Architecture** diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index e901c062..32762a60 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -10,7 +10,7 @@ import ApiKey from './installation/install/api-key.png' # Quick Start :::info Local installation -For local development and testing without a cloud cluster, use **proxymock** to run a local mock server and generate tests from your traffic. See **[Local Development (AI) – Getting Started](/proxymock/)** to install proxymock and get started in about 30 seconds. +For local development and testing without a cloud cluster, use **proxymock** to run a local mock server and generate tests from your traffic. See **[Local Development – Getting Started](/proxymock/)** to install proxymock and get started in about 30 seconds. ::: :::tip Security options diff --git a/docs/guides/message-brokers/kafka.md b/docs/guides/message-brokers/kafka.md index fe80dbaa..1d152c8a 100644 --- a/docs/guides/message-brokers/kafka.md +++ b/docs/guides/message-brokers/kafka.md @@ -1,6 +1,6 @@ --- title: Kafka -description: "Record, mock, and replay Kafka traffic using Speedscale and ProxyMock for efficient traffic simulation and testing." +description: "Record, mock, and replay Kafka traffic using Speedscale and proxymock for efficient traffic simulation and testing." sidebar_position: 12 --- diff --git a/docs/guides/replay/mocks/from-scratch.md b/docs/guides/replay/mocks/from-scratch.md index 000fcbec..c838789e 100644 --- a/docs/guides/replay/mocks/from-scratch.md +++ b/docs/guides/replay/mocks/from-scratch.md @@ -1,6 +1,6 @@ --- title: From Scratch -description: "Create mock services from scratch with ProxyMock by seeding and deleting mock responses, and configuring passthrough mode for effective API testing." +description: "Create mock services from scratch with proxymock by seeding and deleting mock responses, and configuring passthrough mode for effective API testing." sidebar_position: 20 --- diff --git a/docs/guides/signature-refinement-guide.md b/docs/guides/signature-refinement-guide.md index 2713ce89..78ecbc41 100644 --- a/docs/guides/signature-refinement-guide.md +++ b/docs/guides/signature-refinement-guide.md @@ -1,5 +1,5 @@ --- -description: "Refine signatures in ProxyMock to enhance mock accuracy, ensuring your service mock returns correct responses for every incoming request." +description: "Refine signatures in proxymock to enhance mock accuracy, ensuring your service mock returns correct responses for every incoming request." sidebar_position: 22 --- diff --git a/docs/proxymock/aws/ses.md b/docs/proxymock/aws/ses.md index 3fffd985..e7e23d5e 100644 --- a/docs/proxymock/aws/ses.md +++ b/docs/proxymock/aws/ses.md @@ -1,5 +1,5 @@ --- -description: "Mock AWS SES connections for local development using ProxyMock to test email functionality without sending real emails or incurring costs with Speedscale." +description: "Mock AWS SES connections for local development using proxymock to test email functionality without sending real emails or incurring costs with Speedscale." sidebar_position: 9 --- diff --git a/docs/proxymock/getting-started/faq.md b/docs/proxymock/getting-started/faq.md index 7b375fba..69a627be 100644 --- a/docs/proxymock/getting-started/faq.md +++ b/docs/proxymock/getting-started/faq.md @@ -1,5 +1,5 @@ --- -description: "Explore the FAQ for ProxyMock, covering supported protocols, Windows compatibility, differences from Speedscale Enterprise, and mock server functionality." +description: "Explore the FAQ for proxymock, covering supported protocols, Windows compatibility, differences from Speedscale Enterprise, and mock server functionality." sidebar_position: 4 --- @@ -19,7 +19,7 @@ Yes. The **proxymock** cli is available as a native Windows executable. Alternat Speedscale Enterprise is a cloud platform that allows you to create, manage, and scale mock servers. It allows you to record from a real production environment and bring that environment back to your desktop. That is a paid product that requires a subscription (and helps fund **proxymock** development). -## Can Proxymock be used as a shared mock server to replace part of a dev environment? +## Can proxymock be used as a shared mock server to replace part of a dev environment? Most definitely, but for that you need to consider an Enterprise subscription. Beyond licensing, you will need the more sophisticated tools provided by Speedscale Enterprise to manage that use case. diff --git a/docs/proxymock/getting-started/help.md b/docs/proxymock/getting-started/help.md index 445c5c08..3e5a5382 100644 --- a/docs/proxymock/getting-started/help.md +++ b/docs/proxymock/getting-started/help.md @@ -1,5 +1,5 @@ --- -description: "Get help with ProxyMock by connecting on the Speedscale Slack or emailing support@speedscale.com for assistance with your API testing needs" +description: "Get help with proxymock by connecting on the Speedscale Slack or emailing support@speedscale.com for assistance with your API testing needs" sidebar_position: 5 --- diff --git a/docs/proxymock/getting-started/installation.md b/docs/proxymock/getting-started/installation.md index 53bdfcb9..31d583e7 100644 --- a/docs/proxymock/getting-started/installation.md +++ b/docs/proxymock/getting-started/installation.md @@ -1,5 +1,5 @@ --- -description: "Install ProxyMock via the command line to automate simulation environments, record traffic, and replay transactions efficiently for your API testing needs" +description: "Install proxymock via the command line to automate simulation environments, record traffic, and replay transactions efficiently for your API testing needs" sidebar_position: 2 --- import Tabs from '@theme/Tabs'; diff --git a/docs/proxymock/getting-started/language-reference.md b/docs/proxymock/getting-started/language-reference.md index e5a479c9..34680002 100644 --- a/docs/proxymock/getting-started/language-reference.md +++ b/docs/proxymock/getting-started/language-reference.md @@ -1,7 +1,7 @@ --- sidebar_position: 3 title: Language Configuration -description: "Configure language-specific settings for ProxyMock to route traffic effectively without modifying application code, ensuring seamless API testing and traffic replay." +description: "Configure language-specific settings for proxymock to route traffic effectively without modifying application code, ensuring seamless API testing and traffic replay." --- import Tabs from '@theme/Tabs'; diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-capture-toggle.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-capture-toggle.png new file mode 100644 index 00000000..ba1a14f5 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-capture-toggle.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-kube-context.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-kube-context.png new file mode 100644 index 00000000..1eac0aea Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-kube-context.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-observability-connect.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-observability-connect.png new file mode 100644 index 00000000..d2948bc1 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-observability-connect.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-cluster-button.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-cluster-button.png new file mode 100644 index 00000000..97f7d9b6 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-cluster-button.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-destination.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-destination.png new file mode 100644 index 00000000..d925c969 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-destination.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-logs.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-logs.png new file mode 100644 index 00000000..c168ac66 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-logs.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-mock-deps.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-mock-deps.png new file mode 100644 index 00000000..d7ea2d76 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-mock-deps.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-select-recordings.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-select-recordings.png new file mode 100644 index 00000000..dae6dc15 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-select-recordings.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-stepper.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-stepper.png new file mode 100644 index 00000000..9967be1b Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-replay-stepper.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-request-detail.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-request-detail.png new file mode 100644 index 00000000..2da60d01 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-request-detail.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-requests-run.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-requests-run.png new file mode 100644 index 00000000..682f25d3 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-requests-run.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-tap-card.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-tap-card.png new file mode 100644 index 00000000..5fe50aa9 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-tap-card.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-workload-pane.png b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-workload-pane.png new file mode 100644 index 00000000..8868df88 Binary files /dev/null and b/docs/proxymock/getting-started/quickstart/in-cluster/images/proxymock-web-workload-pane.png differ diff --git a/docs/proxymock/getting-started/quickstart/in-cluster/index.mdx b/docs/proxymock/getting-started/quickstart/in-cluster/index.mdx new file mode 100644 index 00000000..7dee1adc --- /dev/null +++ b/docs/proxymock/getting-started/quickstart/in-cluster/index.mdx @@ -0,0 +1,151 @@ +--- +title: In-Cluster (Web) +description: Use proxymock web to connect to your Kubernetes cluster, enable capture, and run replays in cluster with live results. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Admonition from '@theme/Admonition'; +import MacCLIInstall from '../../../index/_cli_macos_minified.mdx' +import LinuxCLIInstall from '../../../index/_cli_linux_minified.mdx' + +# In-Cluster (Web) + +Use proxymock web to work directly against your Kubernetes cluster. You can: +- Enable eBPF capture on a workload to record real in-cluster traffic +- Run an in-cluster replay of your local recordings (“Run in cluster”) and stream results live + +This path is best when you want realistic in-environment behavior or to validate changes inside the cluster. + +## Prerequisites +- Kubernetes cluster access (`kubectl` working, correct context) +- Authorized (if you plan to run in-cluster replay): `proxymock init` (browser sign-in) + +## 1) Install the proxymock CLI (if not installed) + +Install proxymock locally — this gives you both the CLI and `proxymock web`. + + + + + + + + + + See: [/proxymock/getting-started/installation](/proxymock/getting-started/installation) + + + +After install, initialize once (browser sign-in by default): + +```bash +proxymock init +``` + +## 2) Install the Speedscale Operator (if not installed) + +If your cluster doesn’t have the Speedscale Operator and Forwarder yet, install them first. Full instructions live here: [/getting-started/installation/install/kubernetes-operator/](/getting-started/installation/install/kubernetes-operator/) + +Quick Helm example: + +```bash +helm repo add speedscale https://speedscale.github.io/operator-helm/ +helm repo update +helm install speedscale-operator speedscale/speedscale-operator \ + -n speedscale \ + --create-namespace \ + --set apiKey= \ + --set clusterName= +``` + +Once installed and reachable, proxymock web will detect the Forwarder and enable Observability and live features via Kubernetes port-forwarding. + + + To use proxymock web with your cluster, you must have Kubernetes RBAC permissions that allow port forwarding. + If you cannot port-forward (e.g., on restricted clusters), use the cloud-based replay feature in Speedscale instead. + + +## 3) Start proxymock web and connect to your cluster + +```bash +proxymock web +# Open the printed http://127.0.0.1:XXXX URL +``` + +- Open Observability → Topology. +- If not connected, use the Retry control (proxymock web auto port-forwards to the Forwarder when possible). +- Optionally switch kube context from the toolbar. + +![Observability → Topology with the cluster connected](./images/proxymock-web-observability-connect.png) + +![Switch kube context from the toolbar](./images/proxymock-web-kube-context.png) + +## 4) Record traffic from a workload (eBPF capture) + +From Observability → Topology: +1) Pick a namespace and select a workload (Deployment/StatefulSet/etc.) +2) Open the workload pane and enable Capture (eBPF) +3) Generate traffic (e.g., hit your service from a client) + +Requests will stream back and appear in the Requests tab. The persistent live-tap card shows active sessions and counters. + +![Selected workload pane with Overview tab](./images/proxymock-web-workload-pane.png) + +![eBPF capture toggle on the workload pane](./images/proxymock-web-capture-toggle.png) + +![Persistent live-tap card with active session and counters](./images/proxymock-web-tap-card.png) + +Tips: +- Java services: enable the Java agent checkbox when prompted +- Ports: set custom capture ports when your service listens on non-default ports + +## 5) Inspect captured traffic + +Go to Requests → pick the active run from the Run selector. Inspect inbound/outbound RRPairs, filter by host, method, path, and drill into details. + +![Requests grid with Run selector](./images/proxymock-web-requests-run.png) + +![Drilled-in RRPair detail pane](./images/proxymock-web-request-detail.png) + +## 6) Optional — Run in cluster (replay recordings inside your cluster) + +You can take any local recordings (`./proxymock/recorded-*`) and run them against a target in your connected cluster. Results stream back live over the Forwarder tap. + +Steps (Replay tab): +1) Pick one or more recordings (left side) +2) Source & Target → choose a destination: + - URL (custom) or + - Cluster Workload / Service (preferred) +3) Optional: enable Mock dependencies, click Rescan to load outbound dependencies, and keep the ones to mock +4) Click “Run in cluster” + +While running: +- A stepper shows progress (build, push, run) +- A bottom drawer streams live generator/responder/SUT logs +- The persistent live-tap card shows ‘Live replay’ with counters + +On completion, proxymock web opens the report and scopes the Requests tab to the run output directory. + +![Pick the recordings to feed the replay](./images/proxymock-web-replay-select-recordings.png) + +![Cluster namespace + Cluster Workload destination](./images/proxymock-web-replay-destination.png) + +![Mock dependencies enabled with the inferred outbound list](./images/proxymock-web-replay-mock-deps.png) + +![Run in cluster button in the replay toolbar](./images/proxymock-web-replay-cluster-button.png) + +![Stage stepper during a live in-cluster replay](./images/proxymock-web-replay-stepper.png) + +![Bottom drawer streaming live generator/responder/SUT logs](./images/proxymock-web-replay-logs.png) + +Troubleshooting: +- If “Run in cluster” is unavailable, ensure you’ve run `proxymock init` (browser sign-in) and that Observability shows a connected cluster +- Mocking requires a Workload/Service destination (not just a URL) + +## Next steps +- [Local quickstart](/proxymock/getting-started/quickstart/local/) — record and replay traffic against an app on your machine, no cluster required +- [Live Tail (Web)](/proxymock/getting-started/quickstart/live-tail/) — point proxymock web at a running app and watch RRPairs stream in +- [Observability guide](/proxymock/guides/observability) — go deeper on topology, eBPF capture, and live-tap workflows +- [How it works](/proxymock/how-it-works/architecture) — architecture, lifecycle, and the RRPair format +- [Guides index](/proxymock/guides/) — credentials swap, CI/CD, OpenAPI, gRPC, databases, and more diff --git a/docs/proxymock/getting-started/quickstart/index.md b/docs/proxymock/getting-started/quickstart/index.md index 32d26c2d..bc0b24f7 100644 --- a/docs/proxymock/getting-started/quickstart/index.md +++ b/docs/proxymock/getting-started/quickstart/index.md @@ -1,14 +1,12 @@ --- -description: "Create a mock server and tests for your Go application with ProxyMock's quickstart guide, covering installation, traffic recording, and test execution." +description: "Create a mock server and tests for your Go application with proxymock's quickstart guide, covering installation, traffic recording, and test execution." sidebar_position: 1 --- import ArchitectureOverview from './outerspace-go.png' -# Quickstart +# Quickstart: Choose Your Path -Welcome to proxymock! - -This guide provides a step-by-step approach to creating a [mock server](/reference/glossary.md#mock-server) and tests for a simple Go application. Choose your preferred workflow below: +Welcome to proxymock! Pick the workflow that matches your environment. Each path helps you create a [mock server](/reference/glossary.md#mock-server) and tests from real traffic. ## What You'll Learn @@ -22,16 +20,17 @@ Both workflows will teach you how to: ## Choose Your Workflow -### 🖥️ Command Line Interface (CLI) -**For software engineers who prefer traditional command-line tools** +### 🖥️ Local Recording (Desktop) +Record a local service and generate mocks/tests. Best for fast, single-machine workflows. Choose CLI or MCP. -Use the proxymock CLI directly from your terminal to record traffic, create mocks, and run tests. This approach gives you full control over each step and is ideal for automation and scripting. +**[Go to Local Recording →](./local/)** -**[Start CLI Tutorial →](./quickstart-cli.md)** +### ☸️ In-Cluster Recording (Web) +Start a recording inside your Kubernetes cluster from proxymock web. Best for realistic, in-environment traffic. -### 🤖 MCP Workflow (LLM-Driven) -**For developers using AI coding assistants like Cursor, Claude, or GitHub Copilot** +**[Go to In-Cluster →](./in-cluster/)** -Leverage the power of AI coding assistants with proxymock's MCP (Model Context Protocol) integration. Simply describe what you want to do in natural language, and your LLM will execute the appropriate proxymock commands. +### 📡 Live Tail (Web) +Stream traffic live from proxymock web and selectively capture what you need for mocks and tests. -**[Start MCP Tutorial →](./quickstart-mcp.md)** +**[Go to Live Tail →](./live-tail/)** diff --git a/docs/proxymock/getting-started/quickstart/live-tail/index.mdx b/docs/proxymock/getting-started/quickstart/live-tail/index.mdx new file mode 100644 index 00000000..1b62e8f0 --- /dev/null +++ b/docs/proxymock/getting-started/quickstart/live-tail/index.mdx @@ -0,0 +1,62 @@ +--- +title: Live Tail (Web) +description: Stream live RRPairs from your cluster in proxymock web, view counters and logs, and pivot to captured requests. +--- + +# Live Tail (Web) + +Live Tail streams requests from your cluster into proxymock web in real time. Use it to observe activity, verify traffic is flowing, and pivot to the captured requests for mocking or replay. + +## Prerequisites +- proxymock web running locally: `proxymock web` +- Connected cluster in Observability (Forwarder reachable) + +## 1) Connect to your cluster + +Open Observability → Topology. If needed, use Retry to connect (auto port-forward), or switch kube context. + +![Observability → Topology with the cluster connected](../in-cluster/images/proxymock-web-observability-connect.png) + +## 2) Start a Live Tail session (workload tap) + +From the Topology view: +1) Pick a namespace, click a workload to open its pane +2) Start a live tap session for that workload (the UI provides start/stop controls) +3) Generate some load on the service + +The persistent “Live capture” card appears at the top of the content area showing broadcast/received/written counters and per-session actions. + +![Selected workload pane with Overview tab](../in-cluster/images/proxymock-web-workload-pane.png) + +![Persistent live-tap card with active session and counters](../in-cluster/images/proxymock-web-tap-card.png) + +Tips: +- The tap card shows all active sessions. Click “View” to jump to Requests scoped to that run +- Click “Stop” to end a session; previously captured data remains available + +## 3) Inspect captured requests + +Go to the Requests tab. Use the Run selector to scope to the current live-tail run; filter by host, method, path. Open details to view full request/response (headers, body, timing). + +![Requests grid with Run selector](../in-cluster/images/proxymock-web-requests-run.png) + +![Drilled-in RRPair detail pane](../in-cluster/images/proxymock-web-request-detail.png) + +## 4) Optional — Replay or mock + +With a live-tail run selected you can: +- Replay locally against a URL +- Or switch to the Replay tab and “Run in cluster” against a Workload/Service, with optional dependency mocking + +![Cluster namespace + Cluster Workload destination](../in-cluster/images/proxymock-web-replay-destination.png) + +![Run in cluster button in the replay toolbar](../in-cluster/images/proxymock-web-replay-cluster-button.png) + +## Data considerations +- Live Tail streams metadata and payloads; apply DLP when exporting to cloud +- Enterprise isolation: consider BYOC if data residency constraints apply + +## Next steps +- In-Cluster (Web): /proxymock/getting-started/quickstart/in-cluster/ +- How It Works: /proxymock/how-it-works/ +- Guides: /proxymock/guides/ diff --git a/docs/proxymock/getting-started/quickstart/local/index.mdx b/docs/proxymock/getting-started/quickstart/local/index.mdx new file mode 100644 index 00000000..df895e1f --- /dev/null +++ b/docs/proxymock/getting-started/quickstart/local/index.mdx @@ -0,0 +1,64 @@ +--- +title: Local Recording (Desktop) +description: Record locally on your desktop using proxymock CLI or MCP, then inspect and replay in proxymock web. +--- + +# Local Recording (Desktop) + +Record traffic on your machine and generate mocks/tests. Use the CLI or MCP to create a recording, then open proxymock web to explore, transform, and replay. + +## Overview +- Record with CLI or MCP on your desktop +- Inspect requests in proxymock web (Requests tab) +- Replay locally or run in cluster (optional) + +## Prerequisites +- proxymock installed (CLI) and API key configured +- Your service can run locally +- Optional: start proxymock web to browse results + +```bash title="Start the web UI (optional)" +proxymock web +# Open the printed http://127.0.0.1:XXXX URL +``` + +## Option A — CLI workflow +Follow the end-to-end CLI quickstart for recording, inspecting, mocking, and replaying: + +- Quickstart (CLI): /proxymock/getting-started/quickstart/quickstart-cli/ + +Key steps in brief: +1) Install and init: `proxymock init` +2) Record: `proxymock record -- ` +3) Exercise your app: curl/tests hit proxymock IN port (default 4143) +4) Inspect recordings in `./proxymock/recorded-*` and in proxymock web (Requests tab) +5) Mock + Replay: `proxymock mock -- ` and `proxymock replay --test-against http://localhost:8080` + +Screenshot placeholder: ./images/proxymock-web-requests-list.png + +## Option B — MCP workflow +Use your AI coding assistant (Cursor, Claude Code, Copilot Agent, etc.) to run the same steps via MCP: + +- Quickstart (MCP): /proxymock/getting-started/quickstart/quickstart-mcp/ + +Example prompts: +- “Record traffic for my service using proxymock, then show me the recorded files.” +- “Start a mock server with proxymock and replay the recorded traffic against my app.” + +## View and iterate in proxymock web + +After recording, open proxymock web (if not already running): + +1) Start: `proxymock web` → open URL +2) Requests tab: choose your `recorded-*` run from the Run selector +3) Inspect a request/response pair and apply transforms as needed + +Screenshot placeholders: +- ./images/proxymock-web-run-selector.png +- ./images/proxymock-web-request-detail.png + +## Next steps +- Run in Cluster: /proxymock/getting-started/quickstart/in-cluster/ +- Live Tail (Web): /proxymock/getting-started/quickstart/live-tail/ +- How It Works: /proxymock/how-it-works/ +- Guides: /proxymock/guides/ diff --git a/docs/proxymock/getting-started/quickstart/quickstart-cli.md b/docs/proxymock/getting-started/quickstart/quickstart-cli.md index f0a9c8a9..fe79a6b6 100644 --- a/docs/proxymock/getting-started/quickstart/quickstart-cli.md +++ b/docs/proxymock/getting-started/quickstart/quickstart-cli.md @@ -46,7 +46,7 @@ Select your environment below and all instructions will update accordingly. If y 3. Select the **"Codespaces"** tab 4. Click **"Create codespace on main"** 5. Wait for the environment to initialize (usually 1-2 minutes) - 6. Once ready, you'll have a VS Code environment in your browser with Go and ProxyMock pre-installed + 6. Once ready, you'll have a VS Code environment in your browser with Go and proxymock pre-installed @@ -100,7 +100,7 @@ For this example we'll be using a simple demo app that accepts an API request, c No need to run any install scripts: :::note Codespaces Environment - ProxyMock is automatically available in the outerspace-go Codespace. + proxymock is automatically available in the outerspace-go Codespace. ::: diff --git a/docs/proxymock/guides/cicd.md b/docs/proxymock/guides/cicd.md index 6a5b334e..01ba8a7b 100644 --- a/docs/proxymock/guides/cicd.md +++ b/docs/proxymock/guides/cicd.md @@ -1,6 +1,6 @@ --- title: CI/CD -description: "Integrate ProxyMock into your CI/CD pipeline to enhance deployment confidence with automated traffic replay and testing before production release." +description: "Integrate proxymock into your CI/CD pipeline to enhance deployment confidence with automated traffic replay and testing before production release." sidebar_position: 2 --- diff --git a/docs/proxymock/guides/docker.md b/docs/proxymock/guides/docker.md index efbca115..915d67d3 100644 --- a/docs/proxymock/guides/docker.md +++ b/docs/proxymock/guides/docker.md @@ -1,5 +1,5 @@ --- -description: "Run ProxyMock with Docker to seamlessly integrate traffic recording and mocking for your applications running in local containers with easy configuration steps" +description: "Run proxymock with Docker to seamlessly integrate traffic recording and mocking for your applications running in local containers with easy configuration steps" sidebar_position: 1 --- diff --git a/docs/proxymock/guides/grpc.md b/docs/proxymock/guides/grpc.md index 5f2606f4..67e3761d 100644 --- a/docs/proxymock/guides/grpc.md +++ b/docs/proxymock/guides/grpc.md @@ -1,6 +1,6 @@ --- title: Mock gRPC APIs -description: "Mock gRPC APIs with ProxyMock by recording traffic from your app, creating easy mocks, and exploring supported technologies for efficient API testing." +description: "Mock gRPC APIs with proxymock by recording traffic from your app, creating easy mocks, and exploring supported technologies for efficient API testing." sidebar_position: 2 --- diff --git a/docs/proxymock/guides/index.md b/docs/proxymock/guides/index.md index 53260226..a3bcac27 100644 --- a/docs/proxymock/guides/index.md +++ b/docs/proxymock/guides/index.md @@ -1,6 +1,6 @@ --- title: Guides -description: "Explore practical how-to guides for using ProxyMock effectively in your API testing and traffic replay scenarios." +description: "Explore practical how-to guides for using proxymock effectively in your API testing and traffic replay scenarios." sidebar_position: 3 --- diff --git a/docs/proxymock/guides/initialize.md b/docs/proxymock/guides/initialize.md index 1af6a625..d81a189d 100644 --- a/docs/proxymock/guides/initialize.md +++ b/docs/proxymock/guides/initialize.md @@ -1,5 +1,5 @@ --- -description: "Initialize your API key for ProxyMock by following simple command prompts, ensuring secure management with Speedscale for your development needs." +description: "Initialize your API key for proxymock by following simple command prompts, ensuring secure management with Speedscale for your development needs." sidebar_position: 1 --- diff --git a/docs/proxymock/guides/modify-rrpairs.md b/docs/proxymock/guides/modify-rrpairs.md index 185b6103..289469b7 100644 --- a/docs/proxymock/guides/modify-rrpairs.md +++ b/docs/proxymock/guides/modify-rrpairs.md @@ -1,5 +1,5 @@ --- -description: "Modify tests and mock responses in ProxyMock recordings effortlessly with this guide, ensuring updates reflect in future test runs." +description: "Modify tests and mock responses in proxymock recordings effortlessly with this guide, ensuring updates reflect in future test runs." sidebar_position: 5 --- diff --git a/docs/proxymock/guides/mongodb.md b/docs/proxymock/guides/mongodb.md index 36d8261b..8abdfe3a 100644 --- a/docs/proxymock/guides/mongodb.md +++ b/docs/proxymock/guides/mongodb.md @@ -1,5 +1,5 @@ --- -description: "Mock MongoDB database connections and queries for local development using ProxyMock to record and replay real MongoDB wire protocol traffic." +description: "Mock MongoDB database connections and queries for local development using proxymock to record and replay real MongoDB wire protocol traffic." sidebar_position: 7 --- diff --git a/docs/proxymock/guides/mysql.md b/docs/proxymock/guides/mysql.md index 102829bd..b7251738 100644 --- a/docs/proxymock/guides/mysql.md +++ b/docs/proxymock/guides/mysql.md @@ -1,5 +1,5 @@ --- -description: "Mock MySQL database connections and queries for local development using ProxyMock to streamline your API testing and enhance your testing environment." +description: "Mock MySQL database connections and queries for local development using proxymock to streamline your API testing and enhance your testing environment." sidebar_position: 6 --- diff --git a/docs/proxymock/guides/openapi.md b/docs/proxymock/guides/openapi.md index e738a1e4..497b269d 100644 --- a/docs/proxymock/guides/openapi.md +++ b/docs/proxymock/guides/openapi.md @@ -1,5 +1,5 @@ --- -description: "Generate mocks from OpenAPI specifications using ProxyMock to create instant mock API responses for rapid testing and development." +description: "Generate mocks from OpenAPI specifications using proxymock to create instant mock API responses for rapid testing and development." sidebar_position: 7 --- @@ -156,10 +156,10 @@ A: Simply edit the markdown files after generation. You can change any part of t ## Additional Resources - [OpenAPI Specification](https://swagger.io/specification/) -- [Proxymock RRPair Markdown Format](https://docs.speedscale.com/proxymock/how-it-works/rrpair-format/) +- [proxymock RRPair Markdown Format](https://docs.speedscale.com/proxymock/how-it-works/rrpair-format/) ## Summary -The OpenAPI to RRPair feature is fast way to turn your API specification into a working mock server. It's ideal for rapid development, testing, and continuous integration. Try it out today and accelerate your API workflows! Proxymock paid tier plans allow running the mock server in Kubernetes or other long lived environments. +The OpenAPI to RRPair feature is fast way to turn your API specification into a working mock server. It's ideal for rapid development, testing, and continuous integration. Try it out today and accelerate your API workflows! proxymock paid tier plans allow running the mock server in Kubernetes or other long lived environments. If you have questions or feedback, please reach out to the proxymock team in our [community](https://slack.speedscale.com). diff --git a/docs/proxymock/guides/postgres.md b/docs/proxymock/guides/postgres.md index 846f326a..71e219b4 100644 --- a/docs/proxymock/guides/postgres.md +++ b/docs/proxymock/guides/postgres.md @@ -1,5 +1,5 @@ --- -description: "Mock PostgreSQL database connections and queries for local development using ProxyMock with this comprehensive guide on recording and testing techniques." +description: "Mock PostgreSQL database connections and queries for local development using proxymock with this comprehensive guide on recording and testing techniques." sidebar_position: 8 --- diff --git a/docs/proxymock/how-it-works/architecture.md b/docs/proxymock/how-it-works/architecture.md index b55c45ea..f897160b 100644 --- a/docs/proxymock/how-it-works/architecture.md +++ b/docs/proxymock/how-it-works/architecture.md @@ -1,6 +1,6 @@ --- title: Architecture -description: "Explore the architecture of ProxyMock to understand how it captures and replays traffic for API testing without modifying your application setup" +description: "Explore the architecture of proxymock to understand how it captures and replays traffic for API testing without modifying your application setup" sidebar_position: 1 --- @@ -15,7 +15,7 @@ traffic to and from your application. Get a feel for the shape your local system with various **proxymock** configurations: - + This is probably close what your setup looks like. A client making requests to your app's API (listening on port `8080` in this case) and your app making requests to various other services, APIs, databases, etc. diff --git a/docs/proxymock/how-it-works/cli.md b/docs/proxymock/how-it-works/cli.md index c04ed4ba..14977c29 100644 --- a/docs/proxymock/how-it-works/cli.md +++ b/docs/proxymock/how-it-works/cli.md @@ -1,5 +1,5 @@ --- -description: "Explore the CLI Documentation for ProxyMock to learn how to record, mock, and replay API traffic efficiently in local and CI/CD environments with Speedscale integration" +description: "Explore the CLI Documentation for proxymock to learn how to record, mock, and replay API traffic efficiently in local and CI/CD environments with Speedscale integration" sidebar_position: 1 --- diff --git a/docs/proxymock/how-it-works/data_and_privacy.md b/docs/proxymock/how-it-works/data_and_privacy.md index 4881dff0..a4baa671 100644 --- a/docs/proxymock/how-it-works/data_and_privacy.md +++ b/docs/proxymock/how-it-works/data_and_privacy.md @@ -1,6 +1,6 @@ --- title: Data and Privacy -description: "Ensure data security and privacy with ProxyMock, which handles your data responsibly and complies with strict best practices during API testing." +description: "Ensure data security and privacy with proxymock, which handles your data responsibly and complies with strict best practices during API testing." sidebar_position: 11 --- diff --git a/docs/proxymock/how-it-works/index.md b/docs/proxymock/how-it-works/index.md index 3679954c..3a93e4f2 100644 --- a/docs/proxymock/how-it-works/index.md +++ b/docs/proxymock/how-it-works/index.md @@ -1,5 +1,5 @@ --- -description: "Discover how ProxyMock captures real traffic through a proxy to create automated mocks and tests without changing your application code." +description: "Discover how proxymock captures real traffic through a proxy to create automated mocks and tests without changing your application code." sidebar_position: 3 --- diff --git a/docs/proxymock/how-it-works/license.md b/docs/proxymock/how-it-works/license.md index 9a472546..8a57203d 100644 --- a/docs/proxymock/how-it-works/license.md +++ b/docs/proxymock/how-it-works/license.md @@ -1,6 +1,6 @@ --- title: License -description: "Review the licensing terms for ProxyMock, including the End User License Agreement and usage restrictions for the closed-source CLI and open-source extension." +description: "Review the licensing terms for proxymock, including the End User License Agreement and usage restrictions for the closed-source CLI and open-source extension." sidebar_position: 1000 --- diff --git a/docs/proxymock/how-it-works/lifecycle.md b/docs/proxymock/how-it-works/lifecycle.md index bd27b188..c27be996 100644 --- a/docs/proxymock/how-it-works/lifecycle.md +++ b/docs/proxymock/how-it-works/lifecycle.md @@ -1,5 +1,5 @@ --- -description: "Explore the Lifecycle of ProxyMock to learn how to record, replay, and manage traffic for effective API testing and mocking with Speedscale." +description: "Explore the Lifecycle of proxymock to learn how to record, replay, and manage traffic for effective API testing and mocking with Speedscale." sidebar_position: 2 --- diff --git a/docs/proxymock/how-it-works/mcp.md b/docs/proxymock/how-it-works/mcp.md index d126d36c..17a8feeb 100644 --- a/docs/proxymock/how-it-works/mcp.md +++ b/docs/proxymock/how-it-works/mcp.md @@ -1,5 +1,5 @@ --- -description: "Explore the Model Context Protocol (MCP) for ProxyMock to enable seamless integration with AI tools and enhance your API testing and mocking capabilities." +description: "Explore the Model Context Protocol (MCP) for proxymock to enable seamless integration with AI tools and enhance your API testing and mocking capabilities." sidebar_position: 6 --- @@ -87,7 +87,7 @@ The `proxymock init` command should automatically check for the presence of comm :::info -If the `proxymock init` command fails or you are using an unknown IDE, you can manually configure the ProxyMock MCP server by modifying your client's `mcp.json`. This should not be necessary for most users. +If the `proxymock init` command fails or you are using an unknown IDE, you can manually configure the proxymock MCP server by modifying your client's `mcp.json`. This should not be necessary for most users. ```json { diff --git a/docs/proxymock/how-it-works/rrpair-format.md b/docs/proxymock/how-it-works/rrpair-format.md index 86156a45..633f99e3 100644 --- a/docs/proxymock/how-it-works/rrpair-format.md +++ b/docs/proxymock/how-it-works/rrpair-format.md @@ -1,6 +1,6 @@ --- title: File Format -description: "Explore the RRPair markdown format in ProxyMock for recording and replaying API traffic with Speedscale, ensuring human readability and easy debugging." +description: "Explore the RRPair markdown format in proxymock for recording and replaying API traffic with Speedscale, ensuring human readability and easy debugging." sidebar_position: 7 --- diff --git a/docs/proxymock/how-it-works/signature.md b/docs/proxymock/how-it-works/signature.md index 05783eeb..0cf99975 100644 --- a/docs/proxymock/how-it-works/signature.md +++ b/docs/proxymock/how-it-works/signature.md @@ -1,6 +1,6 @@ --- title: Signature Matching -description: "Implement signature matching with ProxyMock to create realistic service mocks that accurately simulate external APIs and databases for your testing environment" +description: "Implement signature matching with proxymock to create realistic service mocks that accurately simulate external APIs and databases for your testing environment" sidebar_position: 3 --- diff --git a/docs/proxymock/index.md b/docs/proxymock/index.md index 7394f439..d11fa99e 100644 --- a/docs/proxymock/index.md +++ b/docs/proxymock/index.md @@ -1,5 +1,5 @@ --- -description: "Create a sandbox for testing your Go application with ProxyMock, featuring automatic test generation and a mock server setup in just 30 seconds." +description: "Create a sandbox for testing your Go application with proxymock, featuring automatic test generation and a mock server setup in just 30 seconds." sidebar_position: 1 --- import Tabs from '@theme/Tabs'; @@ -17,7 +17,7 @@ import { # Overview -This guide is the Proxymock entry point. Start with the install and quickstart flow, or jump straight to the language-specific first-success path that matches your app. +This guide is the proxymock entry point. Start with the install and quickstart flow, or jump straight to the language-specific first-success path that matches your app. ## [Getting started in 30 seconds](./getting-started/quickstart) {#getting-started} diff --git a/docs/quick-start.md b/docs/quick-start.md index 521d340a..ead3d28e 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -11,7 +11,7 @@ import ApiKey from './getting-started/installation/install/api-key.png' # Quick Start :::info Local installation -For local development and testing without a cloud cluster, use **proxymock** to run a local mock server and generate tests from your traffic. See **[Local Development (AI) – Getting Started](/proxymock/)** to install proxymock and get started in about 30 seconds. +For local development and testing without a cloud cluster, use **proxymock** to run a local mock server and generate tests from your traffic. See **[Local Development – Getting Started](/proxymock/)** to install proxymock and get started in about 30 seconds. ::: :::tip Security options diff --git a/docs/reference/languages/dotnet.md b/docs/reference/languages/dotnet.md index 5bdc7a27..ca7271b7 100644 --- a/docs/reference/languages/dotnet.md +++ b/docs/reference/languages/dotnet.md @@ -1,6 +1,6 @@ --- title: .NET -description: ".NET guidance for Speedscale and Proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." +description: ".NET guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." sidebar_position: 2 --- @@ -8,10 +8,10 @@ import ProxymockLanguageWorkflow from '@site/src/components/ProxymockLanguageWor # .NET -.NET is fully supported by Speedscale. Use this page for .NET-specific proxy settings, TLS trust configuration, demo guidance, and the Proxymock local workflow. +.NET is fully supported by Speedscale. Use this page for .NET-specific proxy settings, TLS trust configuration, demo guidance, and the proxymock local workflow. - Support matrix: [Technology Support](/reference/technology-support) -- Shared Proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) +- Shared proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) ## Kubernetes Sidecar @@ -38,15 +38,15 @@ See [Proxy Modes](/getting-started/installation/sidecar/proxy-modes.md) and - Local run: `dotnet run` - Quick validation: `curl http://localhost:5128/health` -This is the current public .NET demo used for local Proxymock examples. +This is the current public .NET demo used for local proxymock examples. -## Proxymock {#proxymock} +## proxymock {#proxymock} ` only for CI or other headless environments.', diff --git a/docs/reference/languages/golang.md b/docs/reference/languages/golang.md index 1a25f750..d5510383 100644 --- a/docs/reference/languages/golang.md +++ b/docs/reference/languages/golang.md @@ -1,6 +1,6 @@ --- title: Go -description: "Go guidance for Speedscale and Proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." +description: "Go guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." sidebar_position: 4 --- @@ -8,10 +8,10 @@ import ProxymockLanguageWorkflow from '@site/src/components/ProxymockLanguageWor # Go -Go is fully supported by Speedscale. Use this page for Go-specific proxy settings, TLS trust configuration, demo guidance, and the Proxymock local workflow. +Go is fully supported by Speedscale. Use this page for Go-specific proxy settings, TLS trust configuration, demo guidance, and the proxymock local workflow. - Support matrix: [Technology Support](/reference/technology-support) -- Shared Proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) +- Shared proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) ## Kubernetes Sidecar @@ -34,15 +34,15 @@ See [Proxy Modes](/getting-started/installation/sidecar/proxy-modes.md) and - Local run: `go run main.go` - Quick validation: `./tests/run_http_tests.sh --recording` -This is the canonical public Go demo for the Proxymock quickstart and local replay workflow. +This is the canonical public Go demo for the proxymock quickstart and local replay workflow. -## Proxymock {#proxymock} +## proxymock {#proxymock} ` only for CI or other headless environments.', @@ -52,7 +52,7 @@ proxymock init`, command: `git clone https://github.com/speedscale/outerspace-go cd outerspace-go proxymock record -- go run main.go`, - note: 'Proxymock records the app while it starts the Go service as a child process.', + note: 'proxymock records the app while it starts the Go service as a child process.', }, { title: 'Generate one real workflow', diff --git a/docs/reference/languages/java.md b/docs/reference/languages/java.md index 6a3f72ed..2ccb56f9 100644 --- a/docs/reference/languages/java.md +++ b/docs/reference/languages/java.md @@ -1,6 +1,6 @@ --- title: Java -description: "Java guidance for Speedscale and Proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." +description: "Java guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." sidebar_position: 1 --- @@ -8,10 +8,10 @@ import ProxymockLanguageWorkflow from '@site/src/components/ProxymockLanguageWor # Java -Java is fully supported by Speedscale. Use this page for Java-specific proxy settings, TLS trust configuration, demo guidance, and the Proxymock local workflow. +Java is fully supported by Speedscale. Use this page for Java-specific proxy settings, TLS trust configuration, demo guidance, and the proxymock local workflow. - Support matrix: [Technology Support](/reference/technology-support) -- Shared Proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) +- Shared proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) - Shared sidecar docs: [Proxy Modes](/getting-started/installation/sidecar/proxy-modes.md) and [TLS Support](/getting-started/installation/sidecar/tls.md) - GKE Autopilot guidance: [GCP](/guides/integrations/gcp.md) @@ -23,7 +23,7 @@ Quick links: - [Transparent sidecar](#transparent-sidecar) - [Dual sidecar](#dual-sidecar) - [TLS Trust](#tls-trust) -- [Proxymock](#proxymock) +- [proxymock](#proxymock) ## eBPF / Java Agent {#ebpf-java-agent} @@ -131,10 +131,10 @@ How that trust is configured depends on the capture mode: value. - Dual sidecar: truststore configuration alone is not enough. You also need the Java proxy flags shown in [Dual Sidecar](#dual-sidecar). -- Proxymock: use the local truststore flags shown in the shared +- proxymock: use the local truststore flags shown in the shared [Language Configuration](/proxymock/getting-started/language-reference#tls-trust) page. -## Proxymock {#proxymock} +## proxymock {#proxymock} Use this for local development and CI. Conceptually this is similar to dual proxy mode because Java sends traffic through a forward proxy and trusts the proxymock CA, but it does not use Kubernetes annotations. @@ -146,13 +146,13 @@ traffic through a forward proxy and trusts the proxymock CA, but it does not use - Local run: `make local` - Traffic generator: `make client` or `make client-capture` -This is the current public Java demo used for local Proxymock examples. +This is the current public Java demo used for local proxymock examples. ` only for CI or other headless environments.', diff --git a/docs/reference/languages/nodejs.md b/docs/reference/languages/nodejs.md index f968cb1e..d88f4a14 100644 --- a/docs/reference/languages/nodejs.md +++ b/docs/reference/languages/nodejs.md @@ -1,6 +1,6 @@ --- title: Node.js -description: "Node.js guidance for Speedscale and Proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." +description: "Node.js guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." sidebar_position: 3 --- @@ -8,10 +8,10 @@ import ProxymockLanguageWorkflow from '@site/src/components/ProxymockLanguageWor # Node.js -Node.js is fully supported by Speedscale, but proxy behavior depends on the HTTP client library. Use this page for Node-specific proxy settings, TLS trust configuration, demo guidance, and the Proxymock local workflow. +Node.js is fully supported by Speedscale, but proxy behavior depends on the HTTP client library. Use this page for Node-specific proxy settings, TLS trust configuration, demo guidance, and the proxymock local workflow. - Support matrix: [Technology Support](/reference/technology-support) -- Shared Proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) +- Shared proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) ## Kubernetes Sidecar @@ -39,15 +39,15 @@ See [Proxy Modes](/getting-started/installation/sidecar/proxy-modes.md) and - Local run: `npm install && npm start` - Quick validation: `curl http://localhost:3000/` -This is the current public Node.js demo used for local Proxymock examples. +This is the current public Node.js demo used for local proxymock examples. -## Proxymock {#proxymock} +## proxymock {#proxymock} ` only for CI or other headless environments.', diff --git a/docs/reference/languages/python.md b/docs/reference/languages/python.md index d77fccb2..96139eba 100644 --- a/docs/reference/languages/python.md +++ b/docs/reference/languages/python.md @@ -1,6 +1,6 @@ --- title: Python -description: "Python guidance for Speedscale and Proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." +description: "Python guidance for Speedscale and proxymock, including proxy setup, TLS trust, demo app details, and a first-success workflow." sidebar_position: 5 --- @@ -8,10 +8,10 @@ import ProxymockLanguageWorkflow from '@site/src/components/ProxymockLanguageWor # Python -Python is fully supported by Speedscale. Use this page for Python-specific proxy settings, TLS trust configuration, demo guidance, and the Proxymock local workflow. +Python is fully supported by Speedscale. Use this page for Python-specific proxy settings, TLS trust configuration, demo guidance, and the proxymock local workflow. - Support matrix: [Technology Support](/reference/technology-support) -- Shared Proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) +- Shared proxymock proxy reference: [Language Configuration](/proxymock/getting-started/language-reference) ## Kubernetes Sidecar @@ -38,15 +38,15 @@ See [Proxy Modes](/getting-started/installation/sidecar/proxy-modes.md) and - Local run: `make local` - Traffic generator: `make capture` -This is the current public Python demo used for local Proxymock examples. +This is the current public Python demo used for local proxymock examples. -## Proxymock {#proxymock} +## proxymock {#proxymock} ` only for CI or other headless environments.', }, @@ -63,7 +63,7 @@ This is the current public Python demo used for local Proxymock examples. { title: 'Capture a real workflow', command: `cd demo/python\nmake capture`, - note: 'The capture flow records outbound SpaceX traffic through Proxymock.', + note: 'The capture flow records outbound SpaceX traffic through proxymock.', }, { title: 'Run with mocks', diff --git a/docs/reference/pricing-faq.md b/docs/reference/pricing-faq.md index 9b200e4f..fcbd4056 100644 --- a/docs/reference/pricing-faq.md +++ b/docs/reference/pricing-faq.md @@ -71,7 +71,7 @@ Limit sidecar injection to namespaces, clusters, or services with active testing Yes. Speedscale offers the ability to: - **Record once, replay many times**: Replays of previously recorded traffic do not count as new ingest, although the test artifacts will cause some minor ingest. -- **Use local Proxymock recordings**: Capture and replay traffic locally during development without involving the sidecar or ingesting data into the Speedscale cloud. Limits apply but this is a good option for quick local regressions. +- **Use local proxymock recordings**: Capture and replay traffic locally during development without involving the sidecar or ingesting data into the Speedscale cloud. Limits apply but this is a good option for quick local regressions. You can see current and historical usage by navigating to **Settings > Usage** in the Speedscale UI. Detailed breakdowns by service and namespace are available for the last seven days to help identify cost centers. Click on the main navigation -> Services for a list of services that have reported traffic in the last seven days. diff --git a/docs/reference/release-notes.md b/docs/reference/release-notes.md index 1b9af04d..0b9f2f25 100644 --- a/docs/reference/release-notes.md +++ b/docs/reference/release-notes.md @@ -425,7 +425,7 @@ This file is autogenerated, do not try to modify it manually. * S-11189 export: add Gatling simulation format * SPD-4886 proto: Deprecate cookies field in HTTP protobufs * SPD-9906 cli: add errors to proxymock replay pretty output -* SPD-9489 Proxymock responder immediate response +* SPD-9489 proxymock responder immediate response * SPD-9400 Add better error handling for proxymock app-port * S-11348 refactor: preparing for new linter * S-11346 Add specialized apply recommendations task @@ -2052,7 +2052,7 @@ This file is autogenerated, do not try to modify it manually. * SPD-8984 turn on log streaming in lower environments * SPD-9014 re-enable diagnostics uploads * SPD-9064 set forwarder keepalive enforcement policy -* SPD-9051 remove snapshotID requirement for proxyMock +* SPD-9051 remove snapshotID requirement for proxymock * SPD-8973 add local VSCode recorder * SPD-9048 remove the atomicx library since the go std lib added this functionality * SPD-9028 fix snapshot processing details during analysis diff --git a/docusaurus.config.js b/docusaurus.config.js index ff0d0b03..014b8202 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -54,7 +54,19 @@ const config = { }, { from: "/proxymock/getting-started/quickstart-cli/", - to: "/proxymock/getting-started/quickstart/quickstart-cli/", + to: "/proxymock/getting-started/quickstart/local/", + }, + { + from: "/proxymock/getting-started/quickstart/quickstart-cli/", + to: "/proxymock/getting-started/quickstart/local/", + }, + { + from: "/proxymock/getting-started/quickstart/quickstart-mcp/", + to: "/proxymock/getting-started/quickstart/local/", + }, + { + from: "/proxymock/getting-started/quickstart-mcp/", + to: "/proxymock/getting-started/quickstart/local/", }, { from: "/proxymock/getting-started/api-key/", diff --git a/scripts/generate_metadescriptions.mjs b/scripts/generate_metadescriptions.mjs index afbf7091..d7318b4c 100644 --- a/scripts/generate_metadescriptions.mjs +++ b/scripts/generate_metadescriptions.mjs @@ -103,7 +103,7 @@ async function generateDescription(title, plainText) { content: `You write SEO meta descriptions for technical documentation pages. Rules: - Exactly 1 sentence, 130-155 characters (hard limit) - Start with an action verb or the main topic -- Include the product name "Speedscale" or "ProxyMock" when relevant +- Include the product name "Speedscale" or "proxymock" when relevant - Be specific about what the page covers - No quotes, no markdown, no trailing period - Write for developers searching for API testing, traffic replay, or mocking solutions`, diff --git a/sidebars.js b/sidebars.js index b61eec90..5e33eb9a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -132,7 +132,7 @@ const sidebars = { }, { type: "category", - label: "Local Development (AI)", + label: "Local Development", items: [ "proxymock/index", { @@ -140,19 +140,20 @@ const sidebars = { label: "Getting Started", items: [ "proxymock/getting-started/installation", - "proxymock/getting-started/faq", - "proxymock/getting-started/help", - "proxymock/getting-started/language-reference", { type: "category", label: "Quickstart", items: [ "proxymock/getting-started/quickstart/index", - "proxymock/getting-started/quickstart/quickstart-cli", - "proxymock/getting-started/quickstart/quickstart-mcp", + "proxymock/getting-started/quickstart/local/index", + "proxymock/getting-started/quickstart/in-cluster/index", + "proxymock/getting-started/quickstart/live-tail/index", ], collapsed: true, }, + "proxymock/getting-started/faq", + "proxymock/getting-started/help", + "proxymock/getting-started/language-reference", ], collapsed: true, }, diff --git a/src/components/Cards/LearningResourcesCard.js b/src/components/Cards/LearningResourcesCard.js index 155b3ac5..6f5d78d4 100644 --- a/src/components/Cards/LearningResourcesCard.js +++ b/src/components/Cards/LearningResourcesCard.js @@ -20,7 +20,7 @@ const LearningResourcesCard = () => { MCP Guide Best Practices - Proxymock Docs + proxymock Docs ); diff --git a/src/theme/DocItem/Metadata/index.js b/src/theme/DocItem/Metadata/index.js index 635fba7f..fb4c2bf5 100644 --- a/src/theme/DocItem/Metadata/index.js +++ b/src/theme/DocItem/Metadata/index.js @@ -36,7 +36,7 @@ function getArticleSection(permalink) { if (path.includes('/guides/')) return 'Guides'; if (path.includes('/reference/')) return 'Reference'; if (path.includes('/security/')) return 'Security'; - if (path.includes('/proxymock/')) return 'ProxyMock'; + if (path.includes('/proxymock/')) return 'proxymock'; if (path.includes('/qabot/')) return 'QABot'; return 'Documentation'; }