chore(image-builder): Add README, update config JSON schema #14205
Conversation
| { "path": "../image-builder-api" }, | ||
| { "path": "../image-builder-bob" }, | ||
| { "path": "../image-builder-mk3" }, | ||
| { "path": "../ws-manager" }, | ||
| { "path": "../server" }, | ||
| { "path": "../../test" }, | ||
| { "path": "../../dev/gpctl" } | ||
| { "path": "../../dev/gpctl" }, | ||
| { "path": "../../install/installer" } |
There was a problem hiding this comment.
found api and installer useful to be included as well in this workspace
WVerlaek
changed the title
| Bob is a CLI responsible for building and pushing workspace images during workspace startup. | ||
|
|
||
| For each image build, a headless workspace gets created in the meta cluster by `image-builder-mk3` ([#7845](https://github.com/gitpod-io/gitpod/issues/7845) will move the headless workspace and image-builder to the workspace cluster), in this headless workspace runs: | ||
| - `bob proxy`, which gets started by workspacekit in ring1, and receives credentials for pushing images to a docker registry. It proxies and authenticates the image pushes from `bob build`. | ||
| - `bob build` as a workspace task, which builds the | ||
| - **base layer**, if a custom Dockerfile is specified in `.gitpod.yaml`. If this base image has already been built for the workspace, this step is skipped, and the reference of the previously built image is used instead to build the workspace image next. | ||
| - **workspace image**, which builds an image from the base layer, where the base layer is either a previously built custom Dockerfile or a public image. | ||
| These images get pushed over `localhost` to `bob proxy`, as `bob build` does not receive the credentials to push to private registries. |
There was a problem hiding this comment.
💯 It helps me to understand image-builder-bob. I wanted this README when I first developed image-builder.
What about putting a statement that this image does not include the supervisor, etc.? I think this is often misunderstood as the role of the registry-facade.
There was a problem hiding this comment.
Thanks @utam0k great suggestion, updated and will also put it in the architecture docs.
There was a problem hiding this comment.
💯 It helps me to understand image-builder-bob. I wanted this README when I first developed image-builder.
+1
|
Thanks, @WVerlaek |
|
this PR stuck our tide merge pool, could you rebase to main and squash these commits? @WVerlaek |
| @@ -1,11 +1,13 @@ | |||
| { | |||
| "folders": [ | |||
| { "path": "../image-builder-api" }, | |||
There was a problem hiding this comment.
| { "path": "../image-builder-api" }, | |
| { "path": "../image-builder-api/go" }, |
The biggest part of the purpose of writing this workspace is because of the golang code hint problem, so it would be good using golang package path
| "wsman": { | ||
| "address": "ws-manager:8080", | ||
| "tls": { | ||
| "ca": "/wsman-certs/ca.crt", | ||
| "crt": "/wsman-certs/tls.crt", | ||
| "key": "/wsman-certs/tls.key" | ||
| } | ||
| }, |
There was a problem hiding this comment.
The example configuration file does not work, it is missing files (tls) and it not able to connect with ws-manager
There was a problem hiding this comment.
Is the intention of an example-config.json to be run locally? I took this example config from the image-builder-mk3-config ConfigMap in a cluster, but let me try to see if I can change it to work locally
There was a problem hiding this comment.
Done - updated the README with instructions on running image-builder-mk3 locally. Also added a section on using grpcurl to call the RPC methods on the locally running API
WVerlaek
force-pushed
the
wv/image-builder-mk3-readme
branch
from
b54935a to
dbd87b2
Compare
Done |
It would help if you used rebase and fixup commit 3 to commit 1 |
|
@iQQBot sure let me do that - thought it would be easier to review to see the separate changes made after the last review. What happens when we merge, do the commits get squashed, or will all commits in the PR end up on main? |
WVerlaek
force-pushed
the
wv/image-builder-mk3-readme
branch
from
d3c6698 to
27a462d
Compare
unfortunately, we don't enable squash, so all commits in the PR end up on main, we need to squash it manual
Github provide compare button, so while review we can use it |
|
@iQQBot thanks! good to know |
roboquat
added
the
deployed: workspace
Description
image-builder-mk3image-builder-bobimage-builder-mk3config JSON schema and update example config (was still usingimage-builder-mk2config)telepresence.sh: this script hadn't been updated to work withimage-builder-mk3, and I couldn't get it working either within reasonable time (believe it requires thetelepresenceinstall to be upgraded). It looks like this script isn't being used cause it's been outdated for a while, and as there's also thedebug.shscript to iterate on local changes I thought it would be best to remove it. Can always add it back if/when we need to?Related Issue(s)
How to test
image-builder generate configRelease Notes
Documentation
Werft options:
If enabled this will build
install/previewValid options are
all,workspace,webapp,ide