Added draft of Coder and Nix article #10
Conversation
|
Updated to include content fixes and remove header content. |
|
|
||
| Nix is a very robust, and at times complicated, platform. This article will attempt to describe how to use Nix with Coder at a high level. For additional information about Nix, please visit [https://nixos.org/](https://nixos.org/). | ||
|
|
||
| ### Benefits to using Nix |
There was a problem hiding this comment.
I wish there were some diagrams we could use to break up these sections, but I couldn't find anything particularly simple. Any ideas?
There was a problem hiding this comment.
I can come up with some diagrams over the weekend and will add them to the article by Monday.
posts/coder-and-nix/index.md
Outdated
| ## Using Nix with Coder | ||
|
|
||
| Now that you have your NodeJS environment and custom toolchain setup in `shell.nix`, lets add Coder to your environment. Coder is available as a nix package and can be added to your config as the same way you have added your custom software in your tool chain. You can do so by modifying your `shell.nix` file to include the Coder package, like in the example code below: |
There was a problem hiding this comment.
Let's take another direction with this section. Instead of showing how to install the Coder CLI locally, let's provide an example template in Coder that users can choose to create remote workspaces that contain the nix shell. These workspaces could be provisioned on AWS, Docker, or Kubernetes. I have no preference, but we could show each 🤷🏼
Then, each developer could spin up a workspace and use nix to get the tools they need for their workspace inside the home directory. If it'd be helpful, I can set you up with a Coder workspace and we can work through this template.
There was a problem hiding this comment.
Ok, that works for me. I initially had a section discussing templates but I wasn't sure how to connect it to the rest of the article.
It would be helpful to work through the template together so I can get an idea of how it all works. Thanks!
|
|
||
| ### Bring Your Tools with Nix | ||
|
|
||
| As a developer using Nix as part of a project, you can bring your own tools by using Nix shell. By default, Docker does not allow you to bring your own custom configuration to the development environment. For example, say you have spent some time configuring your shell environment with themes and plugins. To use these tools with Docker you would have to add the shell configuration files to your Docker image, and everyone else on your team would need to use the same shell configuration. This becomes an issue if your teammates don't use the same tools and plugins. In order for you to use your own configuration you would have to maintain your own separate container containing your personal configuration and if that container fails, you are responsible for troubleshooting and fixing everything in order to continue development on your app. |
There was a problem hiding this comment.
Let's mention dotfiles as an option to customize your shell, even with Docker. A lot of our users use this, but it does require extra work.
There was a problem hiding this comment.
The dotfiles link you included resolves to a 404, but I did find this discussion. Is it related?
posts/coder-and-nix/index.md
Outdated
|
|
||
| However mixing this infrastructure with the development environment can sometimes limit the developers ability to use the tools they are comfortable with. Developers must give up their preferred shell configuration and tooling in favor of a base set of tools and settings determined by the infrastructure. Many developers can pick up new tooling without much difficulty, but having a top-down approach to the development environment means not only are these tools fixed for the project, they may eventually break if the resources in the dockerfile become outdated. | ||
|
|
||
| Additionally, Docker requires that your team understands Docker and how it works to some degree. This is particularly important if something does happen to break within Docker -- your development team has to know how to troubleshoot the issue before they can resolve it. This is particularly difficult since Docker works differently between platforms. An issue one team member may have on Windows can be vastly different from issues MacOS based developers may face. There is a potential for a huge amount of lost productivity when these issues come up, both in time and brainpower spent trying to fix the issue. And when its only your setup that doesn't work with Docker you find yourself facing the [it works on my machine](https://coder.com/blog/it-s-works-on-my-machine-explained) problem. |
There was a problem hiding this comment.
This is a great paragraph. Let's specifically mention that there have historically been various issues running Docker on the m1.
There was a problem hiding this comment.
Will do. I was wondering how many platform-specific issues to include, and I'll defintely add info about using M1 machines.
There was a problem hiding this comment.
Added a sentence to mention issues with the M1 chip, including links to more info.
I mentioned this in another comment, but can definitely get some images and diagrams together for this article. I'll start putting those together today, and will add those in by Monday. |
|
|
||
| To use this `shell.nix` file you can run `nix-shell` without any arguments. The `nix-shell` tool will look for this file by default. | ||
|
|
||
| ### Adding Your Tools to A Shared `shell.nix` Configuration |
There was a problem hiding this comment.
This is super solid, let's explain how this shell.nix can be used inside a Coder workspace in the next section
There was a problem hiding this comment.
Added this under the "NixOS, Docker, and nix-shell" section
|
|
||
| Now running the `nix-shell` command will create an environment containing the shared NodeJS nix configuration and your custom toolchain. | ||
|
|
||
| ## Using Nix with Coder |
There was a problem hiding this comment.
Let's replace with:
- Adding template to Coder that includes Nix (Docker template modified with nix-devcontainer image)
- Adding this shell.nix into workspace
- Also cloning a "todo" project (or something cooler) and running it in Coder: https://github.com/nix-community/todomvc-nix
There was a problem hiding this comment.
Added instructions for this process, let me know if they need any adjusting. I ran into an issue buidling the todomvc-nix project so I'm currently looking for replacement.
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: Ben Potter <me@bpmct.net>
Co-authored-by: Ben Potter <me@bpmct.net>
|
recommend nudging folks to https://devenv.sh (which is chrome over nix) than directly to nix btw. |
Submitting the first draft of the article. I am going to do a quick review to check for minor changes this evening and push a new draft if any corrections are required.
closes: coder/coder#6447