kds/README.md
Andrew Mayorov 30ff7527ae
TD-222: Sync with valitydev/erlang-templates@da1971c (#1)
* Get rid of proprietary CI bits
* Update sys.config
* Add appsec team as CODEOWNERS
* Add CI through GH Actions workflows
* Switch to valitydev upstreams
2022-07-11 14:29:55 +03:00

1.7 KiB

KDS

Keyring Distribution Service. Allows securely managing keyring and provide CDS with keyring secrets.

Building

To build the project, run the following command:

$ make compile

Running

To enter the Erlang shell with the project running, run the following command:

$ make rebar-shell

Development environment

Run in a docker container

You can run any of the tasks defined in the Makefile from inside of a docker container (defined in Dockerfile.dev) by prefixing the task name with wc-. To successfully build the dev container you need Docker BuildKit enabled. This can be accomplished by either installing docker-buildx locally, or exporting the DOCKER_BUILDKIT=1 environment variable.

Example

  • This command will run the compile task in a docker container:
$ make wc-compile

Run in a docker-compose environment

Similarly, you can run any of the tasks defined in the Makefile from inside of a docker-compose environment (defined in docker-compose.yaml) by prefixing the task name with wdeps-. To successfully build the dev container you need Docker BuildKit enabled (see Run in a docker container section). It may also be necessary to export a COMPOSE_DOCKER_CLI_BUILD=1 environment variable for docker-compose container builds to work properly.

Example

  • This command will run the test task in a docker-compose environment:
$ make wdeps-test

Documentation

@TODO Please write a couple of words about what your project does and how it does it.