capabilities.work

Onboard a Project and Its First Workspace

A 5-step recipe with Terraform. We can help you get access.

Recipe · 5 steps

Onboard a Project and Its First Workspace

Create a project and its first workspace inside an organization.

  1. Read the organization to confirm the token can reach it before creating structure inside it.
  2. Create the project that will group this team's workspaces under a single permissions and organizational boundary.
  3. Read the project back to confirm it was created with the expected name before hanging workspaces off it.
  4. Create the project's first workspace inside the organization using the supplied execution mode.
  5. List the organization's workspaces filtered to the new project, confirming the workspace is grouped where it belongs.
What you'll need to have ready
  • organizationName: The organization that will own the project.
  • projectName: The name for the new project (e.g. "payments-platform").
  • projectDescription: A human readable description for the project.
  • workspaceName: The name for the project's first workspace.
  • workspaceDescription: A human readable description for the workspace.
  • executionMode: How runs execute for the workspace - remote, local, or agent.
For your developer

Arazzo workflow terraform:onboard-project, 5 operations: GetOrganization → CreateProject → GetProject → CreateWorkspace → ListWorkspaces. Specs on APIs.io.