Installing services

Using Kargo

You can easily connect Kano with geospatial services deployed by Kargo through its API gateway. First add the Kano application/consumer in the gateway configuration by generating a UUID:

users: {
  my_user: {
    'kano': {
      scopes: ['wms', 'wmts', 'tms', 'wfs', 'wcs', 'k2'],
      credential: {
        type: 'jwt',
        keyId: '9ba09ead-23e1-4020-9994-aa9130782b09',
        keySecret: '${APP_SECRET}'
      }
    }
  }
}

Then add the following environment variables before launching the Kano backend:

// Setup the target gateway
export API_GATEWAY_URL="https://api.your.kargo.domain"
export APP_ID="9ba09ead-23e1-4020-9994-aa9130782b09"
yarn dev

This will automatically generate a valid token for the gateway once you log in and add it to any request targeting a service behind the gateway.

Kargo can also automatically deploy for you krawler jobs, Kapture, Geokoder, K2, etc. as services.

Using Docker

As for Kano we provide Docker images on the Docker Hub to ease deploying your own service instances. Although it's possible to directly run Docker commands we provide you with docker-compose files to ease deployment, in addition to minimalist configuration files. These files will be detailed in the following sections and are available in the public folder of the documentation.

Add gateway

The following commands and additional docker-compose file should do the job:

// Run the Gateway and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml up -d
// Stop the Gateway and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml down
// Stop the Gateway and Kano containers erasing DB data
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml down -v

docker-compose-gateway.yml - Used to deploy gateway container.

version: '3.3'

services:
  kano:
    environment:
      - API_GATEWAY_URL=http://localhost:8082
  gateway:
    image: kalisio/express-gateway:1.16.9
    environment:
      - KAPTURE_URL=http://kapture:3000
      - GEOKODER_URL=http://geokoder:8080
    volumes:
      - type: bind
        source: ./gateway.config.yml
        target: /var/lib/eg/gateway.config.yml
    ports:
      - "8082:8080"
    networks:
      - kano

Add kapture

Kano integrates smoothly with Kapture in order to perform customizable screenshots, i.e. map prints.

The following commands and additional docker-compose file should do the job:

// Run the Gateway, Kapture and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-kapture.yml up -d
// Stop the Gateway, Kapture and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-kapture.yml down
// Stop the Gateway, Kapture and Kano containers erasing DB data
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-kapture.yml down -v

docker-compose-kapture.yml - Used to deploy kapture container.

version: '3.3'

services:
  kapture:
    image: kalisio/kapture:latest
    environment:
      - KANO_URL=http://kano:8081
      - KANO_JWT=eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJhdWQiOiJrYWxpc2lvIiwiaXNzIjoia2FsaXNpbyJ9._HslaK0hTlISw_wGkUJYmpZdcNuWWGB1iHJDApeJxWk
      - DEBUG=kapture*
    ports:
      - "8083:3000"
    networks:
      - kano

Add geokoder

Kano integrates smoothly with Geokoder in order to perform geocoding.

The following commands and additional docker-compose file should do the job:

// Run the Gateway, Geokoder and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-geokoder.yml up -d
// Stop the Gateway, Geokoder and Kano containers
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-geokoder.yml down
// Stop the Gateway, Geokoder and Kano containers erasing DB data
docker-compose -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-geokoder.yml down -v

docker-compose-geokoder.yml - Used to deploy geokoder container.

version: '3.3'

services:
  geokoder:
    image: kalisio/geokoder:latest
    environment:
      - DEBUG=geokoder*
    volumes:
      - type: bind
        source: ./local-geokoder.cjs
        target: /geokoder/config/local.cjs
    ports:
      - "8084:8080"
    networks:
      - kano

Add k2

Coming soon

From source code

First you have to ensure the KDK prerequisites to run services from source code.

Add gateway

As the goal here is not to test, inspect or develop the gateway itself, but rather the underlying services, we will run the gateway using a Docker container in host network mode to ensure it can access services deployed on your localhost:

docker run --name="gateway" --network="host" --rm --init -it -e "PORT=8082" -e "KAPTURE_URL=http://localhost:8083" -e "GEOKODER_URL=http://localhost:8084" --mount type=bind,source=./gateway.config.yml,target=/var/lib/eg/gateway.config.yml,readonly kalisio/express-gateway:1.16.9

TIP

To get details about the gateway.config.yml file used to deploy gateway container please refer to the previous Docker-based section.

After launching the gateway change the following environment variables before launching the Kano backend:

// Setup the target gateway
export API_GATEWAY_URL="http://localhost:8082"
yarn dev

Add kapture

Once Kano and the gateway are running, the following commands should launch your local instance of Kapture:

// Clone Kapture
git clone https://github.com/kalisio/geokoder.git
cd geokoder
yarn install
// Set the most minimalist environment to run server
export PORT="8083"
export NODE_OPTIONS="--inspect-port=9233"
export KANO_URL="http://localhost:8080"
export KANO_JWT="eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJhdWQiOiJrYWxpc2lvIiwiaXNzIjoia2FsaXNpbyJ9._HslaK0hTlISw_wGkUJYmpZdcNuWWGB1iHJDApeJxWk"
yarn dev

Add geokoder

Once Kano and the gateway is running, the following commands should launch your local instance of Geokoder:

// Clone Geokoder
git clone https://github.com/kalisio/geokoder.git
cd geokoder
yarn install
// Copy local configuration (see previous Docker-based deployment section)
cp local-geokoder.cjs ./config/local.cjs
// Set the most minimalist environment to run server
export PORT="8084"
export NODE_OPTIONS="--inspect-port=9234"
yarn dev

Add k2

Coming soon