Skip to content

docs: Update Wave Build#995

Open
gavinelder wants to merge 1 commit intomasterfrom
wave-docs-update
Open

docs: Update Wave Build#995
gavinelder wants to merge 1 commit intomasterfrom
wave-docs-update

Conversation

@gavinelder
Copy link
Contributor

@gavinelder gavinelder commented Mar 19, 2026

The following updates the docs based on deploys...

Copy link
Member

@christopher-hakkaart christopher-hakkaart 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 started going through this, but the suggestions I was making were larger structural changes or specific language changes outside the scope of this PR, which, IMO, is to add missing explanations/details and ensure the content is correct.

@gwright99 and I are talking about Wave install and configuration later this week. In the interest of having everything on the table and in place so we can work with a single set of docs rather than multiple in-flight PRs, I think the best approach is to push forward with this with minimal suggestions and catch everything else in a second iteration, e.g., think about the best place for troublshooting and faq content

This guide covers extending your existing Wave installation on Kubernetes to support container build capabilities. This enables Wave's full feature set including container building, freezing, and advanced caching.
This guide covers extending your existing Wave installation on Kubernetes to support container build capabilities. This enables Wave's full feature set, including container building, freezing, security scanning, mirroring, and advanced caching.

Wave builds use a **two-namespace architecture**: the main Wave application runs in one namespace (e.g., `wave`) and spawns ephemeral build, scan, and mirror pods in a dedicated build namespace (e.g., `wave-build`). Both namespaces share a single EFS filesystem so that build artifacts are accessible to both the app and the build pods.

Choose a reason for hiding this comment

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

Suggested change
Wave builds use a **two-namespace architecture**: the main Wave application runs in one namespace (e.g., `wave`) and spawns ephemeral build, scan, and mirror pods in a dedicated build namespace (e.g., `wave-build`). Both namespaces share a single EFS filesystem so that build artifacts are accessible to both the app and the build pods.
Wave builds use a **two-namespace architecture**. The main Wave application runs in one namespace (e.g., `wave`) and spawns ephemeral build, scan, and mirror pods in a dedicated build namespace (e.g., `wave-build`). Both namespaces share a single EFS filesystem, allowing build artifacts to be accessible to both the application and the build pods.

Comment on lines +9 to +25
```
┌──────────────────────────┐ ┌───────────────────────────────┐
│ Namespace: wave │ │ Namespace: wave-build │
│ │ │ │
│ Wave app (Deployment) │────►│ Build pods (ephemeral) │
│ Schedules build pods │ │ Scan pods (ephemeral) │
│ via K8s API │ │ Mirror pods (ephemeral) │
│ │ │ │
│ PVC: wave-app-fs ──┐ │ │ PVC: wave-build-fs ──┐ │
└──────────────────────┼───┘ └────────────────────────┼──────┘
│ │
└──────────┬───────────────────────┘
┌─────────────────────┐
│ AWS EFS filesystem │
│ (shared storage) │
└─────────────────────┘

Choose a reason for hiding this comment

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

Do you object if I turn this into a mermaid?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No go for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants