diff options
author | Bruce Ashfield <bruce.ashfield@gmail.com> | 2023-11-03 17:23:20 +0000 |
---|---|---|
committer | Bruce Ashfield <bruce.ashfield@gmail.com> | 2023-11-06 16:21:12 +0000 |
commit | f7bffb351c59cc972d9141ac2ab5ee2c40e19547 (patch) | |
tree | da6d847cf4407cefcdb9e548684e322a2da0bad4 /README | |
parent | 115f6367f37095415f289fb6981cda9608ac72ff (diff) | |
download | meta-virtualization-f7bffb351c59cc972d9141ac2ab5ee2c40e19547.tar.gz |
docs: add SECURITY.md and rename README.md
To be compliant with the recent yocto project security
processes, add a SECURITY.md file that explains what to
do if an issue is detected.
This also renames README to README.md to be similar to
other layers.
Signed-off-by: Bruce Ashfield <bruce.ashfield@gmail.com>
Diffstat (limited to 'README')
-rw-r--r-- | README | 100 |
1 files changed, 0 insertions, 100 deletions
diff --git a/README b/README deleted file mode 100644 index 7a848bb6..00000000 --- a/README +++ /dev/null | |||
@@ -1,100 +0,0 @@ | |||
1 | meta-virtualization | ||
2 | =================== | ||
3 | |||
4 | This layer provides support for building Xen, KVM, Libvirt, and associated | ||
5 | packages necessary for constructing OE-based virtualized solutions. | ||
6 | |||
7 | The bbappend files for some recipes (e.g. linux-yocto) in this layer need to | ||
8 | have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add | ||
9 | in configuration file the following line. | ||
10 | |||
11 | DISTRO_FEATURES:append = " virtualization" | ||
12 | |||
13 | If meta-virtualization is included, but virtualization is not enabled as a | ||
14 | distro feature a warning is printed at parse time: | ||
15 | |||
16 | You have included the meta-virtualization layer, but | ||
17 | 'virtualization' has not been enabled in your DISTRO_FEATURES. Some bbappend files | ||
18 | may not take effect. See the meta-virtualization README for details on enabling | ||
19 | virtualization support. | ||
20 | |||
21 | If you know what you are doing, this warning can be disabled by setting the following | ||
22 | variable in your configuration: | ||
23 | |||
24 | SKIP_META_VIRT_SANITY_CHECK = 1 | ||
25 | |||
26 | Depending on your use case, there are other distro features in meta-virtualization | ||
27 | that may also be enabled: | ||
28 | |||
29 | - xen: enables xen functionality in various packages (kernel, libvirt, etc) | ||
30 | - kvm: enables KVM configurations in the kernel and autoloads modules | ||
31 | - k8s: enables kubernets configurations in the kernel, tools and configuration | ||
32 | - aufs: enables aufs support in docker and linux-yocto | ||
33 | - x11: enable xen and libvirt functionality related to x11 | ||
34 | - selinux: enables functionality in libvirt and lxc | ||
35 | - systemd: enable systemd services and unit files (for recipes for support) | ||
36 | - sysvinit: enable sysvinit scripts (for recipes with support) | ||
37 | - seccomp: enable seccomp support for packages that have the capability. | ||
38 | |||
39 | Dependencies | ||
40 | ------------ | ||
41 | This layer depends on: | ||
42 | |||
43 | URI: git://github.com/openembedded/openembedded-core.git | ||
44 | branch: master | ||
45 | revision: HEAD | ||
46 | prio: default | ||
47 | |||
48 | URI: git://github.com/openembedded/meta-openembedded.git | ||
49 | branch: master | ||
50 | revision: HEAD | ||
51 | layers: meta-oe | ||
52 | meta-networking | ||
53 | meta-filesystems | ||
54 | meta-python | ||
55 | |||
56 | BBFILE_PRIORITY_openembedded-layer = "4" | ||
57 | |||
58 | Required for Xen XSM policy: | ||
59 | URI: git://git.yoctoproject.org/meta-selinux | ||
60 | branch: master | ||
61 | revision: HEAD | ||
62 | prio: default | ||
63 | |||
64 | Required for Ceph: | ||
65 | URI: git://git.yoctoproject.org/meta-cloud-services | ||
66 | branch: master | ||
67 | revision: HEAD | ||
68 | prio: default | ||
69 | |||
70 | Required for cri-o: | ||
71 | URI: git://git.yoctoproject.org/meta-selinux | ||
72 | branch: master | ||
73 | revision: HEAD | ||
74 | prio: default | ||
75 | |||
76 | Community / Colaboration | ||
77 | ------------------------ | ||
78 | |||
79 | Repository: https://git.yoctoproject.org/cgit/cgit.cgi/meta-virtualization/ | ||
80 | Mailing list: https://lists.yoctoproject.org/g/meta-virtualization | ||
81 | IRC: libera.chat #meta-virt channel | ||
82 | |||
83 | Maintenance | ||
84 | ----------- | ||
85 | |||
86 | Send pull requests, patches, comments or questions to meta-virtualization@lists.yoctoproject.org | ||
87 | |||
88 | Maintainer: Bruce Ashfield <bruce.ashfield@gmail.com> | ||
89 | see MAINTAINERS for more specific information | ||
90 | |||
91 | When sending single patches, please using something like: | ||
92 | $ git send-email -1 -M --to meta-virtualization@lists.yoctoproject.org --subject-prefix='meta-virtualization][PATCH' | ||
93 | |||
94 | License | ||
95 | ------- | ||
96 | |||
97 | All metadata is MIT licensed unless otherwise stated. Source code included | ||
98 | in tree for individual recipes is under the LICENSE stated in each recipe | ||
99 | (.bb file) unless otherwise stated. | ||
100 | |||