summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorBruce Ashfield <bruce.ashfield@gmail.com>2023-11-03 17:23:20 +0000
committerBruce Ashfield <bruce.ashfield@gmail.com>2023-11-06 16:21:12 +0000
commitf7bffb351c59cc972d9141ac2ab5ee2c40e19547 (patch)
treeda6d847cf4407cefcdb9e548684e322a2da0bad4 /README
parent115f6367f37095415f289fb6981cda9608ac72ff (diff)
downloadmeta-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--README100
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 @@
1meta-virtualization
2===================
3
4This layer provides support for building Xen, KVM, Libvirt, and associated
5packages necessary for constructing OE-based virtualized solutions.
6
7The bbappend files for some recipes (e.g. linux-yocto) in this layer need to
8have 'virtualization' in DISTRO_FEATURES to have effect. To enable them, add
9in configuration file the following line.
10
11 DISTRO_FEATURES:append = " virtualization"
12
13If meta-virtualization is included, but virtualization is not enabled as a
14distro 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
21If you know what you are doing, this warning can be disabled by setting the following
22variable in your configuration:
23
24 SKIP_META_VIRT_SANITY_CHECK = 1
25
26Depending on your use case, there are other distro features in meta-virtualization
27that 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
39Dependencies
40------------
41This layer depends on:
42
43URI: git://github.com/openembedded/openembedded-core.git
44branch: master
45revision: HEAD
46prio: default
47
48URI: git://github.com/openembedded/meta-openembedded.git
49branch: master
50revision: HEAD
51layers: meta-oe
52 meta-networking
53 meta-filesystems
54 meta-python
55
56BBFILE_PRIORITY_openembedded-layer = "4"
57
58Required for Xen XSM policy:
59URI: git://git.yoctoproject.org/meta-selinux
60branch: master
61revision: HEAD
62prio: default
63
64Required for Ceph:
65URI: git://git.yoctoproject.org/meta-cloud-services
66branch: master
67revision: HEAD
68prio: default
69
70Required for cri-o:
71URI: git://git.yoctoproject.org/meta-selinux
72branch: master
73revision: HEAD
74prio: default
75
76Community / Colaboration
77------------------------
78
79Repository: https://git.yoctoproject.org/cgit/cgit.cgi/meta-virtualization/
80Mailing list: https://lists.yoctoproject.org/g/meta-virtualization
81IRC: libera.chat #meta-virt channel
82
83Maintenance
84-----------
85
86Send pull requests, patches, comments or questions to meta-virtualization@lists.yoctoproject.org
87
88Maintainer: Bruce Ashfield <bruce.ashfield@gmail.com>
89see MAINTAINERS for more specific information
90
91When 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
94License
95-------
96
97All metadata is MIT licensed unless otherwise stated. Source code included
98in tree for individual recipes is under the LICENSE stated in each recipe
99(.bb file) unless otherwise stated.
100