Compare to similar tools #135
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,20 @@ See <https://community.flake.parts/services-flake/start> | |
|
|
||
| List of supported services is available at https://community.flake.parts/services-flake/services | ||
|
|
||
| ## Comparison with similar approaches | ||
|
|
||
| | | services-flake | [devenv](https://devenv.sh/) | | ||
| | --- | --- | --- | | ||
| | macOS support | ✔️ | ✔️ | | ||
| | Pure Flakes | ✔️ | ❌[^1] | | ||
| | Share services across flakes | ✔️[^2] | ❌ | | ||
| | Services as flake apps | ✔️ | ❌[^3] | | ||
|
There was a problem hiding this comment. From https://devenv.sh/guides/using-with-flake-parts/
But the page doesn't explain how exactly one starts devenv services without using its CLI. There was a problem hiding this comment. In the flake I created here, I explored the flake in nix repl, and these are the packages it exports: nix-repl> packages.x86_64-linux.
packages.x86_64-linux.container-processes packages.x86_64-linux.default
packages.x86_64-linux.container-shell packages.x86_64-linux.devenv-upThere was a problem hiding this comment. But I can’t seem to be able to ❯ nix run .#devenv-up --impure
warning: Git tree '/home/shivaraj/oss/devenc' is dirty
trace: warning: getExe: Package "cowsay-3.7.0" does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, use getExe' to specify the name to the program, such as lib.getExe' foo "bar".
error: unable to execute '/nix/store/67lf41ig3sf8z4i6lnigfn4c0icyb830-devenv-up/bin/devenv-up': Not a directoryProbably it doesn’t have a bin output There was a problem hiding this comment. This works fine: And produces a result whose contents are: ❯ cat /nix/store/67lf41ig3sf8z4i6lnigfn4c0icyb830-devenv-up
#!/nix/store/087167dfxal194pm54cmcbbxsfy3cjgn-bash-5.2p26/bin/bash
/nix/store/lb2b16q8kc3xynj27d25sahhq95ph43h-process-compose-0.88.0/bin/process-compose --config /nix/store/vhxxz7j5bjlyi0ggfx4dlcf9an61p09q-process-compose.yaml \
--port ${PC_HTTP_PORT:-9999} \
--tui=${PC_TUI_ENABLED:-1} \
up "$@" &
if [[ ! -d "$DEVENV_STATE" ]]; then
mkdir -p "$DEVENV_STATE"
fi
stop_up() {
echo "Stopping processes..."
kill -TERM $(cat "$DEVENV_STATE/devenv.pid")
rm "$DEVENV_STATE/devenv.pid"
wait
echo "Processes stopped."
}
trap stop_up SIGINT SIGTERM
echo $! > "$DEVENV_STATE/devenv.pid"
wait
There was a problem hiding this comment. But when I try to run it, ❯ ./result
mkdir: cannot create directory ‘’: No such file or directory
./result: line 25: /devenv.pid: Permission deniedThere was a problem hiding this comment. But the same configuration works (including There was a problem hiding this comment. If I run I was able to execute queries using shivaraj=# create table id(id int);
CREATE TABLE
shivaraj=# \dt
List of relations
Schema | Name | Type | Owner
--------+------+-------+----------
public | id | table | shivaraj
(1 row)There was a problem hiding this comment.
This is because of not exporting DEVENV_STATE=$(pwd) ./resultBut even after that I couldn’t get it running using the There was a problem hiding this comment. In conclusion, we can confidently say that devenv doesn't support running services (nevermind individual process groups) as a flake app. |
||
|
|
||
| [^1]: Devenv's flakes integration [requires](https://devenv.sh/guides/using-with-flakes/) you use run the nix shell in impure mode by passing `--impure`. | ||
| [^2]: `services-flake` is built on top of [flake-parts](https://flake.parts/), thus you may share your service and process modules for re-use across flakes, whilst making them general enough for customization based on the module system. | ||
| [^3]: `services-flake` produces a flake app that you can run using the Nix command, `nix run`, whereas with devenv you must use devenv's CLI, `devenv up`. | ||
|
|
||
|
|
||
| ## A note on process working directory | ||
|
|
||
| The `dataDir` of these services tend to take *relative* paths, which are usually relative to the project root. As such, when you run these services using `nix run`, their data files are created relative to whichever directory you are in. If you want these data files to always reside relative to the project directory, instead of using `nix run` consider wrapping the process-compose packages in script, via either [mission-control](https://community.flake.parts/mission-control) module or a [justfile](https://just.systems/). The example uses the latter. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This maybe inaccurate.
cf. https://devenv.sh/guides/using-with-flake-parts/#import-a-devenv-module
But I haven't used devenv enough to say if its module system works without any idiosyncratic shortcomings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on what I see, if you are able to
importa module, you should be able to share services even usingdevenv.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And I tried it out:
Here’s the
perSystemblock from my flake:And this is the
devenv-module.nix:I do use
nix develop —impurefollowed bydevenv upto run them but in terms of sharing services, it works, i.e if you are willing to stick to devenv cli.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although it allows sharing modules between flakes like above, you can’t really share it within the flake to an extent we do in Nammayatri, to provide
nix run #load-test-dev, which adds a bunch of processes of its own after sharing the entire backend configuration of nammayatri that is started vianix run .#run-mobility-stack-dev.In short,
devenvallows you to create and merge processes declaratively but all these processes belong to the same group, you can’t define two sets of different groups with a few/all distinct processes.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The screenshots you posted above show modular import of devenv config, not devenv services. ie., we can't do the following, right?
Which explains why you can't compose and share services per se, and must create modules for whole devenv config.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, hope I haven’t missed something. Let me give it one more shot to be certain, don’t want to make false claims because of missing some details.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shivaraj-bh https://discord.com/channels/1036369714731036712/1036369758024650792/1215626814710620190
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't gotten any clear and unambiguous response from the devenv community, so let's just merge this. If they correct us by providing an example, we can change the README obviously.