1Rex::Commands::Cloud(3)User Contributed Perl DocumentatioRnex::Commands::Cloud(3)
2
6 Rex::Commands::Cloud - Cloud Management Commands
7
9 With this Module you can manage different Cloud services. Currently it
10 supports Amazon EC2, Jiffybox and OpenStack.
11 Version <= 1.0: All these functions will not be reported.
13
15 use Rex::Commands::Cloud;
16 cloud_service "Amazon";
18 cloud_auth "your-access-key", "your-private-access-key";
19 cloud_region "ec2.eu-west-1.amazonaws.com";
20 task "list", sub {
22 print Dumper cloud_instance_list;
23 print Dumper cloud_volume_list;
24 };
25 task "create", sub {
27 my $vol_id = cloud_volume create => { size => 1, zone => "eu-west-1a", };
28 cloud_instance create => {
30 image_id => "ami-xxxxxxx",
31 name => "test01",
32 key => "my-key",
33 volume => $vol_id,
34 zone => "eu-west-1a",
35 };
36 };
37 task "destroy", sub {
39 cloud_volume detach => "vol-xxxxxxx";
40 cloud_volume delete => "vol-xxxxxxx";
41 cloud_instance terminate => "i-xxxxxxx";
43 };
44
46 cloud_service($cloud_service)
47 Define which cloud service to use.
48 Services
50 Amazon
51 Jiffybox
52 OpenStack
53 cloud_auth($param1, $param2, ...)
55 Set the authentication for the cloudservice.
56 For example for Amazon it is:
58 cloud_auth($access_key, $secret_access_key);
60 For JiffyBox:
62 cloud_auth($auth_key);
64 For OpenStack:
66 cloud_auth(
68 tenant_name => 'tenant',
69 username => 'user',
70 password => 'password',
71 );
72 cloud_region($region)
74 Set the cloud region.
75 cloud_instance_list
77 Get all instances of a cloud service.
78 task "list", sub {
80 for my $instance (cloud_instance_list()) {
81 say "Arch : " . $instance->{"architecture"};
82 say "IP : " . $instance->{"ip"};
83 say "ID : " . $instance->{"id"};
84 say "State : " . $instance->{"state"};
85 }
86 };
87 There are some parameters for this function that can change the
89 gathering of ip addresses for some cloud providers (like OpenStack).
90 task "list", sub {
92 my @instances = cloud_instance_list
93 private_network => 'private',
94 public_network => 'public',
95 public_ip_type => 'floating',
96 private_ip_type => 'fixed';
97 };
98 cloud_volume_list
100 Get all volumes of a cloud service.
101 task "list-volumes", sub {
103 for my $volume (cloud_volume_list()) {
104 say "ID : " . $volume->{"id"};
105 say "Zone : " . $volume->{"zone"};
106 say "State : " . $volume->{"state"};
107 say "Attached : " . $volume->{"attached_to"};
108 }
109 };
110 cloud_network_list
112 Get all networks of a cloud service.
113 task "network-list", sub {
115 for my $network (cloud_network_list()) {
116 say "network : " . $network->{network};
117 say "name : " . $network->{name};
118 say "id : " . $network->{id};
119 }
120 };
121 cloud_image_list
123 Get a list of all available cloud images.
124 cloud_upload_key
126 Upload public SSH key to cloud provider
127 private_key '~/.ssh/mykey
129 public_key '~/.ssh/mykey.pub';
130 task "cloudprovider", sub {
132 cloud_upload_key;
133 cloud_instance create => {
135 ...
136 };
137 };
138 get_cloud_instances_as_group
140 Get a list of all running instances of a cloud service. This can be
141 used for a group definition.
142 group fe => "fe01", "fe02", "fe03";
144 group ec2 => get_cloud_instances_as_group();
145 cloud_instance($action, $data)
147 This function controls all aspects of a cloud instance.
148 create
150 Create a new instance.
151 cloud_instance create => {
153 image_id => "ami-xxxxxx",
154 key => "ssh-key",
155 name => "fe-ec2-01", # name is not necessary
156 volume => "vol-yyyyy", # volume is not necessary
157 zone => "eu-west-1a", # zone is not necessary
158 floating_ip => "89.39.38.160" # floating_ip is not necessary
159 };
160 start
162 Start an existing instance
163 cloud_instance start => "instance-id";
165 stop
167 Stop an existing instance
168 cloud_instance stop => "instance-id";
170 terminate
172 Terminate an instance. This will destroy all data and remove the
173 instance.
174 cloud_instance terminate => "i-zzzzzzz";
176 get_cloud_regions
178 Returns all regions as an array.
179 cloud_volume($action , $data)
181 This function controlls all aspects of a cloud volume.
182 create
184 Create a new volume. Size is in Gigabytes.
185 task "create-vol", sub {
187 my $vol_id = cloud_volume create => { size => 1, zone => "eu-west-1a", };
188 };
189 attach
191 Attach a volume to an instance.
192 task "attach-vol", sub {
194 cloud_volume attach => "vol-xxxxxx", to => "server-id";
195 };
196 detach
198 Detach a volume from an instance.
199 task "detach-vol", sub {
201 cloud_volume detach => "vol-xxxxxx", from => "server-id";
202 };
203 delete
205 Delete a volume. This will destroy all data.
206 task "delete-vol", sub {
208 cloud_volume delete => "vol-xxxxxx";
209 };
210 get_cloud_floating_ip
212 Returns first available floating IP
213 task "get_floating_ip", sub {
215 my $ip = get_cloud_floating_ip;
217 my $instance = cloud_instance create => {
219 image_id => 'edffd57d-82bf-4ffe-b9e8-af22563741bf',
220 name => 'instance1',
221 plan_id => 17,
222 floating_ip => $ip
223 };
224 };
225 cloud_network
227 create
228 Create a new network.
229 task "create-net", sub {
231 my $net_id = cloud_network create => { cidr => '192.168.0.0/24', name => "mynetwork", };
232 };
233 delete
235 Delete a network.
236 task "delete-net", sub {
238 cloud_network delete => '18a4ccf8-f14a-a10d-1af4-4ac7fee08a81';
239 };
240 get_cloud_availability_zones
242 Returns all availability zones of a cloud services. If available.
243 task "get-zones", sub {
245 print Dumper get_cloud_availability_zones;
246 };
247 get_cloud_plans
249 Retrieve information of the available cloud plans. If supported.
250 get_cloud_operating_systems
252 Retrieve information of the available cloud plans. If supported.
253 cloud_object
255 Returns the cloud object itself.
256perl v5.36.0 2022-07-20 Rex::Commands::Cloud(3)