Declarative projects

{"header":{"message":"doc: add basic docs about declarative projects","description":"Conversion of Shea's *.md, added as a subsection. Shea is left as author.\nI made this new bit a separate file, though it might be questionable.","timestamp":"2016-10-31T17:17:17Z","authors":[{"email":"shea@shealevy.com","name":"Shea Levy"}]},"hash":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC","authors":[],"deps":{"hashes":[["VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC","doc: add basic docs about declarative projects"],["AA",null],["LW755CJKCIPO7NR7D5TP5WZNGCP5UWLBMA7KJXMHJEB6XIJJGO3QC","doc: Write \"Adding More Jobs\"."],["6A6CZ7SC2VGEGRC5LSNTDDM3LFWVYO6Z6QNDF74SBJWO5P6T3ARQC","draft manual"],["PKE6I67S7TDGKEFCKIQZOZ5PSDZXCSPOQGSKDAE5NST3NOOLRUXAC","doc: Import the \"Creating Projects\" chapter by Visser & Dolstra."]],"deps":["LW755CJKCIPO7NR7D5TP5WZNGCP5UWLBMA7KJXMHJEB6XIJJGO3QC"],"known":[]},"hunks":[{"FileAdd":{"meta":{"basename":"declarative-projects.xml","metadata":0},"context":[{"change":4,"pos":18}],"contents":[{"Add":{"text":"

","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:144"}},{"Add":{"text":"","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:145"}},{"Add":{"text":" Declarative projects","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:183"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:192"}},{"Add":{"text":" Hydra also supports declarative projects, where jobsets are generated","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:266"}},{"Add":{"text":" and configured automatically from specification files instead of being","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:341"}},{"Add":{"text":" managed through the UI. A jobset specification is a JSON object","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:409"}},{"Add":{"text":" containing the configuration of the jobset, for example:","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:470"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:480"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:515"}},{"Add":{"text":" {","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:521"}},{"Add":{"text":" \"enabled\": 1,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:543"}},{"Add":{"text":" \"hidden\": false,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:568"}},{"Add":{"text":" \"description\": \"js\",","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:597"}},{"Add":{"text":" \"nixexprinput\": \"src\",","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:628"}},{"Add":{"text":" \"nixexprpath\": \"release.nix\",","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:666"}},{"Add":{"text":" \"checkinterval\": 300,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:696"}},{"Add":{"text":" \"schedulingshares\": 100,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:729"}},{"Add":{"text":" \"enableemail\": false,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:759"}},{"Add":{"text":" \"emailoverride\": \"\",","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:788"}},{"Add":{"text":" \"keepnr\": 3,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:809"}},{"Add":{"text":" \"inputs\": {","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:829"}},{"Add":{"text":" \"src\": { \"type\": \"git\", \"value\": \"git://github.com/shlevy/declarative-hydra-example.git\", \"emailresponsible\": false },","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:960"}},{"Add":{"text":" \"nixpkgs\": { \"type\": \"git\", \"value\": \"git://github.com/NixOS/nixpkgs.git release-16.03\", \"emailresponsible\": false }","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1089"}},{"Add":{"text":" }","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1099"}},{"Add":{"text":" }","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1105"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1125"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1134"}},{"Add":{"text":" To configure a declarative project, take the following steps:","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1200"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1210"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1264"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1279"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1292"}},{"Add":{"text":" Create a jobset repository in the normal way (e.g. a git repo with","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1368"}},{"Add":{"text":" a release.nix file, any other needed helper","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1439"}},{"Add":{"text":" files, and taking any kind of hydra input), but without adding it","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1513"}},{"Add":{"text":" to the UI. The nix expression of this repository should contain a","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1587"}},{"Add":{"text":" single job, named jobsets. The output of the","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1659"}},{"Add":{"text":" jobsets job should be a JSON file containing an","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1734"}},{"Add":{"text":" object of jobset specifications. Each member of the object will","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1806"}},{"Add":{"text":" become a jobset of the project, configured by the corresponding","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1878"}},{"Add":{"text":" jobset specification.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1908"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1922"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1938"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1953"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:1966"}},{"Add":{"text":" In some hydra-fetchable source (potentially, but not necessarily,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2040"}},{"Add":{"text":" the same repo you created in step 1), create a JSON file","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2105"}},{"Add":{"text":" containing a jobset specification that points to the jobset","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2173"}},{"Add":{"text":" repository you created in the first step, specifying any needed","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2245"}},{"Add":{"text":" inputs (e.g. nixpkgs) as necessary.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2290"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2304"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2320"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2335"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2348"}},{"Add":{"text":" In the project creation/edit page, set declarative input type,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2419"}},{"Add":{"text":" declarative input value, and declarative spec file to point to the","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2494"}},{"Add":{"text":" source and JSON file you created in step 2.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2546"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2560"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2576"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2593"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2602"}},{"Add":{"text":" Hydra will create a special jobset named .jobsets,","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2676"}},{"Add":{"text":" which whenever evaluated will go through the steps above in reverse","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2748"}},{"Add":{"text":" order:","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2759"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2769"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2823"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2838"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2851"}},{"Add":{"text":" Hydra will fetch the input specified by the declarative input type","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2926"}},{"Add":{"text":" and value.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2945"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2959"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2975"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:2990"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3003"}},{"Add":{"text":" Hydra will use the configuration given in the declarative spec","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3074"}},{"Add":{"text":" file as the jobset configuration for this evaluation. In addition","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3148"}},{"Add":{"text":" to any inputs specified in the spec file, hydra will also pass the","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3223"}},{"Add":{"text":" declInput argument corresponding to the input","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3296"}},{"Add":{"text":" fetched in step 1.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3323"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3337"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3353"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3368"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3381"}},{"Add":{"text":" As normal, hydra will build the jobs specified in the jobset","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3450"}},{"Add":{"text":" repository, which in this case is the single","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3503"}},{"Add":{"text":" jobsets job. When that job completes, hydra","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3574"}},{"Add":{"text":" will read the created jobset specifications and create","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3637"}},{"Add":{"text":" corresponding jobsets in the project, disabling any jobsets that","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3710"}},{"Add":{"text":" used to exist but are not present in the current spec.","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3773"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3787"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3803"}},{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3820"}},{"Add":{"text":"

","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3831"}}]}},{"Edit":{"inode":{"change":5,"pos":114},"path":"doc/manual/projects.xml","line":3,"atom":{"NewVertex":{"up_context":[{"change":5,"pos":214}],"down_context":[{"change":5,"pos":214}],"flag":"BLOCK","start":3882,"end":3934,"inode":{"change":5,"pos":114}}},"contents":[{"Add":{"text":" xmlns:xi=\"http://www.w3.org/2001/XInclude\"","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3933"}}]}},{"Edit":{"inode":{"change":5,"pos":114},"path":"doc/manual/projects.xml","line":472,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":3342}],"down_context":[{"change":2,"pos":3342}],"flag":"BLOCK","start":3935,"end":3984,"inode":{"change":5,"pos":114}}},"contents":[{"Add":{"text":" ","pos":"VDT6CUITZL2M3DSFHKAD7VYSW354AU4GDMJ7PWTFLTPUCFKTJSZAC:3983"}}]}}],"owner":"grahamc","repo":"hydra","token":"/+ysVGY+F52Jw4ks32Z1K/Xfc8Y2aIOXRlW1150Fm+4=","login":null}

…

Dependencies

Change contents

Review