Skip to content

docs: 3383/docker-k8s-helm-updates#3436

Merged
hajjimo merged 6 commits into
mainfrom
mi/3383/docker-k8s-helm-updates
Jun 9, 2025
Merged

docs: 3383/docker-k8s-helm-updates#3436
hajjimo merged 6 commits into
mainfrom
mi/3383/docker-k8s-helm-updates

Conversation

@hajjimo

@hajjimo hajjimo commented May 20, 2025

Copy link
Copy Markdown
Contributor

Updates to Docker Compose and Helm-Kubernetes deployment pages that include

  • Note on both pages to use the latest supported software dependencies
  • Detailed steps for Helm-Kubernetes deployment

@netlify

netlify Bot commented May 20, 2025

Copy link
Copy Markdown

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 39c6753
🔍 Latest deploy log https://app.netlify.com/projects/brilliant-pasca-3e80ec/deploys/68470cf08d0c2d0008a94976
😎 Deploy Preview https://deploy-preview-3436--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 project configuration.

@github-actions github-actions Bot added the pkg: documentation Changes in the documentation package. label May 20, 2025
@github-actions

github-actions Bot commented May 20, 2025

Copy link
Copy Markdown

🚀 Performance Test Results

Test Configuration:

  • VUs: 4
  • Duration: 1m0s

Test Metrics:

  • Requests/s: 40.79
  • Iterations/s: 13.60
  • Failed Requests: 0.00% (0 of 2453)
📜 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..................: 855 kB 14 kB/s
     data_sent......................: 1.7 MB 29 kB/s
     http_req_blocked...............: avg=7.22µs   min=2.2µs    med=5.21µs   max=2.73ms   p(90)=6.35µs   p(95)=6.92µs  
     http_req_connecting............: avg=314ns    min=0s       med=0s       max=266.11µs p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=97.44ms  min=10.63ms  med=81.54ms  max=720.32ms p(90)=169.93ms p(95)=191.63ms
       { expected_response:true }...: avg=97.44ms  min=10.63ms  med=81.54ms  max=720.32ms p(90)=169.93ms p(95)=191.63ms
     http_req_failed................: 0.00%  ✓ 0         ✗ 2453
     http_req_receiving.............: avg=88.73µs  min=25.51µs  med=79.49µs  max=1.52ms   p(90)=115.78µs p(95)=140.92µs
     http_req_sending...............: avg=34.36µs  min=10.1µs   med=28.06µs  max=1.04ms   p(90)=42.08µs  p(95)=57.05µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=97.32ms  min=10.47ms  med=81.43ms  max=720.22ms p(90)=169.83ms p(95)=191.48ms
     http_reqs......................: 2453   40.789189/s
     iteration_duration.............: avg=293.85ms min=177.82ms med=284.28ms max=1.04s    p(90)=350.52ms p(95)=385.75ms
     iterations.....................: 818    13.601939/s
     vus............................: 4      min=4       max=4 
     vus_max........................: 4      min=4       max=4 

@melissahenderson melissahenderson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can't verify the technical pieces, so I only commented on minor things. I did have some thoughts, though. Let me know what you think.

  • For the two sections that have steps appearing in the page's table of contents, perhaps we can exclude those so the TOC isn't so long. Similarly, the subsections in Common issues could be excluded if you think it makes sense.

TOC has been condensed.

  • I don't know if this is a good idea or not, but the commands within the Common issues steps are formatted with inline code. If the command is static, and is something the user might want to copy/paste, then consider code blocks. If a command is something where the user would need to replace a piece with their own values, then maybe we leave as is.

Initially, I was struggling with making the code blocks line up correctly, but it turned out I just needed two extra tabs :)

Comment thread packages/documentation/src/content/docs/integration/deployment/docker-compose.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
@hajjimo hajjimo requested a review from melissahenderson May 22, 2025 14:42
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
Comment thread packages/documentation/src/content/docs/integration/deployment/helm-k8s.mdx Outdated
@hajjimo hajjimo requested a review from bosbaber May 27, 2025 07:21
Temporary removed configurations to values.yaml as the DevOps team works on an umbrella Helm chart.

@melissahenderson melissahenderson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One minor suggestion, take it or leave it 😁

This guide explains how to deploy Rafiki using Helm charts on a Kubernetes cluster. Helm is a package manager for Kubernetes that allows you to define, install, and upgrade complex Kubernetes applications through Helm charts.

To run Rafiki in your production environment you must have the following software and tools installed:
## Overview of Rafiki architecture

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I suggest removing this heading. The "On this page" TOC shows Overview, then Overview of Rafiki architecture. The two sections are short enough that I think the automatically inserted "Overview" heading is enough.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll take it :)

@hajjimo hajjimo merged commit e6b01e7 into main Jun 9, 2025
44 checks passed
@hajjimo hajjimo deleted the mi/3383/docker-k8s-helm-updates branch June 9, 2025 19:22
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: add min supported versions for docker and kubernetes

3 participants