WIP: infra/setup

Author: gdemonet

.github/workflows/test-actions.yaml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   test-infra-example:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v3
     - uses: ./infra/example
@@ -19,3 +19,15 @@ jobs:
     - run: echo "Failure" && exit 1
       shell: bash
       if: steps.custom-action.outputs.out != 'example-output'
+
+  test-infra-setup:
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ./infra/setup
+      id: infra-setup
+      with:
+        cloud: openstack
+        stack-name: test
+    - shell: bash
+      run: ls ${{ steps.infra-setup.outputs.workdir }}

infra/example/dist/pulumi/index.d.ts

@@ -8,7 +8,8 @@
     "format": "prettier --write '**/*.ts'",
     "format-check": "prettier --check '**/*.ts'",
     "lint": "eslint src/**/*.ts",
-    "package": "npm run package:example",
+    "package": "npm run package:example && npm run package:setup",
+    "package:setup": "ncc build src/entrypoints/setup.ts --source-map --license licenses.txt --out setup/dist",
     "package:example": "ncc build src/entrypoints/example.ts --source-map --license licenses.txt --out example/dist",
     "test": "jest --passWithNoTests",
     "all": "npm run build && npm run format && npm run lint && npm run package && npm test"
@@ -34,6 +35,11 @@
     "typescript": "^4.9.3"
   },
   "dependencies": {
-    "@actions/core": "^1.10.0"
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.1",
+    "@actions/io": "^1.1.2",
+    "@actions/tool-cache": "^2.0.1",
+    "@pulumi/pulumi": "^3.48.0",
+    "@pulumi/random": "^4.8.2"
   }
 }

infra/example/dist/pulumi/lib/index.d.ts

@@ -0,0 +1,29 @@
+# Pulumi Projects for Scality
+
+Configuration from code for spawning cloud infrastructure intended for deploying various
+flavours of Scality products.
+
+## Goals
+
+**Modularity**: Split infrastructure into logical composable units (e.g. "a network with
+subnets and a bastion", "a node with disks", ...)
+
+**Multi-cloud**: provide a single interface for "infrastructure" and handle the backend
+selection at runtime
+
+## Organization
+
+Pulumi has the concept of [projects][pulumi-projects] and [stacks][pulumi-stacks].
+
+[pulumi-projects]: https://www.pulumi.com/docs/intro/concepts/project/
+[pulumi-stacks]: https://www.pulumi.com/docs/intro/concepts/stack/
+
+A project defines a configurable Pulumi program, and stacks are instances of this
+program with independent configurations.
+
+Since they will likely require drastically different infrastructure layouts, we will
+separate Scality products (RING and ARTESCA) into distinct projects.
+
+However, Pulumi also exposes a concept of [components][pulumi-components] which can
+be shared in a reusable library. We will use to provide basic building blocks and
+standard implementations for known cloud providers.

infra/example/dist/src/entrypoints/setup.d.ts

@@ -0,0 +1,13 @@
+name: scality-infra-artesca
+description: Cloud infrastructure for deploying ARTESCA
+runtime: nodejs
+
+config:
+  cloud:
+    type: string
+    description: The cloud provider to use
+    default: openstack
+  nodes-count:
+    type: integer
+    description: The number of nodes to spawn (not counting bastion)
+    default: 1

infra/package.json

@@ -0,0 +1,3 @@
+# Pulumi project for ARTESCA cloud infrastructure
+
+To be documented: configuration options, managed resources, quickstart commands.

infra/pulumi/README.md

@@ -0,0 +1,30 @@
+/**
+ * Pulumi project for spawning cloud infrastructure to deploy ARTESCA.
+ *
+ * @packageDocumentation
+ */
+
+import * as pulumi from "@pulumi/pulumi";
+import * as random from "@pulumi/random";
+
+export async function main() {
+  const config = new pulumi.Config();
+  const cloud = config.require("cloud");
+  const nodesCount = config.requireNumber("nodes-count");
+  const stack = pulumi.getStack();
+  const project = pulumi.getProject();
+
+  const randomID = new random.RandomId("random-stack-id", {
+    byteLength: 10,  // 10 bytes to get 5 characters in hex
+    keepers: { stackName: stack },
+  });
+
+  const prefix = pulumi.interpolate`${project}-${randomID.hex}`;
+  console.log(
+    `This stack (${stack}, from project ${project}) will create ${nodesCount} nodes ` +
+      `with the "${cloud}" provider.`
+  );
+
+  // attempt getting outputs, can't export from a function
+  return { prefix };
+}

infra/pulumi/artesca/Pulumi.yaml

@@ -0,0 +1,44 @@
+/**
+ * Entrypoints for provisioning cloud infrastructure with Pulumi Automation API.
+ *
+ * These entrypoints replicate some Pulumi CLI commands, and add state management
+ * helpers for use with Scality Artifacts.
+ *
+ * @packageDocumentation
+ */
+import * as os from "node:os";
+import * as path from "node:path";
+import * as fs from "node:fs/promises";
+
+import { LocalWorkspace } from "@pulumi/pulumi/automation";
+
+import { main as artescaProgram } from "./artesca";
+import { main as ringProgram } from "./ring";
+
+const programs = { artesca: artescaProgram, ring: ringProgram };
+export type Product = keyof typeof programs;
+
+export async function init(
+  product: Product,
+  stackName: string,
+  sourceDir?: string,
+  workDir?: string
+) {
+  // Create (or validate) the workDir
+  if (workDir === undefined)
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), "scality-pulumi-"));
+  await fs.mkdir(workDir, { recursive: true });
+
+  // Copy project (and optional stack) settings from known paths
+  if (sourceDir === undefined) sourceDir = __dirname;
+  await fs.cp(path.join(sourceDir, product), workDir, { recursive: true });
+
+  // (maybe, add configuration hooks here as well, but can be done with the resulting
+  // workspace, so no rush)
+
+  // Return a local workspace
+  return await LocalWorkspace.createOrSelectStack(
+    { stackName, projectName: `scality-infra-${product}`, program: programs[product] },
+    { workDir }
+  );
+}