docs: describe the cgo dependency

This commit is contained in:
Seth Hoenig 2022-03-09 12:46:57 -06:00
parent 066a820209
commit ebae987480
1 changed files with 8 additions and 0 deletions

8
contributing/cgo.md Normal file
View File

@ -0,0 +1,8 @@
# CGO
Nomad requires the use of CGO on Linux.
Issue [#5643](https://github.com/hashicorp/nomad/issues/5643) tracks the desire for Nomad to not require CGO.
One of the core features of Nomad (the exec driver) depends on [nsenter](https://pkg.go.dev/github.com/opencontainers/runc/libcontainer/nsenter).
Until `nsenter` no longer requires CGO, the standalone Nomad executable on Linux will not be able to ship without depending on CGO.