aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2024-01-08docs: fix missing file extension in install exampleDaniel P. Berrangé1-1/+1
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2023-09-27docs: vms: Update the VMs documentation on how to get fresh osinfo-dbErik Skultety1-1/+15
Osinfo-db recently added a new CLI option '--nightly' which makes it much easier to get the latest DB on one's host mainly for automation purposes. Even if '--nightly' isn't available with a given version of the `osinfo-db-import` command, users can still benefit from the automated GitLab nightly builds by either downloading the archive manually or even better passing the URL directly to the command osinfo import command. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-08-31ansible: Bump the minimum Ansible version to 2.10+Erik Skultety1-1/+7
It's getting harder to get around with only the builtin modules and we'll need to use some of the curated community modules. The split of Ansible into 'ansible-core' and 'ansible community (aka ansible)' happened in v2.10. The way this patch enforces the version used in by delegating a version check task to localhost, failing if the control node doesn't meet the minimum version. 2.10 is pretty common these days, so essentially only users on Debian-10 would be impacted by this, but then again, installing from PyPI is a simple workaround in that case. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-06-23docs: vms: Document the 'update' Ansible user pre-tasks featureErik Skultety1-0/+34
Now that we have enabled the user pre-tasks feature, document it. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-06-22docs: vms: Document the new template install strategyErik Skultety1-0/+21
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-05-11docs: vms: Update with how to install guests using vendor cloud imagesErik Skultety1-5/+71
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-05-10docs: vms: Document that no configuration file is required anymoreErik Skultety1-5/+8
Also document that the default root password is weak and unless a simple setup is required strongly advocate for changing it. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-05-03containers: change the mode bits of --script argumentAbdulwasiu Apalowo1-6/+2
The file passed to --script argument is made an executable file before mounting it in the container. The documentation is updated so that users don't have to manually perform this change. Signed-off-by: Abdulwasiu Apalowo <abdulwasiuapalowo@gmail.com>
2023-04-28docs: testing: Update contents with toxErik Skultety1-10/+64
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-04-27docs: mappings: Add a section on the preferred mapping naming schemeErik Skultety1-1/+67
Add a section on what the preferred naming scheme for mappings is so that contributors can refer to it when adding new mappings and make it both consistent from now on as well as make everybody's lives easier. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-04-18remove minor version number from OpenSUSE LEAP target namesPaolo Bonzini1-3/+3
Just like Alma Linux only has the "9" version number, only use "15" in the target name for OpenSUSE Leap. The minor version is only needed in the FROM line of the dockerfiles and for the installation URLs. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2023-04-18docs: vms: Drop any mention of the 'build' command usageErik Skultety1-21/+1
The project 'build' support was dropped by previous patches. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-03-31docs: Add docs on packaging the projectErik Skultety1-0/+38
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-03-31docs: Add a section on running lcitool directly from git and rewordErik Skultety1-3/+6
Without a section header, this information could be easily overlooked, so put it in a dedicated section. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-03-31docs: installation: Update information on how to install the packageErik Skultety1-8/+27
We recently switched from plain setup.py setup to be fully compatible with PEP 517 relying solely on pyproject.toml (with setup.py reserved for legacy reasons). Installation is now only possible with pip, so our docs need an update. Fixes: https://gitlab.com/libvirt/libvirt-ci/-/issues/20 Signed-off-by: Erik Skultety <eskultet@redhat.com>
2023-02-10targets: support overriding target factsPaolo Bonzini1-0/+1
Allow overriding target facts in a project. This is useful to specify the paths to a specific version of Python. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2023-02-10packages: support overriding package mappingsPaolo Bonzini1-0/+11
Allow specifying individual projects to override the version they require of a required version of a PyPI or CPAN package. Projects that want to test with an old version of Meson could therefore disable the distro version and install the old version directly from PyPI. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2023-01-10docs: documentation for containersAbdulwasiu Apalowo1-0/+272
Extensive documentation on the container functionality of lcitool. Signed-off-by: Abdulwasiu Apalowo <abdulwasiuapalowo@gmail.com>
2023-01-06inventory: add testcasesPaolo Bonzini1-0/+2
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2022-09-22lcitool: move ansible/vars/ to facts/Paolo Bonzini2-4/+4
The ansible/vars/ directory is not passed directly to Ansible, it is passed in the group variables after processing in Python. Furthermore, it is also used to generate Dockerfiles which does not involve Ansible. Move it to another name which matches the name of the variables. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2022-09-22lcitool: move ansible/group_vars/ to facts/targets/Paolo Bonzini1-1/+1
The ansible/group_vars/ directory is not directly related to what is passed to Ansible in group variables; those also include packages. Furthermore, it is also used to generate Dockerfiles which does not involve Ansible. Move it to another name which matches the name of the variables in the code. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2022-07-22docs: update FreeBSD disk resizing for auto-partition growthDaniel P. Berrangé1-3/+5
FreeBSD notices resized disks and resizes the main partition to match. All that's required is to confirm the schanges wit 'gpart commit'. This was verified with FreeBSD 12.3 Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2022-07-14docs: vms: Rename 'Test use' section to 'Useful tips'Erik Skultety1-2/+2
By renaming the section we can add simply dump more tips to the section, not just 'test' related. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Rename the 'Usage examples' section to 'More VM examples'Erik Skultety1-2/+4
Originally the section name made sense, but since we moved the much of the original README's content to docs/vms.rst we could add a more fitting name for the section in the context of VMs. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Drop the first paragraph in the 'Example usage' sectionErik Skultety1-4/+0
The paragraph now doesn't discuss anything that wouldn't be clear from the 'Installation' and 'Updating VMs' sections and so can be safely dropped. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Add a section on guest updatesErik Skultety1-19/+42
We never really documented updates properly. While at it, move the mention of crontab out of 'Configuration' and put it to the new section on updating as it feels a bit off in its current place. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Move the 'Cloud-init' bits right after VM installation stepsErik Skultety1-62/+61
This makes more sense from logical point of view, first we configure lcitool, then we install VMs, then we can start messing with cloud-init and creating templates. All the other information can be pushed towards the end of the document. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Move FreeBSD section under VM installationErik Skultety1-54/+54
This section used to be a standalone section mentioned after other stuff unrelated to VM installation. Therefore, move the section and make it a subsection of the whole VM installation process as it makes more sense. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: vms: Move the Ansible inventory section to ConfigurationErik Skultety1-28/+27
Setting up an inventory for Ansible is still a configuration step. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14README: Move sections about VMs into a standalone RST documentErik Skultety1-0/+323
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14README: Move 'External projects lists' to an individual RST documentErik Skultety1-0/+17
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: testing: Mention to be cautious about using --regenerate-outputErik Skultety1-1/+3
If the proposed changes also include changes to e.g. Dockerfile generator potential regressions could not be caught by the test suite if --regenerate-output is always used. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14README: Move the testing part to a standalone RST documentErik Skultety1-0/+16
Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: platforms: Expand the document to cover mappings as wellErik Skultety1-15/+97
This patch does almost a complete rewrite to the original section in order to be as much as helpful to outside projects interested in consuming lcitool as poosible. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14README: Move 'Adding a new target OS' to a standalone RST documentErik Skultety1-0/+15
The next commit will expand and detail the process of adding both a new OS platform as well as a new package mapping. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: installation: Reword the dependencies sectionErik Skultety1-19/+31
We never mentioned libvirt or QEMU in the VM dependencies although these would be likely pulled in by virt-install. Nevertheless it's worth mentioning explicitly. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14docs: install: Replace system-wide pip installs with virtualenvErik Skultety1-2/+4
Installing system-wide with pip leads to security implications (packages not updated with system package manager) and potentially broken system packages since pip would replace files in the system paths. Therefore, instead of suggesting system-wide installation with pip, suggest usage of virtual environments. Signed-off-by: Erik Skultety <eskultet@redhat.com>
2022-07-14README: Move the installation section to a standalone RST documentErik Skultety1-0/+76
Signed-off-by: Erik Skultety <eskultet@redhat.com>
generated by cgit v1.1 at 2024-08-16 20:59:01 +0000