[{"_1":2,"_170":-5,"_171":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_147":148},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_95":-5,"_96":97,"_136":-5,"_137":11,"_138":21,"_139":11,"_140":-5,"_141":11,"_142":-5,"_143":144,"_145":98,"_146":-7},"canonicalUrl","https://hub.docker.com/r/xanimo/chisel/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","xanimo","reponame","chisel","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_50":51,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":63,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":81,"_86":11,"_87":88,"_92":33,"_93":94},"categories",[42,47],{"_43":44,"_45":46},"name","Security","slug","security",{"_43":48,"_45":49},"Operating systems","operating-systems","content_types",[52],"image","date_registered","2024-06-14T06:01:30.10372Z","description","Chisel is a software tool for carving and cutting Debian packages!","is_private","last_updated","2024-06-14T06:01:30.168136Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[64],"application/vnd.docker.container.image.v1+json","pull_count",941,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Chisel\n\n**Chisel** is a software tool for carving and cutting Debian packages!\n\nIt is built on the idea of **package slices** - minimal, complimentary and\nloosely coupled sets of files, based on the package’s metadata and content.\nSlices are basically subsets of the Debian packages, with their own content and\nset of dependencies to other internal and external slices.\n\n\n\n![pkg-slices](docs/_static/package-slices.svg)\n\n---\n![a-slice-of-ubuntu](docs/_static/slice-of-ubuntu.png)\n\n\n\nThis image depicts a simple case, where both packages A and B are deconstructed\ninto multiple slices. At a package level, B depends on A, but in reality, there\nmight be files in A that B doesn’t actually need (eg. A_slice3 isn’t needed for\nB to function properly). With this slice definition in place, Chisel is able to\nextract a highly-customized and specialized Slice of the Ubuntu distribution,\nwhich one could see as a block of stone from which we can carve and extract\nsmall and relevant parts we need to run our applications. It is ideal to\nsupport the creation of smaller but equally functional container images.\n\n> “The sculpture is already complete within the marble block, before I start my\n> work. It is already there, I just have to chisel away the superfluous\n> material.”\n>\n> \\- Michelangelo\n\nIn the end, it’s like having a slice of Ubuntu - get *just what you need*. You\n*can have your cake and eat it too*!\n\n## Using Chisel\n\nTo install the latest version of Chisel, run the following command:\n\n```bash\ngo install github.com/canonical/chisel/cmd/chisel@latest\n```\n\nChisel is invoked using `chisel `. To get more information:\n\n - To see a help summary, type `chisel -h`.\n - To see a short description of all commands, type `chisel help --all`.\n - To see details for one command, type `chisel help ` or\n`chisel -h`.\n\n### Example command\n\nChisel relies on a [database of slices](https://github.com/canonical/chisel-releases) that are indexed per Ubuntu release.\n\n```bash\nchisel cut --release ubuntu-22.04 --root myrootfs/ libgcc-s1_libs libssl3_libs\n```\n\nIn this example, Chisel would look into the Ubuntu Jammy archives, fetch the\nprovided packages and install only the desired slices into the *myrootfs*\nfolder, according to the slice definitions available in the\n[\"ubuntu-22.04\" chisel-releases branch]().\n\n## Reference\n\n### Chisel releases\n\nAs mentioned above, Chisel relies on **package slices**. These slices need to\nbe defined prior to the execution of the `chisel` command.\n\nBy default, Chisel will look into its central [chisel-releases](https://github.com/canonical/chisel-releases)\ndatabase, where package slices are defined and indexed by Ubuntu release. A\nrelease is identified by the branch name. For example:\n\n```bash\nchisel cut --release ubuntu-22.10 ...\n```\n\nwill tell Chisel to look for a `chisel.yaml` file in the \"ubuntu-22.10\" branch\nof the [chisel-releases](https://github.com/canonical/chisel-releases)\nrepository. This file will in turn instruct Chisel to fetch the requested\npackage slices, as defined in the same branch, from the corresponding Kinetic\nrelease in the Ubuntu archives.\n\nAlternatively, one can also point Chisel to a custom and local Chisel release\nby specifying a path instead of a branch name. For example:\n\n```bash\nchisel cut --release release/ ...\n```\n\n#### Chisel release configuration\n\nEach Chisel release must have one \"chisel.yaml\" file.\n\n*chisel.yaml*:\n\n```yaml\nformat: \n\narchives:\n ubuntu:\n # Ubuntu archive for Chisel to look into\n version: \n\n # categories/components of the Ubuntu archive to look into\n components: [, ...]\n\n # pockets/suites of the Ubuntu archive to look into\n suites: [, ...]\n```\n\nExample:\n\n```yaml\nformat: v1\n\narchives:\n ubuntu:\n version: 22.04\n components: [main, universe]\n suites: [jammy, jammy-security, jammy-updates]\n public-keys: [ubuntu-archive-key-2018]\n\npublic-keys:\n # Ubuntu Archive Automatic Signing Key (2018) \n # rsa4096/f6ecb3762474eda9d21b7022871920d1991bc93c 2018-09-17T15:01:46Z\n ubuntu-archive-key-2018:\n id: \"871920D1991BC93C\"\n armor: |\n -----BEGIN PGP PUBLIC KEY BLOCK-----\n\n mQINBFufwdoBEADv/Gxytx/LcSXYuM0MwKojbBye81s0G1nEx+lz6VAUpIUZnbkq\n dXBHC+dwrGS/CeeLuAjPRLU8AoxE/jjvZVp8xFGEWHYdklqXGZ/gJfP5d3fIUBtZ\n HZEJl8B8m9pMHf/AQQdsC+YzizSG5t5Mhnotw044LXtdEEkx2t6Jz0OGrh+5Ioxq\n X7pZiq6Cv19BohaUioKMdp7ES6RYfN7ol6HSLFlrMXtVfh/ijpN9j3ZhVGVeRC8k\n KHQsJ5PkIbmvxBiUh7SJmfZUx0IQhNMaDHXfdZAGNtnhzzNReb1FqNLSVkrS/Pns\n AQzMhG1BDm2VOSF64jebKXffFqM5LXRQTeqTLsjUbbrqR6s/GCO8UF7jfUj6I7ta\n LygmsHO/JD4jpKRC0gbpUBfaiJyLvuepx3kWoqL3sN0LhlMI80+fA7GTvoOx4tpq\n VlzlE6TajYu+jfW3QpOFS5ewEMdL26hzxsZg/geZvTbArcP+OsJKRmhv4kNo6Ayd\n yHQ/3ZV/f3X9mT3/SPLbJaumkgp3Yzd6t5PeBu+ZQk/mN5WNNuaihNEV7llb1Zhv\n Y0Fxu9BVd/BNl0rzuxp3rIinB2TX2SCg7wE5xXkwXuQ/2eTDE0v0HlGntkuZjGow\n DZkxHZQSxZVOzdZCRVaX/WEFLpKa2AQpw5RJrQ4oZ/OfifXyJzP27o03wQARAQAB\n tEJVYnVudHUgQXJjaGl2ZSBBdXRvbWF0aWMgU2lnbmluZyBLZXkgKDIwMTgpIDxm\n dHBtYXN0ZXJAdWJ1bnR1LmNvbT6JAjgEEwEKACIFAlufwdoCGwMGCwkIBwMCBhUI\n AgkKCwQWAgMBAh4BAheAAAoJEIcZINGZG8k8LHMQAKS2cnxz/5WaoCOWArf5g6UH\n beOCgc5DBm0hCuFDZWWv427aGei3CPuLw0DGLCXZdyc5dqE8mvjMlOmmAKKlj1uG\n g3TYCbQWjWPeMnBPZbkFgkZoXJ7/6CB7bWRht1sHzpt1LTZ+SYDwOwJ68QRp7DRa\n Zl9Y6QiUbeuhq2DUcTofVbBxbhrckN4ZteLvm+/nG9m/ciopc66LwRdkxqfJ32Cy\n q+1TS5VaIJDG7DWziG+Kbu6qCDM4QNlg3LH7p14CrRxAbc4lvohRgsV4eQqsIcdF\n kuVY5HPPj2K8TqpY6STe8Gh0aprG1RV8ZKay3KSMpnyV1fAKn4fM9byiLzQAovC0\n LZ9MMMsrAS/45AvC3IEKSShjLFn1X1dRCiO6/7jmZEoZtAp53hkf8SMBsi78hVNr\n BumZwfIdBA1v22+LY4xQK8q4XCoRcA9G+pvzU9YVW7cRnDZZGl0uwOw7z9PkQBF5\n KFKjWDz4fCk+K6+YtGpovGKekGBb8I7EA6UpvPgqA/QdI0t1IBP0N06RQcs1fUaA\n QEtz6DGy5zkRhR4pGSZn+dFET7PdAjEK84y7BdY4t+U1jcSIvBj0F2B7LwRL7xGp\n SpIKi/ekAXLs117bvFHaCvmUYN7JVp1GMmVFxhIdx6CFm3fxG8QjNb5tere/YqK+\n uOgcXny1UlwtCUzlrSaP\n =9AdM\n -----END PGP PUBLIC KEY BLOCK-----\n```\n\n#### Slice definitions\n\nThere can be only **one slice definitions file** for each Ubuntu package, per\nChisel release. All of the slice definitions files must be placed under a\n\"slices\" folder, and follow the same structure. For example:\n\n*slices/B.yaml*:\n\n```yaml\n# (req) Name of the package.\n# The slice definition file should be named accordingly (eg. \"openssl.yaml\")\n\npackage: B\n\n# (req) List of slices\nslices:\n\n # (req) Name of the slice\n slice2:\n\n # (opt) Optional list of slices that this slice depends on\n essential:\n - A_slice1\n\n # (req) The list of files, from the package, that this slice will install\n contents:\n /path/to/content:\n /path/to/another/multiple*/content/**:\n /path/to/moved/content: {copy: /bin/original}\n /path/to/link: {symlink: /bin/mybin}\n /path/to/new/dir: {make: true}\n /path/to/file/with/text: {text: \"Some text\"}\n /path/to/mutable/file/with/default/text: {text: FIXME, mutable: true}\n /path/to/temporary/content: {until: mutate}\n\n # (opt) Mutation scripts, to allow for the reproduction of maintainer scripts,\n # based on Starlark (https://github.com/google/starlark-go)\n mutate: |\n foo = content.read(\"/path/to/temporary/content\")\n content.write(\"/path/to/mutable/file/with/default/text\", foo)\n```\n\nExample:\n\n```yaml\npackage: mypkg\n\nslices:\n bins:\n essential:\n - mypkg_config\n\n contents:\n /bin/mybin:\n /bin/moved: {copy: /bin/original}\n /bin/linked: {symlink: /bin/mybin}\n\n config:\n contents:\n /etc/mypkg.conf: {text: \"The configuration.\"}\n /etc/mypkg.d/: {make: true}\n```\n\nTo find more examples of real slice definitions files (and contribute your own),\nplease go to .\n\n##### Path kinds\n\nAs depicted in the example above, the paths listed under a slice's contents can\nhave additional information for identifying the kind of content to expect:\n\n - **make**: a `true` or `false` boolean value to specify whether the path must\n be created or not. Example: `/etc/mypkg.d/: {make: true}` instructs Chisel to\n create the directory \"/etc/mypkg.d/\" (with parent directories). NOTE: the\n provided path must end with \"/\" for `make` to be valid.\n - **mode**: a 32-bit unsigned integer representing the path mode. Example:\n `/etc/dir/sub/: {make: true, mode: 01777}` instructs Chisel to create the\n directory \"/etc/dir/sub/\" with mode \"01777\".\n - **copy**: a string referring to the original path of the content being\n copied. Example: `/bin/moved: {copy: /bin/original}` instructs Chisel to copy\n the package's \"/bin/original\" file onto \"/bin/moved\".\n - **text**: a sequence of characters to be written to the provided file path.\n Example: `/tmp/file1: {text: data1}` will instruct Chisel to write \"data1\"\n into the file \"/tmp/file1\".\n - **symlink**: a string referring to the original path (source) of the content\n being linked. Example: `/bin/linked: {symlink: /bin/mybin}` will instruct\n Chisel to create the symlink \"/bin/linked\", which points to an existing file\n \"/bin/mybin\".\n - **mutable**: a `true` or `false` boolean value to specify whether the content\n is mutable, i.e. it can be changed after being extracted from the deb. Example:\n `/tmp/file1: {text: data1, mutable: true}` instructs Chisel to populate\n \"/tmp/file1\" with \"data1\", while also letting Chisel know that this file's\n content can be mutated via a mutation script.\n - **until**: accepts a `mutate` value to say that the specified content\n shall be removed by Chisel after the mutation scripts are executed. Example:\n `/tmp/file1: {text: data1, until: mutate}` instructs Chisel to populate the\n file \"/tmp/file1\" with \"data1\" at installation time, but to then remove it\n right after the slice's mutation scripts are executed. NOTE: while this\n option can be combined with globs (eg. `/tmp/file*: {until: mutate}`), it\n cannot be used to remove non-empty directories.\n - **arch**: accepts a list of known architectures for identifying contents\n which are only available for certain architectures. Example:\n `/usr/bin/hello: {arch: amd64}` will instruct Chisel to extract and install\n the \"/usr/bin/hello\" file only when chiselling an amd64 filesystem.\n\n## TODO\n\n- [ ] Preserve ownerships when possible\n- [ ] GPG signature checking for archives\n- [ ] Use a fake server for the archive tests\n- [ ] Functional tests\n\n\n## FAQ\n\n#### May I use arbitrary package names?\n\nNo, package names must reflect the package names in the archive,\nso that there's a single namespace to remember and respect.\n\n#### I've tried to use a different Ubuntu version and it failed?\n\nThe mapping is manual for now. Let us know and we'll fix it.\n\n#### Can I use multiple repositories in a Chisel release?\n\nNot at the moment, but maybe eventually.\n\n#### Can I use non-Ubuntu repositories?\n\nNot at the moment, but eventually.\n\n#### Can multiple slices refer to the same path?\n\nYes, but see below.\n\n#### Can multiple slices _output_ the same path?\n\nYes, as long as either both slices are part of the same package,\nor the path is not extracted from a package at all (not copied)\nand the explicit inline definitions match exactly.\n\n#### Is file ownership preserved?\n\nNot right now, but it will be supported.\n","has_starred","hub_user","immutable_tags_settings",{"_82":11,"_83":84},"enabled","rules",[85],".*","is_automated","permissions",{"_89":21,"_90":11,"_91":11},"read","write","admin","user","storage_size",8482416,"orgData","recentTags",[98],{"_99":52,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_58":125,"_126":101,"_127":33,"_128":64,"_43":129,"_130":131,"_132":116,"_133":125,"_134":73,"_135":21},"content_type","creator",2233838,"digest","sha256:a941149b4e51c52562e09e774cee55a06b3f2cce8d6f8e858eb56d23f2210b16","full_size",8480665,"id",696931552,"images",[110],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},"architecture","amd64","features","","last_pulled","2026-10-03T12:32:25.059522973Z","last_pushed","2024-06-14T06:01:30Z","os","linux","os_features","os_version","size","variant","2024-06-14T06:01:29.277574Z","last_updater","last_updater_username","media_type","latest","repository",24367747,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":149,"_158":159,"_143":168,"_169":11},{"_40":150,"_50":153,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":154,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":155,"_86":11,"_87":157,"_92":33,"_93":94},[151,152],{"_43":44,"_45":46},{"_43":48,"_45":49},[52],[64],{"_82":11,"_83":156},[85],{"_89":21,"_90":11,"_91":11},"tags",{"_160":71,"_161":-5,"_162":-5,"_163":164},"count","next","previous","results",[165],{"_99":52,"_100":101,"_102":103,"_104":105,"_106":107,"_108":166,"_58":125,"_126":101,"_127":33,"_128":64,"_43":129,"_130":131,"_132":116,"_133":125,"_134":73,"_135":21},[167],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},[],"canDeleteTags","actionData","errors"]

xanimo/chisel

Tags for xanimo/chisel