Contributing¶

General Contribution¶

For general rule regarding contribution to BiznetGio projects. See BiznetGio Contributing Guide

Runing the project locally¶

Cockroachdb¶

$ cockroach start --insecure --host=localhost

RESTKNOT API¶

Clone the project https://github.com/BiznetGIO/RESTKnot/

Go to the API directory

$ cd api/

RESTKnot API consume the configuration from OS environment variables. So make sure you have set them. Take a look into .env.example and change the default values according to your situation.

Then run the app:

$ flask run

Broker¶

In order for RESTKnot API to communicate with REStKnot Agent, they need a broker. We use Kafka for the broker.

It’s easier to use dockerized kafka and zookeper. Use the snippet below then run them using docker-compose -f docker-compose-kafka.yml up

version: '3'
services:
  zookeeper:
    image: wurstmeister/zookeeper
  kafka:
    image: wurstmeister/kafka
    ports:
        - "9092:9092"
    environment:
        KAFKA_ADVERTISED_HOST_NAME: localhost
        KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181

RESTKNOT Agent¶

Go to the Agent directory

$ cd agent/

Set appropriate configurations. Take a look at .env.example in agent directory and run them manually. At this moment RESTKNOT Agent doesn’t load them automatically.

You can run the Agent in user mode, but some OS need superuser in order for knot to create DNS records. -E argument is used to supply regular user OS environment to sudo user.

$ sudo -E ~/.virtualenvs/rest-knot/bin/dnsagent start master

Runing the project using Docker¶

In order to run the project using docker. First you need to build both api and agent image, then run them using docker compose. To see how to build them, take a look at Deployment Steps section.

To run api (flask), agent (cli), and broker (kafka) container. You need to provide the bridged network in their respective docker compose file. e.g:

  kafka:
     image: wurstmeister/kafka
     ports:
         - '9092:9092'
     environment:
         KAFKA_ADVERTISED_HOST_NAME: 172.17.0.1
         KAFKA_ZOOKEEPER_CONNECT: 'zookeeper:2181'
     networks:  # <--- add the network to kafka
         - agent_rknt-agent-net

# put at the bottom of the file
networks:
    agent_rknt-agent-net:
        external: true

Always keep in mind that you can’t use localhost or 127.0.0.1 in KAFKA_ADVERTISED_HOST_NAME otherwise it won’t work.