RUNNING

Organisations, projects and environments

Three nested ideas: an organisation holds projects, and a project holds environments. Most of what you do in RunningLake happens in an environment.

An organisation

An organisation is your account: its members, its plan and its bill. It is created for you the first time someone we have added signs in to the console, and that person is its owner.

Members and roles

Each member has one of five roles: owner, admin, engineer, analyst or viewer, and the role is given for the whole organisation. A role limited to one project is not built yet, so a member’s role on every project is their organisation role. An API token can be limited to one project.

A role says what a person may do in the control plane: propose a change, approve one, create a token, read the audit log. It does not by itself say what data they may read; that is decided separately, on the data.

A project

A project holds your environments, your tables and the configuration that describes them, as files in a git repository. You create one in the console, or with rl project create.

A project lives in one cloud and region, which you choose when you create it. It is where the project’s data lives, and it is the one choice here that is hard to change later: a data plane can only serve an environment in the same cloud and region, so a project created in the wrong one cannot be served by the cluster you build afterwards. Leave the region empty and the project takes your organisation’s home region.

Environments

Every new project starts with two environments, dev and prod. An environment is where tables are created and queries run. It is bound to one data plane, and it cannot hold a table until its storage, keys and catalog have been set up on that plane.

An environment also has a change policy, which says what happens to a change submitted to it. In a new project a change to dev is applied as soon as it is submitted, and a change to prod waits for someone to approve it.

Where to go next

• Start here creates a project and its first table.
• The repository and change sets says what a change is.
• Review and approval says who may let one through to prod.
• The rl command line has every flag of rl project create and rl project list.
• Permissions lists every action and which role may take it.