Weik.io is an open source GitOps integration platform that manages integrations, APIs, file transfers and events.

• Weik.io: https://weik.io
• Docs: https://weik.io/docs
• University: https://weik.io/university
• Weik.io Cloud: https://weikio.cloud
• Live demo: https://demo.weik.io
• GitHub: https://github.com/weikio/weikio

Call the live demo

The live demo at https://demo.weik.io is a running Weik.io with a finance project, its integrations and an API gateway. This call goes to the API echo on the demo's gateway without a key, and the gateway refuses it with 401:

curl -i https://api.demo.weik.io/echo/v1/

HTTP/2 401
www-authenticate: ApiKey
content-length: 0
strict-transport-security: max-age=31536000
x-content-type-options: nosniff
referrer-policy: no-referrer
permissions-policy: camera=(), microphone=(), geolocation=(), payment=()
traceresponse: 00-25978b47a71d0bcdc2ace0d95319d1db-835efab335bfc965-01

Every answer carries a traceresponse header with the ID of your call's trace. To see the call in the admin UI, sign in to the live demo as the viewer, open APIs, then echo and Requests. The newest row is your call, and its trace opens from that row.

Run it on your machine

The Try Weik.io dev container runs the whole platform on your machine, with the weikio CLI signed in and the admin UI at http://localhost:8580. It needs Docker with 8 GB of memory, 4 CPUs and 20 GB of free disk, and the steps are in weikio/try-weikio.

Install the CLI

On Linux x64 the script checks the release's SHA256SUMS before it places ~/.local/bin/weikio. The line needs curl and ca-certificates, which minimal images such as debian:12 don't have, so install them there first with apt-get install -y curl ca-certificates:

curl -fsSL https://weik.io/install.sh | sh

On Windows x64 it runs in PowerShell without administrator rights, and the CLI is signed by Adafy Oy:

irm https://weik.io/install.ps1 | iex

Your first integration

weikio init writes an integration folder with a Camel route and two settings files, and weikio run publishes it, deploys it to devtest and follows its log lines:

$ weikio init hello
Created hello/
  hello.camel.yaml        timer -> log, runs every 5 s
  application.properties  message=hello from weikio
  integration.yaml        name hello, other fields as commented examples

Next, to run it in environment devtest:
  weikio run ./hello

$ weikio run hello
Target: http://localhost:8580, project sandbox (context), environment devtest (context)
integration sandbox/hello created (version 0.1.0, built in 16.2 s)
deployment devtest/sandbox/hello created (follows latest)
Following the log lines of sandbox/hello. Ctrl-C stops following, and the integration keeps running.
09:14:07.113 UTC INFO  hello  dev  Exchange[ExchangePattern: InOnly, BodyType: String, Body: hello from weikio]
09:14:12.114 UTC INFO  hello  dev  Exchange[ExchangePattern: InOnly, BodyType: String, Body: hello from weikio]

The first build takes about 16 seconds because the hub resolves the Camel libraries the integration uses. A later change to configuration alone builds in a second or two. The guide with every step is Your first integration.

Examples

The examples folder has the integrations that the docs, the University videos and the live demo use, and its README shows how to apply them to your own installation:

• hello: the integration weikio init hello writes, a timer that logs a line every 5 seconds
• finance/erp-invoice-export: a Camel integration that sends each new invoice to the ERP over HTTP, with a variable, a secret and the custom metric invoices_processed
• finance/transfers/supplier-invoices.yaml: a transfer that moves supplier invoice PDFs from an FTP server to Azure Blob Storage every morning at 05:00 UTC
• finance/apis/invoices: the API finance/invoices with version v1 and the subscription partner-x
• finance/invoice-created: the channel that erp-invoice-export publishes to and invoice-archiver receives from
• .github/workflows: plan.yaml, devtest.yaml and production.yaml, the GitHub Actions workflows that show the plan on each pull request and apply the folder to devtest and production after a merge

Install Weik.io

• Install a hub on one server
• Install a hub on three or five servers
• Sites and agents
• Install the CLI

The images are on Docker Hub, tagged with the exact version and with no latest tag: weikio/weikio-backend, weikio/weikio-agent, weikio/weikio-apim and weikio/weikio-forwarder.

Current release

CHANGELOG.md lists every release with its notes. To hear about each new release, watch this repository with Custom and Releases.

Licence

Weik.io is open source under the Apache License 2.0, copyright Adafy Oy.

Ideas

Post your ideas in the Ideas category of Discussions, where the Weik.io team answers them. The next releases and the larger steps after them are on Where Weik.io is going.

Getting help

• Ask questions in Discussions.
• Report a bug with the bug form, and a problem in the docs with the docs form.
• Support subscriptions for the installations you run yourself are on https://weik.io/support, and the team that develops Weik.io answers every case.

Security

Report a vulnerability to security@weik.io or through GitHub's private vulnerability reporting on this repository. SECURITY.md says what to include and which releases receive fixes.