Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Documentation/guides/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ title: Deploy Prompter
description: How Prompter runs in production and where to find the operational runbook.
---

Prompter runs in production on the Cratis UpCloud Kubernetes cluster that also hosts Studio (decision
[D-11](https://github.com/Cratis/Prompter/blob/main/Planning/DECISIONS.md)). This page is the map; the
step-by-step runbook - workflows, Pulumi, secrets, operations - is
[DEPLOYMENT.md](https://github.com/Cratis/Prompter/blob/main/Planning/DEPLOYMENT.md), which is the source of
truth.
Prompter runs in production on the Cratis UpCloud Kubernetes cluster that also hosts Studio. This page is
the map; the public [deployment project guide](https://github.com/Cratis/Prompter/blob/main/Deployment/README.md)
covers the Pulumi stack, configuration, first deploy, and release workflow.

## You can run it anywhere with internet

Expand All @@ -26,8 +24,10 @@ laptop or a cluster. The artifacts are the same at every stage, so nothing is th
Prompter is a single-replica Kubernetes Deployment - the Discord gateway wants exactly one connection -
alongside an in-cluster Postgres with pgvector, in the Norway region. Keeping stored data on EU-jurisdiction
infrastructure strengthens the [privacy](../concepts/privacy.md) posture. It exposes `GET /healthz` for probes
and `POST /reindex` (shared secret) for documentation refreshes. The full topology, deploy flow, and one-time
setup live in [DEPLOYMENT.md](https://github.com/Cratis/Prompter/blob/main/Planning/DEPLOYMENT.md).
and `POST /reindex` (shared secret) for documentation refreshes. Follow the
[first-deploy steps](https://github.com/Cratis/Prompter/blob/main/Deployment/README.md#first-deploy) to configure
the existing cluster and host, supply encrypted secrets, preview the stack, and deploy it. Index the corpus
once after the first deploy and complete [Discord app setup](discord-setup.md) before inviting questions.

## Documentation changes never redeploy

Expand Down
10 changes: 5 additions & 5 deletions Documentation/guides/discord-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ description: Register Prompter's Discord application, enable the Message Content

This runbook registers Prompter's Discord application, invites the bot into a server, and points it at the
right channels. Prompter **dials out** to Discord over a gateway connection, so no inbound ports or public IP
are needed - only a bot token and the channel IDs. The behavior these steps enable is specified in the
[Discord integration contract](https://github.com/Cratis/Prompter/blob/main/Planning/DISCORD_INTEGRATION.md),
which is the authoritative runbook; this page is its published summary.
are needed - only a bot token and the channel IDs. For the supported ways to ask questions and read the
answers, see [Use Prompter on Discord](using-prompter.md).

## Before you begin

Expand Down Expand Up @@ -72,5 +71,6 @@ to match. NetCord registers the `/ask` slash command on startup; global registra
propagate the first time, while guild-scoped registration is instant - prefer guild-scoped while iterating on a
test server.

For the full behavior contract - every surface, the answer format, rate limiting, and refusals - see the
[Discord integration contract](https://github.com/Cratis/Prompter/blob/main/Planning/DISCORD_INTEGRATION.md).
For the supported surfaces, answer format, rate limiting, and refusals, see
[Use Prompter on Discord](using-prompter.md). [Grounded answers](../concepts/grounded-answers.md) explains
how citations and refusals keep answers tied to the documentation.
4 changes: 2 additions & 2 deletions Documentation/guides/running-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ retrieval quality. The command exits non-zero when Prompter refuses, so it works

## Run the Discord bot

Create a bot application on a private test server first - the setup steps live in the repository's
[Discord integration runbook](https://github.com/Cratis/Prompter/blob/main/Planning/DISCORD_INTEGRATION.md).
Create a bot application on a private test server first - follow
[Set up the Discord app](discord-setup.md).
Then:

```bash
Expand Down
Loading