Skip to content

docs: update docker compose#3405

Merged
brad-dow merged 3 commits intomainfrom
docs-docker-compose-3379
Apr 28, 2025
Merged

docs: update docker compose#3405
brad-dow merged 3 commits intomainfrom
docs-docker-compose-3379

Conversation

@brad-dow
Copy link
Copy Markdown
Contributor

Adding 3 partials (copied from existing partials with Helm column and default column rermoved, and a-z order):

  • Auth service
  • Backend service
  • Frontend service

Changing all instances of “Compose” to capitalized (based on usage from official Docker docs)

Split the Docker Compose file into multiple pieces by services

  • Auth
  • Backend
  • Frontend
  • Tigerbeetle
  • Postgres
  • Redis
  • Kratos
  • Networks & Volumes

Fixes #3379

Created 3 new partials, split the docker compose sample into multiple snippets
@github-actions github-actions Bot added the pkg: documentation Changes in the documentation package. label Apr 18, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 18, 2025

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit f3400d1
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/680a99d64d596d0008f12250
😎 Deploy Preview https://deploy-preview-3405--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 18, 2025

🚀 Performance Test Results

Test Configuration:

  • VUs: 4
  • Duration: 1m0s

Test Metrics:

  • Requests/s: 38.91
  • Iterations/s: 12.98
  • Failed Requests: 0.00% (0 of 2342)
📜 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..................: 816 kB 14 kB/s
     data_sent......................: 1.7 MB 28 kB/s
     http_req_blocked...............: avg=8.08µs   min=2.23µs   med=5.62µs   max=2.15ms   p(90)=7.01µs   p(95)=7.67µs  
     http_req_connecting............: avg=390ns    min=0s       med=0s       max=357.95µs p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=102.03ms min=13.52ms  med=87.61ms  max=589.92ms p(90)=175.22ms p(95)=196.84ms
       { expected_response:true }...: avg=102.03ms min=13.52ms  med=87.61ms  max=589.92ms p(90)=175.22ms p(95)=196.84ms
     http_req_failed................: 0.00%  ✓ 0         ✗ 2342
     http_req_receiving.............: avg=94.29µs  min=27.52µs  med=86.16µs  max=963.23µs p(90)=124.89µs p(95)=151.81µs
     http_req_sending...............: avg=40.44µs  min=10.17µs  med=28.67µs  max=4.59ms   p(90)=45.91µs  p(95)=61.74µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=101.9ms  min=13.29ms  med=87.42ms  max=589.82ms p(90)=175.09ms p(95)=196.73ms
     http_reqs......................: 2342   38.912501/s
     iteration_duration.............: avg=307.79ms min=189.21ms med=296.93ms max=1.15s    p(90)=371.6ms  p(95)=399.82ms
     iterations.....................: 781    12.976372/s
     vus............................: 4      min=4       max=4 
     vus_max........................: 4      min=4       max=4 

Copy link
Copy Markdown
Contributor

@melissahenderson melissahenderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've commented on your pieces, but reading through, there were a few other thoughts I had. We can't comment in the file on things that haven't changed.

  • The table and note in the Domains and subdomains setup section is basically the same as what's in the Update DNS records section. Could these two somehow be consolidated?
  • For the Domains and subdomains setup table, if the "function" column was renamed "Exposes", then the use of "exposes" in each description could come out.
  • All tables should use consistent capitalization in the headers.
  • Might need a dev's feedback, but I was thinking about how usable the code block is in the Set up symbolic links section. Could you copy the whole code block (as it's set up today) and paste it into the terminal and have it work? If yes, we're good. If no, then each command should be in its own code block.

Comment thread packages/documentation/src/content/docs/integration/deployment/docker-compose.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/docker-compose.mdx Outdated
- Fix environment variable tables (required first, then alphabetical)
- Spelling/wording fixes
- Created Kratos warning partial, removed redundant content across the site
- Expand maxHeadingLevel to H4
- Created heading for complete example
- Consolidate "Domain and subdomains setup" and "Update DNS records", renaming to "Domain and DNS configuration"
- Updated domain/DNS table to change second column from "Function" to "Exposes" and then removed redundancy of "exposes an/the..."
- Revised all table headings to follow the same capitalization scheme
@brad-dow brad-dow merged commit 0a124a6 into main Apr 28, 2025
42 of 44 checks passed
@brad-dow brad-dow deleted the docs-docker-compose-3379 branch April 28, 2025 15:42
bosbaber pushed a commit to bosbaber/rafiki that referenced this pull request May 16, 2025
* docs: update docker compose

Created 3 new partials, split the docker compose sample into multiple snippets

* docs: feedback updates

- Fix environment variable tables (required first, then alphabetical)
- Spelling/wording fixes
- Created Kratos warning partial, removed redundant content across the site
- Expand maxHeadingLevel to H4
- Created heading for complete example

* docs: feedback updates

- Consolidate "Domain and subdomains setup" and "Update DNS records", renaming to "Domain and DNS configuration"
- Updated domain/DNS table to change second column from "Function" to "Exposes" and then removed redundancy of "exposes an/the..."
- Revised all table headings to follow the same capitalization scheme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: documentation Changes in the documentation package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: break up docker compose example file(s)

2 participants