alis org¶
Manage build environments, which hold products: list them, view one, request access or a new one, and manage who has access.
Synopsis¶
alis org join <org> [flags]
alis org list [flags]
alis org request [flags]
alis org share [<org>] [flags]
alis org spanner [<org>] [flags]
alis org view [<org>] [flags]
Aliases: org, organisation, landing-zone, lz.
Description¶
A build environment is a set of products with shared git and cloud permissions. Its id is the <org> in package IDs and in ~/alis.build/<org>/.
Subcommands¶
alis org join¶
Request builder access to a build environment you cannot open yet but which is paid for by an account you are a member of (alis org list shows them under "no builder access yet"), or to one you can open only as a viewer. Approval makes you a builder on every product in it. Opens a request conversation the build environment's administrators grant or decline; an open request is returned instead of duplicating it. Requires an active account.
With --product-name (and optionally --product-id) the same request also asks for a new product: approval provisions it with a development deployment environment, makes you its administrator and gives you access to the build environment.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--product-id <id> |
string | Preferred two-letter id for the new product (requires --product-name). |
|
--product-name <name> |
string | Also request a new product with this human-readable name. | |
--reason <text> |
string | Why you need access. |
alis org list¶
List all build environments you have access to. Build environments paid for by a Build account you belong to but that you cannot open yet, and ones you can open only as a viewer, are listed separately (--json: linkedOrganisations).
No flags beyond the global flags.
alis org request¶
Ask the Alis Build team for a new build environment. Opens a request conversation the team fulfils and replies in; an open request is returned instead of duplicating it. Requires an active Build account.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--id <id> |
string | Your preferred build environment id (3 to 21 lowercase letters or digits; the team confirms it). | |
--name <name> |
string | The build environment's name, for example your company or team (required). | |
--note <text> |
string | What you plan to build. |
alis org share¶
Show who has access to a build environment and with which role, or grant, change and remove a person's access. With no flags, print the current access. Only administrators can change access; administrators and builders can see it. Builder on a build environment makes the person a builder on every product in it; --remove takes their product roles away too. Access propagates to cloud and git permissions in the background. Account membership is managed separately.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--email <addr> |
string | The person's email address. | |
--invite <given-name> |
string | Invite the person as a new builder first, using this given name. | |
--remove |
bool | false | Remove the person's access instead of granting a role. |
--role <role> |
string | builder |
Role to grant: admin or builder. |
--yes |
bool | false | Skip the approval prompt (same as --approve). |
alis org spanner¶
Show the build environment's platform-managed Spanner instance and how it is sized, or change it. With no flags, print the current state: the instance, its processing units, whether it autoscales and the deploy applying the latest change. The instance is either fixed at one size or autoscaling within a range; sizes are processing units, a multiple of 100 below 1000 or whole nodes from 1000 to 5000 (1000 processing units = 1 node).
--processing-units <n> fixes the size. --min-processing-units <n> --max-processing-units <n> autoscale between the two: the instance adds and removes capacity within the range on its own as its load moves. --autoscaling=false turns autoscaling off and the instance keeps its current size. While autoscaling is on a fixed size is refused (autoscaling_on): turn it off first. Only administrators can change it; anyone who can open the build environment can see it. A change is applied by a deploy of the build environment that runs in the background, so the state reads UPDATING until it has finished; --wait follows it to ACTIVE or FAILED. Spanner refuses to shrink an instance below what its databases store, and the instance is billed by its processing units.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--autoscaling |
bool | false | --autoscaling=false turns autoscaling off; the instance keeps its current size. |
--max-processing-units <n> |
int | 0 | With --min-processing-units, the largest size autoscaling may grow the instance to. |
--min-processing-units <n> |
int | 0 | With --max-processing-units, the smallest size autoscaling may shrink the instance to (below the maximum). |
--processing-units <n> |
int | 0 | Fix the instance at this many processing units; refused while autoscaling is on. |
--timeout <duration> |
duration | 0 | With --wait, give up after this duration (the deploy keeps running). |
--wait |
bool | false | Wait for the deploy applying the change to finish. |
--yes |
bool | false | Skip the approval prompt (same as --approve). |
alis org view¶
Show a build environment and its products.
No flags beyond the global flags.
Examples¶
alis org list --json
alis org view acme --json
alis org join acme --reason "Joining the platform team" --json
alis org join acme --product-name "Shop" --product-id sh --json
alis org share acme --email ana@example.com --role builder --json
alis org share acme --email ana@example.com --remove --json
alis org request --name "Acme" --id acme --note "Internal tooling" --json
alis org spanner acme --json
alis org spanner acme --processing-units 2000 --wait --json
alis org spanner acme --min-processing-units 100 --max-processing-units 1000 --wait --json
alis org spanner acme --autoscaling=false --json
Notes¶
Administrators decide join and product requests with alis specialist approve-request and alis specialist decline-request, or from the TUI. The same access can be managed from the TUI by pressing u on the build environments list or the products list. The Spanner instance is managed from the TUI by pressing d on the build environments list or inside a build environment.