k8s Services List

Kubernetes service discovery

Checkout the OpenAPI spec here

Installation

Install deps with npm

npm install

Install Git Hooks

npx husky install

Run Locally

Clone the project

git clone git@github.com:MapColonies/k8s-services-list.git

Go to the project directory

cd k8s-services-list

Install dependencies

npm install

Start the server

npm run start

Running Tests

To run tests, run the following command

npm run test

To only run unit tests:

npm run test:unit

To only run integration tests:

npm run test:integration

Deployment

Important

We depend on Red-Hat Yaml Extension for validating the values files against the relevant schemas from helm-common. That means, you should install the extension from vscode in order to be able to edit values files according to our schemas.

To update helm dependencies

npm run helm-update

In order to create/renew values schemas

npm run helm-assets

To deploy: helm values MUST be combined from global.yaml and values.yaml (use npm script!)

npm run helm-install

See helm values