From e74bb1e309b4f1b65dd3a18dd98790fe894de9ec Mon Sep 17 00:00:00 2001 From: Maor Friedman Date: Thu, 21 Feb 2019 15:47:55 +0200 Subject: [PATCH] update development environment documentation --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c5e673f..738c36d 100644 --- a/README.md +++ b/README.md @@ -58,29 +58,32 @@ yarn build # Start the server LOAD_METHOD=fs DATAFILES_FILE= yarn run server ``` -## Creating the data and schema bundles +## Creating the schema, data and resources bundle The bundles are required to run the validation and to start the server. ```sh -docker pull quay.io/app-sre/qontract-validator:latest -docker run --rm -v $DATA_DIR:/data:z quay.io/app-sre/qontract-validator:latest qontract-bundler /data > data.json -docker run --rm -v $SCHEMAS_DIR:/schemas:z quay.io/app-sre/qontract-validator:latest qontract-bundler /schemas > schemas.json +mkdir -p $BUNDLES_DIR +docker run --rm \ + -v $SCHEMAS_DIR:/schemas:z \ + -v $DATA_DIR:/data:z \ + -v $RESOURCES_DIR:/resources:z \ + quay.io/app-sre/qontract-validator:latest + qontract-bundler /schemas /data /resources > $BUNDLES_DIR/bundle.json ``` -As of right now, the `$SCHEMAS_DIR` is `assets/schemas/` dir in the -`qontract-server` git repository, although in the future it will be removed from -this repository. +* `SCHEMAS_DIR` - `assets/schemas/` dir in the `qontract-server` git repository + * in the future it will be removed from this repository +* `DATA_DIR` - `/data` dir in the `app-interface` git repository +* `RESOURCES_DIR` - `/resources` dir in the `app-interface` git repository +* `$BUNDLES_DIR` - a directory that will contain the created `bundle.json` file -## Validating the data against the schemas +## Validating the bundle ```sh -docker run --rm -v $BUNDLES_DIR:/bundles:z quay.io/app-sre/qontract-validator:latest qontract-validator --only-errors /bundles/schemas.json /bundles/data.json +docker run --rm -v $BUNDLES_DIR:/bundle:z quay.io/app-sre/qontract-validator:latest qontract-validator --only-errors /bundle/bundle.json ``` -The `$BUNDLES_DIR` is a directory that must contain the `data.json` and -`schemas.json` file created in the previous section. - ## Style All code should follow the [airbnb style guide], which is enforced by this