Your first integration

You need an installation you can reach and an API key with a grant on a project, or the dev container, where the CLI is already signed in and you can start from step 2. Install the CLI if you haven’t yet.

1. Sign in#

On a machine with a browser, weikio login opens the installation’s approval page, and you approve the login there. On a machine without one it asks for an API key with hidden input, as below. Either way the CLI keeps the key in your system’s keyring.

$ weikio login https://hub.example --project sandbox --env devtest

API key: ********
Context 'hub.example' saved and made current (server https://hub.example, project sandbox, environment devtest).

The context remembers the server, the project and the environment, so the commands below don’t repeat them. A production environment always needs --env, whatever the context says.

2. Create the integration#

$ 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 project sandbox and environment devtest:
  weikio run ./hello

hello.camel.yaml is a Camel route that a timer starts every five seconds and that logs the message from application.properties. integration.yaml has the integration’s name and commented examples of what you add later: a Camel version, requirements, dependencies and shared kamelets. A name can use only lower-case letters, digits and hyphens, so weikio init HelloWorld is refused with the name it suggests instead.

3. Run it on devtest#

weikio run publishes the folder as a version, deploys it to the environment and follows its log lines:

$ weikio run ./hello

Target: https://hub.example, 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  agent-fi-01  Exchange[ExchangePattern: InOnly, BodyType: String, Body: hello from weikio]
09:14:12.114 UTC INFO  hello  agent-fi-01  Exchange[ExchangePattern: InOnly, BodyType: String, Body: hello from weikio]
^C

The first line of every command that changes something says which server, project and environment it used and where each came from. Most of the first build’s 16 seconds go to resolving Camel’s libraries at the hub. A later build that changes only configuration is done in a second or two.

4. See where it runs#

weikio status lists each environment with the version, the state, the agent and since when it has run. weikio logs prints the log lines the integration wrote.

$ weikio status sandbox/hello
$ weikio logs sandbox/hello --since 10m

5. Change it#

Edit the route, for example the message in application.properties, and run the same command again. The CLI publishes the change as the next patch version and the deployment moves to it:

$ weikio run ./hello

Target: https://hub.example, project sandbox (context), environment devtest (context)
integration sandbox/hello updated (version 0.1.1, built in 15.9 s)
deployment devtest/sandbox/hello updated (follows latest)

The same integration in the admin UI#

Open the installation’s address in your browser and sign in. hello is on the Integrations page. Its own page has the sections you used from the CLI: Overview, Metrics, Traces and Logs, Versions with 0.1.0 and 0.1.1, Environments with devtest, and Source with the files of each version. The admin UI page shows how to create the next integration there.

weikio run is for development. Versions and the developer loop splits it into apply and deploy, and Environments and promotion shows how a version gets to production.