Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 2.44 KB

README.md

File metadata and controls

98 lines (69 loc) · 2.44 KB
Raw

qontract-server

qontract (Queryable cONTRACT) is a collection of tools used to SREs to expose available managed services to application developer teams. This repository compromises the server component, which is implemented as a GraphQL API.

Development Environment

Although it is not required, it's recommended that you use yarn for install dependencies and running development scripts.

To install this projects dependencies to a local node_modules directory:

yarn install

To run a process that watches for edits and rebuilds JavaScript from TypeScript:

yarn run watch

Or alternatively, you can run the TypeScript compilation once:

yarn build

To run an instance of the qontract GraphQL console:

LOAD_METHOD=fs DATAFILES_FILE=your_test_datafile yarn run server

Specific instructions for CentOS 7:

# Install node10
sudo yum install centos-release-scl-rh
sudo yum install rh-nodejs10

# Install yarn (as root)
scl enable rh-nodejs10 bash
npm install -g yarn

# Enable node10 (as user in qontract-server git repo)
scl enable rh-nodejs10 bash

# Install qontract-server yarn modules
yarn install

# Build the JavaScript
yarn build

# Start the server
LOAD_METHOD=fs DATAFILES_FILE=<data-bundle-json> yarn run server

Creating the schema, data and resources bundle

The bundles are required to run the validation and to start the server.

mkdir -p $BUNDLES_DIR
docker run --rm \
    -v $SCHEMAS_DIR:/schemas:z \
    -v $GRAPHQL_SCHEMA_DIR:/graphql:z \
    -v $DATA_DIR:/data:z \
    -v $RESOURCES_DIR:/resources:z \
    quay.io/app-sre/qontract-validator:latest \
    qontract-bundler /schemas /graphql/schema.yml /data /resources > $BUNDLES_DIR/bundle.json
  • SCHEMAS_DIR - dir that contains the JSON schemas (this is not used by this server).
  • GRAPHQL_SCHEMA_DIR - dir that contains the file schema.yml representing the GraphQL schema.
  • DATA_DIR - dir that contains the datafiles.
  • RESOURCES_DIR - dir that contains the resources.
  • $BUNDLES_DIR - a directory that will contain the created bundle.json file.

Validating the bundle

docker run --rm -v $BUNDLES_DIR:/bundle:z quay.io/app-sre/qontract-validator:latest qontract-validator --only-errors /bundle/bundle.json

Style

All code should follow the airbnb style guide, which is enforced by this projects lint script:

yarn run lint