Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Environments

Weik.io 2026.2

Create the environments of the installation, set their budgets and protection, and see what runs in each.

On this page

Environments such as devtest and production belong to the whole installation, and a platform administrator creates them once, usually as kind: environment documents in Git. Each environment has its own event storage, dead letters and entity store, sized by the budgets you give it.

An environment marked as production is protected: every command that changes something in it needs --env, so a context’s default never sends a change there by accident. env and environment mean the same in every command below.

Commands on this page#

Command What it does
weikio env create Create an environment.
weikio get environments List the environments in order, with their budgets, gateways and agents.
weikio describe environment Show an environment with its settings, budgets and deployments.
weikio env set Change the protection, budgets, certificates or launch defaults of an environment.
weikio delete environment Delete an environment and everything in it.
weikio rename environment Rename an environment.

The flags every command accepts, such as --env, --project, -o and --context, are on the CLI reference page and are left out of the tables below.

weikio env create#

Create an environment. Creating an environment creates its event streams, its dead letters and its record of handled events, sized by the --*-bytes budgets or by the installation’s defaults. An environment’s production flag can’t be changed after it’s created.

Terminal
weikio env create <name> [--display-name S] [--order N] [--production] [--allow-secret-reveal] [--allow-latest] [--start-offline=bool] [--offline-start-max-age LENGTH] [--entity-store-bytes SIZE] [--events-bytes SIZE] [--entity-events-bytes SIZE] [--dead-letter-bytes SIZE] [--idempotency-bytes SIZE] [--trusted-certificates PEM-FILE ...]
Argument or flag What it does
<name> Environment name.
--production Make this a production environment (can’t be changed later).
--display-name <display-name> The environment’s display name, and “” removes it.
--order <order> The environment’s place in the promotion order, by default 1 on create.
--allow-secret-reveal Allow secret values to be revealed here.
--allow-latest Allow deployments to follow the latest version in a production environment.
--start-offline Allow deployments to start while the platform is unreachable.
--offline-start-max-age <offline-start-max-age> How long a site runs or starts its deployments while the platform is unreachable, such as 24h or 7d.
--events-bytes <events-bytes> Size limit for events (channel events, webhook receipts and transfer records).
--entity-events-bytes <entity-events-bytes> Size limit for entity events (entity puts and changes).
--entity-store-bytes <entity-store-bytes> Entity store size, by default 512MiB on create.
--dead-letter-bytes <dead-letter-bytes> Size limit for dead letters.
--idempotency-bytes <idempotency-bytes> Size limit for handled events.
--trusted-certificates <trusted-certificates> Trusted PEM file for deployments (may be repeated).
--reason <reason> Reason for the change, stored with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/environments/{name}.

Also written as weikio create environment.

Terminal
$ weikio apply -f platform/environments.yaml
You see
Target: https://hub.example
environment devtest created
environment production created

weikio get environments#

List the environments in order, with their budgets, gateways and agents.

Terminal
weikio get environments

Who can run it: a grant whose role has read in the environment.

API: GET /api/v1/environments, GET /api/v1/gateways.

Also written as weikio get env, weikio get environment and weikio get envs.

Terminal
$ weikio get environments
You see
NAME         ORDER   PRODUCTION   EVENTS BUDGET   ENTITY EVENTS   ENTITY STORE   GATEWAYS                      AGENTS
devtest      1       no           2 GiB           1 GiB           512 MiB        devtest (default)             2/2 online
production   2       yes          8 GiB           4 GiB           2 GiB          internal (default), partner   1/2 online

weikio describe environment#

Show an environment with its settings, budgets and deployments.

Terminal
weikio describe environment <name>
Argument or flag What it does
<name> The environment.

Who can run it: a grant whose role has read in the environment, and a platform administrator for the parts about the platform.

API: GET /api/v1/environments/{name}, GET /api/v1/environments/{name}/deployments, GET /api/v1/agents?environment=.

Also written as weikio describe env, weikio describe environments and weikio describe envs.

weikio env set#

Change the protection, budgets, certificates or launch defaults of an environment. --trusted-certificates replaces the whole list and restarts every deployment of the environment with a new truststore, so the command asks first and lists the deployments. Lowering a budget below what its stream holds deletes the oldest events at once, and the command asks before it does that too.

Terminal
weikio env set <name> [--display-name S] [--order N] [--allow-secret-reveal=bool] [--allow-latest=bool] [--start-offline=bool] [--offline-start-max-age LENGTH] [--events-bytes SIZE] [--entity-events-bytes SIZE] [--entity-store-bytes SIZE] [--dead-letter-bytes SIZE] [--idempotency-bytes SIZE] [--trusted-certificates PEM-FILE ...|--no-trusted-certificates] [--launch-property KEY=VALUE ...] [--launch-jvm-option FLAG ...] [--no-launch-defaults]
Argument or flag What it does
<name> The environment.
--no-trusted-certificates Remove the environment’s trusted certificates.
-y, --yes Don’t ask for confirmation.
--display-name <display-name> The environment’s display name, and “” removes it.
--order <order> The environment’s place in the promotion order, by default 1 on create.
--allow-secret-reveal Allow secret values to be revealed here.
--allow-latest Allow deployments to follow the latest version in a production environment.
--start-offline Allow deployments to start while the platform is unreachable.
--offline-start-max-age <offline-start-max-age> How long a site runs or starts its deployments while the platform is unreachable, such as 24h or 7d.
--events-bytes <events-bytes> Size limit for events (channel events, webhook receipts and transfer records).
--entity-events-bytes <entity-events-bytes> Size limit for entity events (entity puts and changes).
--entity-store-bytes <entity-store-bytes> Entity store size, by default 512MiB on create.
--dead-letter-bytes <dead-letter-bytes> Size limit for dead letters.
--idempotency-bytes <idempotency-bytes> Size limit for handled events.
--trusted-certificates <trusted-certificates> Trusted PEM file for deployments (may be repeated).
--reason <reason> Reason for the change, stored with the audit record.
--launch-property <launch-property> A Camel setting the environment’s deployments start with, as KEY=VALUE. Added to the environment’s list, in place of the installation’s setting of the same key, repeated as needed.
--launch-jvm-option <launch-jvm-option> A Java option the environment’s deployments start with. The options given here replace the installation’s list for this environment, repeated as needed.
--no-launch-defaults Remove the environment’s launch defaults, so its deployments take the installation’s. The --launch-property and --launch-jvm-option flags of the same command then start from none.

Who can run it: a platform administrator.

API: PUT /api/v1/environments/{name}.

weikio delete environment#

Delete an environment and everything in it. The command refuses while deployments, entity types, agents or gateways still use the environment, and lists each of them by name. Otherwise it asks you to type the environment’s name, then deletes its streams with every stored event and dead letter, its values and its client certificates.

Terminal
weikio delete environment <name> [-y]
Argument or flag What it does
<name> The environment.
-y, --yes Don’t ask for confirmation.
--reason <reason> Reason for the change, stored with the audit record.

Who can run it: a platform administrator.

API: GET /api/v1/version, DELETE /api/v1/environments/{name}.

Also written as weikio delete env, weikio delete environments and weikio delete envs.

Terminal
$ weikio delete environment devtest
You see
error: Environment 'devtest' is still used by 7 deployments, 1 entity type and 2 agents. Undeploy from it, delete its entity type and remove it from the agents that serve it.
       deployment 'finance/erp-invoice-export'
       deployment 'finance/invoice-tally'
       deployment 'finance/nightly-payroll'
       deployment 'finance/orders-api'
       deployment 'hr/onboarding'
       deployment 'hr/payroll-sync'
       deployment 'shop/orders'
       entity type 'finance/invoice'
       agent 'site-01'
       agent 'site-02'

weikio rename environment#

Rename an environment.

Terminal
weikio rename environment <name> <new-name>
Argument or flag What it does
<name> The environment.
<new-name> The new name.
--reason <reason> Reason for the change, stored with the audit record.

Who can run it: a platform administrator.

API: PATCH /api/v1/environments/{environment}.

Also written as weikio rename env, weikio rename environments and weikio rename envs.

Exit codes#

The commands on this page exit with the codes in the exit code table: 0 on success, 1 when the hub refuses a change, 2 for a usage error, 3 when the key is missing or not allowed, 4 when something isn’t found, 5 for a conflicting change, 6 when the hub can’t be reached and 8 when a document isn’t valid.

See also#