brewless.yml

brewless.yml sits in the root of your project and belongs in the repository. It says which organisation and application the project is, and how each environment should be. Run brewless plan to see, per environment, what the file asks for next to what stands now; nothing is changed by it. A file with only organisation, application, framework and php is as valid as a long one.

organisation: acme
application: shop
framework: laravel
php: "8.4"
default-environment: staging

environments:
  production:
    kind: production
    region: fr-par
    web:
      memory: 1024
      min: 1
      max: 10
    database: shop-main
    queue: sqs
    domains:
      - shop.example.eu
    variables:
      APP_LOCALE: nl
  staging:
    kind: staging
    web:
      max: 2
    scheduler: false

Keys#

A key under environments.* is set per environment, under its name. A key you leave out keeps what stands; the default is what an environment gets when Brewless sets it up. A key Brewless does not know is refused by name, so a typo does not go unnoticed.

Sizes#

Memory is from 128 to 12288 megabytes and processor time from 70 to 6000 thousandths of a vCPU. Scaleway pairs the two: the memory has to be at least the processor time and at most 4 times it. Give only one of them and the other follows, as Scaleway pairs them (1024 MB with 560). Local disk (tmp-storage) is from 1000 megabytes up to 4 times the memory, at most 24456. A timeout is from 10 to 3600 seconds; concurrency from 1 to 80 requests. Release commands get 90 seconds per release, whatever the timeout of the release container.

No secrets#

A secret never belongs in a file in your repository. Under variables, a name that looks like one (it contains KEY, SECRET, PASSWORD, TOKEN, CREDENTIALS, PRIVATE, DSN, SALT or AUTH as a word) is refused. Keep secrets in Secret Manager with brewless env:push; see Variables.

What a deploy does with it today#

A deploy sends the whole file along. Brewless builds the release for php with the build steps after those of the framework, runs the release commands instead of the application's own (this needs brewless/laravel 0.3 or later), gives each container the sizes, scale, timeout and local disk the file names, works the worker.queues and leaves the schedule out with scheduler: false. Plain variables go into a new revision of the environment's variables in your Secret Manager before the build; that needs the environment's variables kept through Brewless (push them once with brewless env:push). A rollback puts back what the file asked of the release it goes back to. What the file sets is shown in the console as set in brewless.yml, and the console and brewless scale leave it alone. default-environment is the environment brewless deploy uses when you name none. Before the release, a deploy makes an environment the file names that does not exist yet, with its kind and region, and sets up the database, queue and storage the file names; an environment that runs gets those it is missing. The domains it does not answer on yet are named, and added after a yes or with brewless deploy --domains, because adding one can move its visitors. What stands is never switched for something else: another region, kind, database, bucket or queue is refused before anything is made. false lets a database or a bucket go from the environment, while it keeps running at Scaleway. Removing a key from the file never removes anything: what it set stays as it is. services are put live with brewless service:push, which also gives their containers the sizes the file names; a deploy gives the application each service's address and secret, and is refused while a service it names does not run yet.