particle-os/particle-os-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: Remove unused files module

Browse source
This commit is contained in:
Gerald Pinder 2024-04-05 16:43:49 -04:00
parent 05980ee82d
commit 0f76b16369
4 changed files with 1 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

15
template/templates/modules/files/README.md
View file

@ -1,15 +0,0 @@
# `files`
The `files` module simplifies the process of copying files to the image during the build time. These files are sourced from the `config/files` directory, which is located at `/tmp/config/files` inside the image.
:::note
If you want to place any files in `/etc/`, you should place them in `/usr/etc/` instead, which will be used to generate `/etc/` on a booted system. That is the proper directory for "system" configuration templates on atomic Fedora distros, whereas `/etc/` is meant for manual overrides and editing by the machine's admin AFTER installation! See issue https://github.com/blue-build/legacy-template/issues/28.
:::
## Implementation differences between the legacy template and compiler-based builds
When using a compiler-based build (which is the recommended option for all users, so if you don't know what you're using you're probably using that), each instruction under `files:` creates its on layer in the final image using the `Containerfile` `COPY`-command. This module is entirely part of the recipe compiler.
When using a legacy template, all modules are combined into one layer in the final image. With a repo based on the legacy template, the bash version is used.
The API for both of these options remains exactly the same.

5
template/templates/modules/files/files.j2
View file

@ -1,5 +0,0 @@
{%- if let Some(files) = module.get_files_list() %}
{%- for (src, dest) in files %}
COPY {{ src }} {{ dest }}
{%- endfor %}
{%- endif %}

9
template/templates/modules/files/module.yml
View file

@ -1,9 +0,0 @@
name: files
shortdesc: The files module simplifies the process of copying files to the image during build time.
readme: https://raw.githubusercontent.com/blue-build/cli/main/template/templates/modules/files/README.md
example: |
type: files
files:
- usr: /usr
# usr: file/folder inside config/files/ to copy (config/files/usr/ in the repository)
# /usr: destination on the final system