move documentation and add lockfile

artefactual-sdps · Jan 11, 2024 · 5e10cb5 · 5e10cb5
1 parent b2bac94
commit 5e10cb5
Show file tree

Hide file tree

Showing 3 changed files with 156 additions and 4 deletions.
diff --git a/devbox.json b/devbox.json
@@ -1,11 +1,12 @@
 {
   "packages": [
-    "go_1_20@latest",
     "kubectl@latest",
     "tilt@latest",
     "k3d@latest",
     "nodejs_20@latest",
-    "git@latest"
+    "git@latest",
+    "go_1_21@latest",
+    "docker@latest"
   ],
   "shell": {
     "init_hook": [

diff --git a/devbox.lock b/devbox.lock
@@ -0,0 +1,145 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "docker@latest": {
+      "last_modified": "2023-12-18T02:58:18Z",
+      "resolved": "github:NixOS/nixpkgs/ca16221251951e9c6261a1a2bb4f9389038d3632#docker",
+      "source": "devbox-search",
+      "version": "24.0.5",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/956bjn9hvpvha1bs7pwq1nhpddbhjh03-docker-24.0.5"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/ahkwpjvi9j78fd7cs9qwbj4k7v098ihh-docker-24.0.5"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/241nci502wbg13n28qd2fyia75fzbij3-docker-24.0.5"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/jcmgfbrxmcpmzgihy8ksmsizmnidl4sg-docker-24.0.5"
+        }
+      }
+    },
+    "git@latest": {
+      "last_modified": "2023-12-25T10:13:25Z",
+      "resolved": "github:NixOS/nixpkgs/e1fa12d4f6c6fe19ccb59cac54b5b3f25e160870#git",
+      "source": "devbox-search",
+      "version": "2.42.0",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/q7avibx4c00h7zl3jfh3r5mc4xs6wsnj-git-2.42.0"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/v7f1fag7w6ifk9cg1p5xhnnzy7mf0kmv-git-2.42.0"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/hhf2cldbfcndgilsak5x8dxphgj1y3id-git-2.42.0"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/31ypk253113v59lslsx8nbqpx794rlan-git-2.42.0"
+        }
+      }
+    },
+    "go_1_21@latest": {
+      "last_modified": "2023-09-27T18:02:17Z",
+      "resolved": "github:NixOS/nixpkgs/517501bcf14ae6ec47efd6a17dda0ca8e6d866f9#go_1_21",
+      "source": "devbox-search",
+      "version": "1.21.1",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/s1xk6hrfn0kw8ycvqbx4vv4gr00k6qpl-go-1.21.1"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/id3ygqxp1hvbh7dyjlwngx53fvcpqg84-go-1.21.1"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/yn0g820ayb963s0i4nnw9pf72l49kkg0-go-1.21.1"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/pvvv2lmx9m8b2n0447mljrl5xmla8r3h-go-1.21.1"
+        }
+      }
+    },
+    "k3d@latest": {
+      "last_modified": "2023-12-13T22:54:10Z",
+      "resolved": "github:NixOS/nixpkgs/fd04bea4cbf76f86f244b9e2549fca066db8ddff#k3d",
+      "source": "devbox-search",
+      "version": "5.6.0",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/n3lbia8wnx0z7dcl77p4gh2nzfnrp8qr-k3d-5.6.0"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/pf0akviafh3yh4riv97l81hcggq4kwn0-k3d-5.6.0"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/yds006zgkqmna4dmmv79byq1h48k81fv-k3d-5.6.0"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/9lkbnh2mj1gakza7skvvp3qf8x08rk66-k3d-5.6.0"
+        }
+      }
+    },
+    "kubectl@latest": {
+      "last_modified": "2023-12-13T22:54:10Z",
+      "resolved": "github:NixOS/nixpkgs/fd04bea4cbf76f86f244b9e2549fca066db8ddff#kubectl",
+      "source": "devbox-search",
+      "version": "1.28.4",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/n082kkafm88sckhn6dib17mr0izmgvgv-kubectl-1.28.4"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/ga2yx93m6hmdds1j42whq323jmdbr4ph-kubectl-1.28.4"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/340l2mgfk0bw31ssdxagny5rbimqxk9z-kubectl-1.28.4"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/wmz6qf68wysh6k8iqpqsbjpmwrxvwjcr-kubectl-1.28.4"
+        }
+      }
+    },
+    "nodejs_20@latest": {
+      "last_modified": "2023-12-13T22:54:10Z",
+      "resolved": "github:NixOS/nixpkgs/fd04bea4cbf76f86f244b9e2549fca066db8ddff#nodejs_20",
+      "source": "devbox-search",
+      "version": "20.10.0",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/rr171p6xks9xf2f0ds9wyi4mc36xm5c1-nodejs-20.10.0"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/hgm5r621kl22fgkb42q1bf9mj7vsydvp-nodejs-20.10.0"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/pq1p13a24628rxwf968nb3pfnpvpfy0r-nodejs-20.10.0"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/yc5bicc5zs5czjp5q5aygz79km84rmd4-nodejs-20.10.0"
+        }
+      }
+    },
+    "tilt@latest": {
+      "last_modified": "2023-12-18T02:58:18Z",
+      "resolved": "github:NixOS/nixpkgs/ca16221251951e9c6261a1a2bb4f9389038d3632#tilt",
+      "source": "devbox-search",
+      "version": "0.33.6",
+      "systems": {
+        "aarch64-darwin": {
+          "store_path": "/nix/store/hc6kajdwxxn50b0phq3ah0sfz6qadf7n-tilt-0.33.6"
+        },
+        "aarch64-linux": {
+          "store_path": "/nix/store/0v1wgi842bc3kvnpmd1fqim71y25f979-tilt-0.33.6"
+        },
+        "x86_64-darwin": {
+          "store_path": "/nix/store/rzcwha54x9cyk5kx9kkljnr1n94y89ll-tilt-0.33.6"
+        },
+        "x86_64-linux": {
+          "store_path": "/nix/store/djlz91qdbbdlx65b7fz8k9qw7sqhj13p-tilt-0.33.6"
+        }
+      }
+    }
+  }
+}
diff --git a/docs/src/dev-manual/devel.md b/docs/src/dev-manual/devel.md
@@ -1,11 +1,17 @@
 # Local/Development environment
 
-## Quickstart with Devbox
+## Requirements
+
+### Quickstart with Devbox
+
+Devbox is currently an experimental approach to managing and sharing our
+developer environments quickly and efficiently, it is not however *well
+tested*.
 
 First install [devbox]. After installing devbox, run `devbox shell`. Continue
 the instructions [here](#dex-host).
 
-## Requirements
+### Standard Installation
 
 Enduro uses Tilt to set up a local environment building the Docker images in a
 Kubernetes cluster. It has been tested with k3d, Minikube and Kind.