testcloud(1)

1TESTCLOUD(1)                  testcloud man page                  TESTCLOUD(1)
2
3
4

NAME

6       testcloud - download qcow2 cloud images and boot them locally.
7

SYNOPSIS

9       testcloud   [-h,   --help]   [COMMAND]...  [OPTION]...  [SUBCOMMAND]...
10       [OPTION]...
11

DESCRIPTION

13       testcloud is a small helper script to download and boot cloud images on
14       your  machine  locally.   Currently,  only Fedora qcow2 images are sup‐
15       ported.
16
17       To run testcloud, you need to provide the  URL  of  a  cloud  image  or
18       string  in  fedora:XX format to the script which will be used for boot‐
19       ing.
20
21       If you do not have an image location of your own, you can  use  one  of
22       the  images  from  the Fedora Cloud download pages at https://alt.fedo‐
23       raproject.org/cloud/.
24
25       Then,  testcloud  will  download  the  image  and  save   it   in   the
26       /var/lib/testcloud/backingstores/.   It will use this image to create a
27       backing store for a newly created instance  which  will  be  placed  in
28       /var/tmp/instances/.  When  the  same  image  has been previously down‐
29       loaded, testcloud will NOT download it again and it will use  the  cur‐
30       rent image to create the instance.
31
32       When  the  new  instance is created, testcloud will show its IP address
33       that you can use to access the running instance via ssh. The login name
34       is  fedora  and the password is passw0rd. The IP address of an instance
35       is shown when you list the instance (see COMMANDS).
36
37       The instance can also be manipulated and controlled with virt-manager.
38

CONFIGURATION

40       The default configuration should work for many people. However, if  you
41       need to override the default settings, you can do it in the settings.py
42       file. The example file in conf/settings-example.py shows the  available
43       configuration values which you can alter to suit your needs.
44
45       The configuration file must be placed in one of the following locations
46       in order to be recognized.
47
48              conf/settings.py in the git checkout
49
50              ~/.config/testcloud/settings.py
51
52              /etc/testcloud/settings.py
53

COMMANDS

55       instance
56               Control and manipulate the instances  (see  OPTIONS)  for  more
57       details.
58
59       image
60               Control  and  manipulate  the  images  (see  OPTIONS)  for more
61       details.
62

OPTIONS

64       -h, --help
65               Shows the help message and exits.
66
67       -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
72

SUBCOMMANDS

74       create
75               Create a new instance. See the INSTANCE CREATE OPTIONS  section
76       for more details.
77
78       list
79               List  available  running  instances  and  images. Use the --all
80       options to list all instances.
81
82       start
83               Start an existing instance.
84
85       stop
86               Stop a running instance.
87
88       reboot
89               Force the instance to reboot.
90
91       remove
92               Remove an instance or image. If an instance is running, it can‐
93       not be removed without the -f option.
94
95       destroy
96               Remove an instance or image. Deprecated, do not use.
97
98       clean
99               Remove non-existing or unsynced libvirt VMs from testcloud.
100
101

INSTANCE CREATE OPTIONS

103       -u, --url URL
104               Specify  the  URL  from  where  testcloud  should  download the
105       instance qcow2 image of fedora:XX. This option is compulsory.
106               Where XX is:
107               - desired Fedora version or
108               - 'latest' - the latest Fedora GA image or
109               -    'qa-matrix'    -     image     from     https://fedorapro‐
110       ject.org/wiki/Test_Results:Current_Cloud_Test
111
112       --ram RAM
113               Set  the amount of RAM that will be available to the instance's
114       VM (in MiB).
115
116       --disksize DISKSIZE
117               Set the disk size of the instance VM (in GiB).
118
119       --vnc
120               Open a VNC connection to the :1 display of the instance VM.
121
122       --no-graphic
123               Turn off the instance VM's graphical display.
124
125       --timeout TIMEOUT
126               Specify the time (in seconds) to wait for the instance boot  to
127       complete. To disable waiting time (default behaviour) set to 0.
128
129

EXAMPLES

131       Create a new instance:
132
133              testcloud instance create <instance_name> -u <URL>
134
135       List all available instances:
136
137              testcloud instance list
138
139       Start an existing instance:
140
141              testcloud instance start <instance_name>
142
143       Stop an existing instance:
144
145              testcloud instance stop <instance_name>
146
147       Remove a running instance:
148
149              testcloud instance remove -f <instance_name>
150
151

BUGS

157       No  known  bugs.  If  you  have  found  a  bug,  please  report  it  at
158       https://bugzilla.redhat.com.
159

AUTHOR

161       Mike Ruckman (roshi@fedoraproject.org)
162
163
164
1651.0                               11 Nov 2020                     TESTCLOUD(1)