docs: mi/3419/rafiki testnet deploy #3586

hajjimo · 2025-08-01T19:45:32Z

Addresses issue docs: Add a deployment guide using Test Network #3419
Related issues linked using fixes #number
Tests added/updated
Make sure that all checks pass
Bruno collection updated (if necessary)
Documentation issue created with user-docs label (if necessary)
OpenAPI specs updated (if necessary)

netlify · 2025-08-01T19:45:36Z

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Name	Link
🔨 Latest commit	`78cb805`
🔍 Latest deploy log	https://app.netlify.com/projects/brilliant-pasca-3e80ec/deploys/689da5cfbc07d000083a0371
😎 Deploy Preview	https://deploy-preview-3586--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

github-actions · 2025-08-01T19:50:06Z

🚀 Performance Test Results

Test Configuration:

VUs: 4
Duration: 1m0s

Test Metrics:

Requests/s: 39.81
Iterations/s: 13.28
Failed Requests: 0.00% (0 of 2396)

📜 Logs


> performance@1.0.0 run-tests:testenv /home/runner/work/rafiki/rafiki/test/performance
> ./scripts/run-tests.sh -e test "-k" "-q" "--vus" "4" "--duration" "1m"

Cloud Nine GraphQL API is up: http://localhost:3101/graphql
Cloud Nine Wallet Address is up: http://localhost:3100/
Happy Life Bank Address is up: http://localhost:4100/
cloud-nine-wallet-test-backend already set
cloud-nine-wallet-test-auth already set
happy-life-bank-test-backend already set
happy-life-bank-test-auth already set
     data_received..................: 865 kB 14 kB/s
     data_sent......................: 1.8 MB 31 kB/s
     http_req_blocked...............: avg=7.36µs   min=2.41µs   med=5.61µs   max=1.41ms   p(90)=6.61µs   p(95)=7.14µs  
     http_req_connecting............: avg=706ns    min=0s       med=0s       max=1.09ms   p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=99.74ms  min=6.89ms   med=87.47ms  max=566.44ms p(90)=169.64ms p(95)=195.42ms
       { expected_response:true }...: avg=99.74ms  min=6.89ms   med=87.47ms  max=566.44ms p(90)=169.64ms p(95)=195.42ms
     http_req_failed................: 0.00%  ✓ 0         ✗ 2396
     http_req_receiving.............: avg=95.29µs  min=25.71µs  med=82.94µs  max=1.65ms   p(90)=121.43µs p(95)=152.48µs
     http_req_sending...............: avg=40.09µs  min=9.85µs   med=30.35µs  max=3.16ms   p(90)=43.58µs  p(95)=57.54µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=99.61ms  min=6.77ms   med=87.35ms  max=566.32ms p(90)=169.53ms p(95)=195.3ms 
     http_reqs......................: 2396   39.813177/s
     iteration_duration.............: avg=300.82ms min=181.03ms med=291.65ms max=1.14s    p(90)=366.4ms  p(95)=396.89ms
     iterations.....................: 799    13.276598/s
     vus............................: 4      min=4       max=4 
     vus_max........................: 4      min=4       max=4

hajjimo · 2025-08-01T20:24:22Z

Backend test is failing, which may be related to the issue Max posted about in the #rafiki-team channel in Slack.

The preview link does display the updates:

Deployment Example (new menu item )
--> Overview (01-architecture-overview.mdx)
--> Configuration variables (02-configuration-variables.mdx)
--> Secrets management (03-services-management.mdx)
--> Infrastructure setup (04-infrastructure-setup.mdx)
--> Services deployment (05-services-deployment.mdx)
--> Troubleshooting (06-troubleshooting.mdx)

This reverts commit 1f3278f.

melissahenderson · 2025-08-11T15:33:06Z

packages/documentation/astro.config.mjs

          ]
        },
+        {
+          label: 'Deployment example',


My gut says that the deployment example should be a child section under Deploy Rafiki, but let's talk about that later, when you're ready to merge.

I agree it should be a child section under Deploy Rafiki. I made it a different section in anticipation of the end-to-end guide for the wallet app. However, I wonder if the team will feel that this guide is unnecessary once the wallet guide is available, because the Test network architecture shouldn't be suggested as a production deployment.

packages/documentation/src/content/docs/integration/deploy-to-prod/01-architecture-overview.mdx

melissahenderson · 2025-08-11T15:45:41Z

packages/documentation/src/content/docs/integration/deploy-to-prod/01-architecture-overview.mdx

+- **Auth server** (`auth.your-wallet.com`): Handles <LinkOut href='openpayments.dev'>Open Payments</LinkOut> authentication and authorization
+- **Backend** (`backend.your-wallet.com`): Core Interledger protocol implementation
+- **Admin API** (`admin.your-wallet.com`): Administrative functions and account management via GraphQL API
+- **Database**: Stores Interledger accounts, payment pointers, and transaction data


Should wallet addresses be part of this, too? I'm not sure if this is for payment pointers only, since it's Interledger.

Good point. I'll update this to wallet addresses instead.

packages/documentation/src/content/docs/integration/deploy-to-prod/06-troubleshooting.mdx

melissahenderson · 2025-08-11T16:08:55Z

...ges/documentation/src/content/docs/integration/deploy-to-prod/02-configuration-variables.mdx

+| `project_id`             | -                       | Yes      | GCP Project ID where resources will be created        |
+| `region`                 | `us-central1`           | No       | Primary GCP region for cluster and resources          |
+| `cluster_name`           | `rafiki-wallet-cluster` | No       | Name of the GKE cluster                               |
+| `domain_name`            | -                       | Yes      | Primary domain for your wallet (e.g., `mywallet.com`) |


Can you move this higher in the table, so the two required variables are one after the other?

melissahenderson · 2025-08-11T16:11:55Z

...ges/documentation/src/content/docs/integration/deploy-to-prod/02-configuration-variables.mdx

+
+<div class="overflow-table">
+
+| Record Type | Name                         | Value            | TTL |


Just a thought - Since all the record types are A records, you might be able to change the section title from DNS record configuration to DNS A record configuration (I can see how that may look a bit odd) and get rid of the Record Type column completely.

melissahenderson · 2025-08-11T16:12:20Z

...ges/documentation/src/content/docs/integration/deploy-to-prod/02-configuration-variables.mdx

+- `YOUR_PROJECT_ID` - Replace with your GCP project ID
+- `YOUR_REGISTRY` - Replace with your container registry
+- `YOUR_EMAIL` - Replace with your administrative email
+- `<generated-secret>` - Generate using `openssl rand -base64 32` (see Secrets Management guide)


Link to Secrets Management guide

melissahenderson · 2025-08-11T16:21:23Z

packages/documentation/src/content/docs/integration/deploy-to-prod/05-services-deployment.mdx

+
+Your deployed services are available at these URLs:
+
+| Service            | URL                                | Purpose                        |


Should the items in the URL column be wrapped in back ticks? I'm not saying they should be.

hajjimo added 2 commits July 28, 2025 14:08

docs: mi/3419/rafiki-testnet-deploy

15af72c

docs: mi/3149/deployment-example

f021ed7

hajjimo added the user-docs label Aug 1, 2025

github-actions bot added the pkg: documentation Changes in the documentation package. label Aug 1, 2025

hajjimo requested review from bosbaber, golobitch and beniaminmunteanu and removed request for bosbaber, golobitch and beniaminmunteanu August 1, 2025 19:46

docs: mi/3419/rafiki-testnet-deployment-guide

75b09c8

hajjimo changed the title ~~Mi/3419/rafiki testnet deploy~~ docs: mi/3419/rafiki testnet deploy Aug 1, 2025

hajjimo requested a review from melissahenderson August 1, 2025 20:16

hajjimo requested review from bosbaber, beniaminmunteanu and golobitch August 4, 2025 10:13

hajjimo and others added 2 commits August 6, 2025 11:48

Merge branch 'main' into mi/3419/rafiki-testnet-deploy

d141aec

test(backend): update actionable incoming payment test

1f3278f

github-actions bot added type: tests Testing related pkg: backend Changes in the backend package. type: source Changes business logic labels Aug 6, 2025

Revert "test(backend): update actionable incoming payment test"

7a3910c

This reverts commit 1f3278f.

github-actions bot removed type: tests Testing related pkg: backend Changes in the backend package. type: source Changes business logic labels Aug 6, 2025

hajjimo marked this pull request as ready for review August 6, 2025 11:35

melissahenderson reviewed Aug 11, 2025

View reviewed changes

docs: mi/3419/rafiki-testnet-deploy

78cb805

hajjimo requested a review from melissahenderson August 14, 2025 09:08

melissahenderson approved these changes Aug 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: mi/3419/rafiki testnet deploy #3586

docs: mi/3419/rafiki testnet deploy #3586

Uh oh!

hajjimo commented Aug 1, 2025 •

edited

Loading

Uh oh!

netlify bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

hajjimo commented Aug 1, 2025

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

hajjimo Aug 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

hajjimo Aug 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

melissahenderson Aug 11, 2025

Uh oh!

Uh oh!


		<div class="overflow-table">

		\| Record Type \| Name \| Value \| TTL \|


		Your deployed services are available at these URLs:

		\| Service \| URL \| Purpose \|

docs: mi/3419/rafiki testnet deploy #3586

Are you sure you want to change the base?

docs: mi/3419/rafiki testnet deploy #3586

Uh oh!

Conversation

hajjimo commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Uh oh!

github-actions bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Performance Test Results

Uh oh!

hajjimo commented Aug 1, 2025

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

hajjimo Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

hajjimo Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

melissahenderson Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hajjimo commented Aug 1, 2025 •

edited

Loading

netlify bot commented Aug 1, 2025 •

edited

Loading

github-actions bot commented Aug 1, 2025 •

edited

Loading

hajjimo Aug 14, 2025 •

edited

Loading

hajjimo Aug 14, 2025 •

edited

Loading