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 image
60 Control and manipulate the images (see OPTIONS) for more de‐
61 tails.
62
64 -h, --help
65 Shows the help message and exits.
66 -c CONNECTION, --connection CONNECTION
68 Provide the URL of a remote libvirt instance to be used instead
69 of the local one. This option can be used with the instance command
70 only.
71
74 create
75 Create a new instance. See the INSTANCE CREATE OPTIONS section
76 for more details.
77 list
79 List available running instances and images. Use the --all op‐
80 tions to list all instances.
81 start
83 Start an existing instance.
84 stop
86 Stop a running instance.
87 reboot
89 Force the instance to reboot.
90 remove
92 Remove an instance or image. If an instance is running, it can‐
93 not be removed without the -f option.
94 destroy
96 Remove an instance or image. Deprecated, do not use.
97 clean
99 Remove non-existing or unsynced libvirt VMs from testcloud.
100
103 URL
104 Specify the URL from where testcloud should download the in‐
105 stance qcow2 image or distro:version handle. This option is compulsory.
106 Some examples of supported short urls:
107 - fedora:rawhide (latest compose), fedora:33, fedora:latest
108 (latest Fedora GA image)
109 - fedora-coreos:next, fedora-coreos:testing, fedora-coreos:sta‐
110 ble
111 - fedora:qa-matrix (image from https://fedorapro‐
112 ject.org/wiki/Test_Results:Current_Cloud_Test )
113 - centos:XX (eg. centos:8, centos:latest)
114 - centos-stream:XX (eg. centos-stream:8, centos-stream:latest)
115 - ubuntu:release_name (eg. ubuntu:focal, ubuntu:latest)
116 - debian:release_name/release_number (eg. debian:11, de‐
117 bian:sid, debian:latest)
118 -n, --name NAME
120 Set desired instance name. A nice and memorable name will be
121 generated for you if not specified.
122 --arch ARCH
124 Set the desired guest architecture. Host arch is the default,
125 supported are: x86_64, aarch64, ppc64le, and s390x.
126 --ram RAM
128 Set the amount of RAM that will be available to the instance's
129 VM (in MiB).
130 --vcpus VCPUS
132 Set the number of virtual CPU cores to be assinged to the VM.
133 --disksize DISKSIZE
135 Set the disk size of the instance VM (in GiB).
136 --vnc
138 Open a VNC connection to the :1 display of the instance VM.
139 --no-graphic
141 Turn off the instance VM's graphical display.
142 --timeout TIMEOUT
144 Specify the time (in seconds) to wait for the instance boot to
145 complete. To disable waiting time (default behaviour) set to 0.
146 --disk_number
148 : To provide disk number you want
149 ADDITIONAL COREOS OPTIONS
151 --bu_file BU_FILE
153 : To provide a bu_file you want to use
154 --ign_file IGN_FILE
156 : To provide an ign_file you want to use
157 --ssh_path
159 : To provide a ssh pubkey path you want to use
160
163 Create a new instance:
164 testcloud create <URL>
166 List all available instances:
168 testcloud list
170 Start an existing instance:
172 testcloud start <instance_name>
174 Stop an existing instance:
176 testcloud stop <instance_name>
178 Remove a running instance:
180 testcloud remove -f <instance_name>
182
185 testcloud's help and the Project's README.md file
186
189 No known bugs. If you have found a bug, please report it at
190 https://bugzilla.redhat.com.
191
193 Mike Ruckman (roshi@fedoraproject.org)
1941.0 11 Nov 2020 TESTCLOUD(1)