From 48addb7f050cf11931849d2b01cebad6bef707bb Mon Sep 17 00:00:00 2001 From: Seth Hoenig Date: Wed, 9 Mar 2022 12:46:57 -0600 Subject: [PATCH] docs: describe the cgo dependency --- contributing/cgo.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 contributing/cgo.md diff --git a/contributing/cgo.md b/contributing/cgo.md new file mode 100644 index 000000000..66449ad77 --- /dev/null +++ b/contributing/cgo.md @@ -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.