Docs / Getting started

Core concepts

The handful of terms the rest of these docs use, defined once.

TermMeaning
WorkspaceYour organisation in SysJ. It has its own address, its own database and its own sign-in, isolated from every other workspace.
Cloud accountAn AWS account SysJ may build in, through a role you created for it.
ClusterAn Amazon EKS cluster SysJ built in one of your cloud accounts, with the capabilities you chose.
PlanThe output of terraform plan for a change, run against your account. It is what you approve.
PolicyRules that read every plan. A blocking finding stops the plan from being approved.
ApprovalA person accepting one plan. It is bound to that plan’s digest and expires after a few minutes.
EnvironmentA named deployment target: one namespace on one cluster.
ApplicationSomething SysJ builds from a repository and deploys to an environment.
DeploymentOne request to put a branch or commit of an application into an environment.

Two ways to change a cluster

The assistant and the Clusters screen both change clusters. The assistant always plans first and waits for an approval. The Clusters screen builds and resizes directly, so only give cluster.manage to people you would trust to do that without a second look.

Why the plan, and not a description of it

The assistant can explain what it intends, but only the plan is what runs. Policy and the approval both read the plan itself, and the apply uses the exact plan file that was approved.