juspay/services-flake
1
1
Fork 0
mirror of https://github.com/juspay/services-flake.git synced 2024-09-11 04:15:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(start): Improve a bit

Browse Source
This commit is contained in:
Sridhar Ratnakumar 2024-06-04 13:51:23 -04:00 committed by GitHub
parent 24a7b57527
commit f7e6af5ec3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/start.md
View File

@ -17,18 +17,22 @@ nix run
## Existing project
services-flake uses [process-compose-flake](https://community.flake.parts/process-compose-flake) to manage the services. Let's first import the `flake-parts` modules provided by `process-compose-flake` and `services-flake` in your flake:
```nix
{
# 1. Add the inputs
inputs.process-compose-flake.url = "github:Platonic-Systems/process-compose-flake";
inputs.services-flake.url = "github:juspay/services-flake";
...
outputs = inputs:
inputs.flake-parts.lib.mkFlake { inherit inputs; } {
imports = [
# 2. Import the flake-module
inputs.process-compose-flake.flakeModule
];
perSystem = { ... }: {
process-compose."default" = {
# 3. Create the process-compose configuration, importing services-flake
process-compose."myservices" = {
imports = [
inputs.services-flake.processComposeModules.default
];
@ -37,25 +41,28 @@ services-flake uses [process-compose-flake](https://community.flake.parts/proces
};
}
```
As an example, let's add the `redis` service to your flake:
```nix
# Inside `perSystem.process-compose.default`
# Inside `perSystem.process-compose."myservices"`
{
services.redis."r1".enable = true;
}
```
Time to run the service:
```sh
nix run
nix run .#myservices
```
## Under the hood
- The `services-flake` module configures [process settings](https://community.flake.parts/process-compose-flake#usage) for a service. In simple terms, it handles stuff like health checks, restart policies, setup scripts, etc. by using the easy to configure APIs provided by `process-compose-flake`.
- The `process-compose-flake` module uses these settings to generate `packages.${system}.default`[^how-default] (`nix run` above, runs this package by default), which runs [process-compose](https://github.com/F1bonacc1/process-compose) with the generated YAML configuration[^sample-config].
- The `process-compose-flake` module uses these settings to generate `packages.${system}.myservices`[^how-default] (`nix run .#myservices` above, [runs](https://nixos.asia/en/nix-first#run) this package by default), which runs [process-compose](https://github.com/F1bonacc1/process-compose) with the generated YAML configuration[^sample-config].
[^how-default]: `default` is the name of the process group that is derived from `process-compose.<name>` in `perSystem.process-compose`.
[^how-default]: `myservices` is the name of the process group that is derived from `process-compose.<name>` in `perSystem.process-compose`.
[^sample-config]: See the example configuration from the [getting started](https://f1bonacc1.github.io/process-compose/intro/) section of the process-compose docs.