Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Concepts

Weik.io 2026.2

The records you work with in Weik.io, and the hub and the agents that run your integrations. Product page · Video

Watch: Projects and environments, 3:07

The video explains projects and environments, and how people and pipelines get their roles through grants and API keys.

On this page

You can list most of the records below with weikio get and keep them as YAML files in Git. Agents and users are kept only in Weik.io, as are API keys.

Projects#

You group related integrations and the people allowed to work on them in a project, such as finance or hr. A membership gives a user a role in a project. You can limit the role to some environments and to single integrations or APIs.

In Git a project is usually a folder with a project.yaml file, so the files below it don’t repeat the project’s name.

Environments#

A platform administrator defines the environments, such as devtest and production, once for the whole installation. Every project deploys into them in the same order. A command that changes an environment marked as production needs --env. You can also turn off revealing secrets there.

platform/environments.yaml
apiVersion: weik.io/v1
kind: environment
metadata: { name: devtest }
spec: { displayName: Dev and test, order: 1, isProduction: false, protection: { allowSecretReveal: true, allowLatestVersion: true }, budgets: { entityStoreBytes: 536870912 } }
---
apiVersion: weik.io/v1
kind: environment
metadata: { name: production }
spec: { displayName: Production, order: 2, isProduction: true, protection: { allowSecretReveal: false }, budgets: { entityStoreBytes: 2147483648 } }

Integrations#

You write an integration as a folder of Camel routes in YAML, XML or Java, and keep in the same folder anything else the routes use, such as beans and application.properties.

Weik.io generates the routes of the other kinds of integration, such as file transfers and change tracking, from a short YAML document.

Versions#

weikio apply publishes an integration as an immutable version, which Weik.io builds once. The build validates the routes and resolves the jars they use. The version doesn’t run until you deploy it.

When integration.yaml declares a version, weikio apply accepts changed files only under a higher version. Run weikio apply --bump patch to raise it.

Deployments#

weikio deploy runs a version in an environment, on each agent whose capabilities match the integration’s requirements.

While you develop, weikio run publishes and deploys in one command.

Promotion#

weikio promote copies a deployment from one environment to the next. Production runs the version devtest ran, without a rebuild.

Terminal
$ weikio promote finance/erp-invoice-export --from devtest --to production

Variables and secrets#

Put a value that differs between environments, or changes without a new version, in a variable or a secret. Routes read both as plain Camel properties, such as {{erp-url}} and {{erp-api-key}}.

A variable without an environment is the default. A variable with an environment overrides it in that environment. Secrets have the same shape, but you set their values with the CLI instead of keeping them in Git.

The hub#

  • The backend, which serves the API and the admin UI and builds versions
  • The API gateway
  • The message server, which stores the platform’s records
  • The log store
  • The metric store
  • The trace store

The hub runs on one server, or for high availability on a number of servers you choose. Those servers can be in different data centres.

Agents#

An administrator enrols each agent with capabilities such as os=linux and environment=production, and with the projects it may run. The agent then runs your integrations, starting one Java process for each, and reports what it runs every 30 seconds.

Agent connections#

An agent’s host opens no inbound port. The agent connects out on port 443 to the two names of your Weik.io installation:

What leaves an agent’s host Carries
The leaf message server’s link to the hub, WebSocket over TLS The platform’s own messages and the events in both directions, and the files of each version the agent fetches
OpenTelemetry over HTTPS Log lines, metrics and traces from every Camel process and from the agent

An integration’s calls to other systems, such as an ERP or a bank’s SFTP server, go from the agent’s host directly to that system on its own ports.

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo