diff --git a/docsite/docs/build-images/choosing-builder.md b/docsite/docs/build-images/builders.md similarity index 88% rename from docsite/docs/build-images/choosing-builder.md rename to docsite/docs/build-images/builders.md index 13b247839..b42efabdd 100644 --- a/docsite/docs/build-images/choosing-builder.md +++ b/docsite/docs/build-images/builders.md @@ -1,13 +1,13 @@ -# Select a builder +# Builders -A builder is a machine running monitor periphery and docker. Any server connected to monitor can be chosen as the builder for a build. +A builder is a machine running monitor periphery and docker, which is able to handle a RunBuild command from monitor core. Any server connected to monitor can be chosen as the builder for a build. Building on a machine running production software is usually not a great idea, as this process can use a lot of system resources. It is better to start up a temporary cloud machine dedicated for the build, then shut it down when the build is finished. Right now monitor supports AWS ec2 for this task. ## AWS builder Builders are now monitor resources, and are managed via the core API / can be updated using the UI. -To use this feature, you need an AWS Ec2 AMI with docker and monitor periphery configured to run on system start. +To use this feature, you need an AWS EC2 AMI with docker and monitor periphery configured to run on system start. Once you create your builder and add the necessary configuration, it will be available to attach to builds. ### Setup the instance diff --git a/docsite/sidebars.ts b/docsite/sidebars.ts index e5b81b0db..79f716d68 100644 --- a/docsite/sidebars.ts +++ b/docsite/sidebars.ts @@ -37,7 +37,7 @@ const sidebars: SidebarsConfig = { items: [ "build-images/configuration", "build-images/pre-build", - "build-images/choosing-builder", + "build-images/builders", "build-images/versioning", ], },