Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add a README to the Nixfiles, improve formatting #11472

Merged
merged 1 commit into from
Jul 29, 2023
Merged

docs: add a README to the Nixfiles, improve formatting #11472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions dev/nix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Argo Nixfiles

See [Try Argo using Nix](../../docs/running-nix.md).
13 changes: 6 additions & 7 deletions docs/running-nix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ Nix is a package manager / build tool which focuses on reproducible build enviro
Argo Workflows has some basic support for Nix which is enough to get Argo Workflows up and running with minimal effort.
Here are the steps to follow:

1. Modify the hosts file according to [this](https://argoproj.github.io/argo-workflows/running-locally/), don't worry about the other instructions.
2. Set up a kubernetes cluster, k3d is the recommended solution here.
3. Install [Nix](https://nixos.org/download.html).
4. Run "nix develop --extra-experimental-features nix-command --extra-experimental-features flakes ./dev/nix/ --impure" (you can add the extra features as a default in your nix.conf file).
5. Run "devenv up".
1. Modify your hosts file and set up a Kubernetes cluster according to [Running Locally](https://argoproj.github.io/argo-workflows/running-locally/). Don't worry about the other instructions.
1. Install [Nix](https://nixos.org/download.html).
1. Run `nix develop --extra-experimental-features nix-command --extra-experimental-features flakes ./dev/nix/ --impure` (you can add the extra features as a default in your `nix.conf` file).
1. Run `devenv up`.

## Warning

This is still bare-bones at the moment, any feature in the Makefile not mentioned here is excluded for now.
In practice this means that only a "make start UI=true" equivalent is supported at the moment, as an additional caveat, there are no LDFlags set in the build,
as a result the UI will show "0.0.0-unknown" for the version.
In practice, this means that only a `make start UI=true` equivalent is supported at the moment.
As an additional caveat, there are no LDFlags set in the build; as a result the UI will show `0.0.0-unknown` for the version.

## How do I upgrade a dependency?

Expand Down