pravo environments

Quick reference

pravo environments

pravo environments reads the state of each environment, in the order of the promotion flow, and prints a row for each:

The last column says one or more of:

Then it prints the release of this directory, with its tags, and the next command to type: an apply in the first environment that does not run the release and may take it, or the promotion into it. An environment whose settings or state cannot be read here, such as a bucket that these credentials cannot read, is shown as such, and the others still are.

With --json it prints {"flow", "release", "environments", "next"}: the promotion flow as text, the release (fingerprint and the names of its tags), one object for each environment (name, after, default, state, sealed, runs, release, promoted, problem) and the next command.

pravo environments diff

pravo environments diff A B evaluates the specification once for each environment and compares the resources it declares: the ones only one of them has, and the fields whose values differ, by their dotted path. It compares the specification, not the states: pravo plan --env NAME compares one environment with what it runs. A field that the provider marks sensitive, or whose name says that it is a secret, is compared and shown as differs (sensitive). A value known only at apply, such as the id of another resource, is shown as (known at apply). The tags (-t) are those of both.

With --json it prints {"a", "b", "resources", "same"}, where each resource is {"address", "only", "fields"} and each field {"path", "a", "b", "sensitive"}.

pravo environments record

The first apply in the state of an environment records which environment the state serves and which ones it follows, with the lineage of their states (The record of an environment). An apply for another environment, or one whose row in $environments follows other environments, is refused with exit code 5, so that a state that a setting points at by mistake is not written over and a gate is not dropped by an edit of the specification. When the change is meant, record makes the record say what the specification says:

pravo environments record --env prod

It prints Recorded: this state serves prod, which follows staging. When the state has a record, an admin of the state runs it. For a specification that declares no environments, it records that the state serves none. A state that does not exist yet is refused: its first apply records what it serves.

Example

package estate

import (
	"pravo.dev/pravo"
	loc "pravo.dev/providers/hashicorp/local"
)

$environments: pravo.#Environments & {
	dev: {replicas: 1, $default: true}
	prod: {replicas: 3, $after: "dev"}
}

$settings: pravo.#Settings & {state: path: "state/\($environment.$name)"}

$local: loc.#Provider

conf: $local.#Resource.local_file & {
	filename: "\($environment.$name).conf"
	content:  "replicas \($environment.replicas)\n"
}

Apply complete! Resources: 1 added, 0 changed, 0 destroyed. [txn <id>]
dev → prod

ENV   FOLLOWS  RUNS          GIT  SINCE   BY
dev   -        <release-id>       0s ago  -   runs this directory
prod  dev      -                              nothing applied yet; not sealed, takes any release

This directory: <release-id>
Next: pravo apply --env prod

Comparing dev with prod:

  ~ conf
      content: "replicas 1\n" → "replicas 3\n"
      filename: "dev.conf" → "prod.conf"

1 resource differs; 0 are the same.

Exit codes