Knowledge · Guidelines · architecture

Project Provisioning

How to provision a new project with infrastructure allocations

Metadata

architecture recommended

Procedures

Showing 3 of 7

  1. 1 Create project definition in workspace
    Add project YAML to .sbx/workspace/projects/{name}/
    # .sbx/workspace/projects/myapp/project.yml
type: project
name: myapp
alias: MA
  2. 2 Allocate infrastructure services
    Add project allocation entries to each required service (postgres, redis, etc.)
    # In postgres service definition
allocations:
  myapp:
    database: shredbx
    schema: myapp
    user: myapp_user
  3. 3 Register ports
    Add port allocations to .sbx/ports/registry.yml for web and API services
    myapp-web: 4002
myapp-api: 5002

Tools

  • SBX bootstrap package
  • SBX port manager
  • 1Password CLI