1TESTCLOUD(1) testcloud man page TESTCLOUD(1)
2
6 testcloud - download qcow2 cloud images and boot them locally.
7
9 testcloud [-h, --help] [COMMAND]... [OPTION]... [SUBCOMMAND]... [OP‐
10 TION]...
11
13 testcloud is a small helper script to download and boot cloud/coreos
14 images locally. Testcloud supports wide range of distributions, namely
15 Fedora, Fedora CoreOS, CentOS, CentOS Stream, Red Hat Enterprise Linux,
16 Debian and Ubuntu.
17 testcloud can run either in system mode or in constrained user session
19 mode, which is usefull for running it eg. in unprivileged containers.
20 To run testcloud, you need to provide the URL of a cloud image or
22 string in distribution:version format to the script which will be used
23 for booting.
24 If you do not have an image location of your own, you can use one of
26 the images from the Fedora Cloud download pages at https://alt.fedo‐
27 raproject.org/cloud/.
28 Then, testcloud will download the image and save it in the
30 /var/lib/testcloud/backingstores/. It will use this image to create a
31 backing store for a newly created instance which will be placed in
32 /var/tmp/instances/. When the same image has been previously down‐
33 loaded, testcloud will NOT download it again and it will use the cur‐
34 rent image to create the instance.
35 When the new instance is created, testcloud will show its IP address
37 that you can use to access the running instance via ssh. The login name
38 is fedora and the password is passw0rd. The IP address of an instance
39 is shown when you list the instance (see COMMANDS).
40 The instance can also be manipulated and controlled with virt-manager.
42
44 The default configuration should work for many people. However, if you
45 need to override the default settings, you can do it in the settings.py
46 file. The example file in conf/settings-example.py shows the available
47 configuration values which you can alter to suit your needs.
48 The configuration file must be placed in one of the following locations
50 in order to be recognized.
51 conf/settings.py in the git checkout
53 ~/.config/testcloud/settings.py
55 /etc/testcloud/settings.py
57
59 instance
60 Control and manipulate the instances (see OPTIONS) for more de‐
61 tails.
62 image
64 Control and manipulate the images (see OPTIONS) for more de‐
65 tails.
66
68 -h, --help
69 Shows the help message and exits.
70 -c CONNECTION, --connection CONNECTION
72 Provide the URL of a remote libvirt instance to be used instead
73 of the local one. This option can be used with the instance command
74 only.
75
78 create
79 Create a new instance. See the INSTANCE CREATE OPTIONS section
80 for more details.
81 list
83 List available running instances and images. Use the --all op‐
84 tions to list all instances.
85 start
87 Start an existing instance.
88 stop
90 Stop a running instance.
91 reboot
93 Force the instance to reboot.
94 remove
96 Remove an instance or image. If an instance is running, it can‐
97 not be removed without the -f option.
98 destroy
100 Remove an instance or image. Deprecated, do not use.
101 clean
103 Remove non-existing or unsynced libvirt VMs from testcloud.
104
107 URL
108 Specify the URL from where testcloud should download the in‐
109 stance qcow2 image or distro:version handle. This option is compulsory.
110 Some examples of supported short urls:
111 - fedora:rawhide (latest compose), fedora:33, fedora:latest
112 (latest Fedora GA image)
113 - fedora:qa-matrix (image from https://fedorapro‐
114 ject.org/wiki/Test_Results:Current_Cloud_Test )
115 - centos:XX (eg. centos:8, centos:latest)
116 - centos-stream:XX (eg. centos-stream:8, centos-stream:latest)
117 - ubuntu:release_name (eg. ubuntu:focal, ubuntu:latest)
118 - debian:release_name/release_number (eg. debian:11, de‐
119 bian:sid, debian:latest)
120 -n, --name NAME
122 Set desired instance name. A nice and memorable name will be
123 generated for you if not specified.
124 --ram RAM
126 Set the amount of RAM that will be available to the instance's
127 VM (in MiB).
128 --vcpus VCPUS
130 Set the number of virtual CPU cores to be assinged to the VM.
131 --disksize DISKSIZE
133 Set the disk size of the instance VM (in GiB).
134 --vnc
136 Open a VNC connection to the :1 display of the instance VM.
137 --no-graphic
139 Turn off the instance VM's graphical display.
140 --timeout TIMEOUT
142 Specify the time (in seconds) to wait for the instance boot to
143 complete. To disable waiting time (default behaviour) set to 0.
144
147 Create a new instance:
148 testcloud instance create <URL>
150 List all available instances:
152 testcloud instance list
154 Start an existing instance:
156 testcloud instance start <instance_name>
158 Stop an existing instance:
160 testcloud instance stop <instance_name>
162 Remove a running instance:
164 testcloud instance remove -f <instance_name>
166
169 testcloud's help and the Project's README.md file
170
173 No known bugs. If you have found a bug, please report it at
174 https://bugzilla.redhat.com.
175
177 Mike Ruckman (roshi@fedoraproject.org)
1781.0 11 Nov 2020 TESTCLOUD(1)