Refactor the runDockerContainer function to a ContainerRunner interface.

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>

docs/features/software-templates/installation.md

@@ -70,6 +70,10 @@ creating a file called `packages/backend/src/plugins/scaffolder.ts` with the
 following contents to get you up and running quickly.
 
 ```ts
+import {
+  DockerContainerRunner,
+  SingleHostDiscovery,
+} from '@backstage/backend-common';
 import {
   CookieCutter,
   createRouter,
@@ -78,7 +82,6 @@ import {
   CreateReactAppTemplater,
   Templaters,
 } from '@backstage/plugin-scaffolder-backend';
-import { SingleHostDiscovery } from '@backstage/backend-common';
 import type { PluginEnvironment } from '../types';
 import Docker from 'dockerode';
 import { CatalogClient } from '@backstage/catalog-client';
@@ -89,8 +92,11 @@ export default async function createPlugin({
   database,
   reader,
 }: PluginEnvironment) {
-  const cookiecutterTemplater = new CookieCutter();
-  const craTemplater = new CreateReactAppTemplater();
+  const dockerClient = new Docker();
+  const containerRunner = new DockerContainerRunner({ dockerClient });
+
+  const cookiecutterTemplater = new CookieCutter({ containerRunner });
+  const craTemplater = new CreateReactAppTemplater({ containerRunner });
   const templaters = new Templaters();
 
   templaters.register('cookiecutter', cookiecutterTemplater);
@@ -99,8 +105,6 @@ export default async function createPlugin({
   const preparers = await Preparers.fromConfig(config, { logger });
   const publishers = await Publishers.fromConfig(config, { logger });
 
-  const dockerClient = new Docker();
-
   const discovery = SingleHostDiscovery.fromConfig(config);
   const catalogClient = new CatalogClient({ discoveryApi: discovery });
 
@@ -110,7 +114,6 @@ export default async function createPlugin({
     publishers,
     logger,
     config,
-    dockerClient,
     database,
     catalogClient,
     reader,

docs/features/software-templates/writing-custom-actions.md

@@ -106,7 +106,6 @@ return await createRouter({
   publishers,
   logger,
   config,
-  dockerClient,
   database,
   catalogClient,
   reader,
@@ -124,7 +123,6 @@ return await createRouter({
   publishers,
   logger,
   config,
-  dockerClient,
   database,
   catalogClient,
   reader,
@@ -136,11 +134,9 @@ return await createRouter({
 want to have those as well as your new one, you'll need to do the following:
 
 ```ts
-
-import { createBuiltinActions } from '@backstage/plugin-scaffolder-backend`;
+import { createBuiltinActions } from '@backstage/plugin-scaffolder-backend';
 
 const builtInActions = createBuiltinActions({
-  dockerClient,
   integrations,
   catalogClient,
   templaters,
@@ -155,7 +151,6 @@ return await createRouter({
   publishers,
   logger,
   config,
-  dockerClient,
   database,
   catalogClient,
   reader,

docs/features/techdocs/getting-started.md

@@ -63,6 +63,7 @@ Create a file called `techdocs.ts` inside `packages/backend/src/plugins/` and
 add the following
 
 ```typescript
+import { DockerContainerRunner } from '@backstage/backend-common';
 import {
   createRouter,
   Generators,
@@ -84,9 +85,14 @@ export default async function createPlugin({
     reader,
   });
 
+  // Docker client (conditionally) used by the generators, based on techdocs.generators config.
+  const dockerClient = new Docker();
+  const containerRunner = new DockerContainerRunner({ dockerClient });
+
   // Generators are used for generating documentation sites.
   const generators = await Generators.fromConfig(config, {
     logger,
+    containerRunner,
   });
 
   // Publisher is used for
@@ -97,14 +103,13 @@ export default async function createPlugin({
     discovery,
   });
 
-  // Docker client (conditionally) used by the generators, based on techdocs.generators config.
-  const dockerClient = new Docker();
+  // checks if the publisher is working and logs the result
+  await publisher.getReadiness();
 
   return await createRouter({
     preparers,
     generators,
     publisher,
-    dockerClient,
     logger,
     config,
     discovery,