Author: arkurth
Date: Mon May 1 16:19:39 2017
New Revision: 1793369
URL: http://svn.apache.org/viewvc?rev=1793369&view=rev
Log:
VCL-1034
Updated Lab.pm::load to not call exit. This was causing the state to get stuck
in 'pending' for preload requests. Cleaned up load and node_status subroutines.
node_status now returns 'READY' if the computer is responding to SSH, and
'RELOAD' if it is not. The load() subroutine also performs an SSH check. If it
is not responding, node_status forces load to be called, which will return
false, causing the reservation to fail before the user is presented with the
connect button.
Modified:
vcl/trunk/managementnode/lib/VCL/Module/Provisioning/Lab.pm
Modified: vcl/trunk/managementnode/lib/VCL/Module/Provisioning/Lab.pm
URL:
http://svn.apache.org/viewvc/vcl/trunk/managementnode/lib/VCL/Module/Provisioning/Lab.pm?rev=1793369&r1=1793368&r2=1793369&view=diff
==============================================================================
--- vcl/trunk/managementnode/lib/VCL/Module/Provisioning/Lab.pm (original)
+++ vcl/trunk/managementnode/lib/VCL/Module/Provisioning/Lab.pm Mon May 1
16:19:39 2017
@@ -61,68 +61,43 @@ use VCL::utils;
=cut
-
-#/////////////////////////////////////////////////////////////////////////////
-
-=head2 unload
-
- Parameters :
- Returns : 0 can't unload this resource type
- Description :
-
-=cut
-
-sub unload {
- return 0;
-}
-
#/////////////////////////////////////////////////////////////////////////////
=head2 load
- Parameters :
- Returns :
- Description :
+ Parameters : none
+ Returns : boolean
+ Description : Checks if the lab computer is responding to SSH. If so, true is
+ returned indicating the lab computer is ready to be reserved for
+ a user. If it is not responding, false is returned. This should
+ fail the request before the Connect button is presented to the
+ user.
=cut
sub load {
- my $self = shift;
- my $request_id = $self->data->get_request_id();
- my $reservation_id = $self->data->get_reservation_id();
- my $reservation_is_parent = $self->data->is_parent_reservation;
- my $request_check_time = $self->data->get_request_check_time();
- my $computer_id = $self->data->get_computer_id();
-
- notify($ERRORS{'OK'}, 0, "computer id: $computer_id, is parent
reservation: $reservation_is_parent");
-
+ my $self = shift;
+ if (ref($self) !~ /VCL::Module/i) {
+ notify($ERRORS{'CRITICAL'}, 0, "subroutine was called as a
function, it must be called as a class method");
+ return;
+ }
+
+ my $request_id = $self->data->get_request_id();
+ my $request_check_time = $self->data->get_request_check_time();
+ my $computer_name = $self->data->get_computer_node_name();
+
# Check if this is a preload request
- # Nothing needs to be done for lab preloads
if ($request_check_time eq 'preload') {
- notify($ERRORS{'OK'}, 0, "check_time result is
$request_check_time, nothing needs to be done for lab preloads");
-
- insertloadlog($reservation_id, $computer_id, "info", "lab
preload does not need to be processed");
-
- # Only the parent reservation should update the preload flag
- if ($reservation_is_parent) {
- # Set the preload flag back to 1 so it will be
processed again
- if (update_preload_flag($request_id, 1)) {
- notify($ERRORS{'OK'}, 0, "parent reservation:
updated preload flag to 1");
- insertloadlog($reservation_id, $computer_id,
"info", "request preload flag updated to 1");
- }
- else {
- notify($ERRORS{'WARNING'}, 0, "parent
reservation: failed to update preload flag to 1");
- insertloadlog($reservation_id, $computer_id,
"info", "failed to update request preload flag to 1");
- }
- } ## end if ($reservation_is_parent)
- else {
- notify($ERRORS{'OK'}, 0, "child reservation: request
preload flag will be changed by the parent reservation");
- }
- notify($ERRORS{'OK'}, 0, "preload lab reservation process
exiting");
- exit;
- } ## end if ($request_check_time eq 'preload')
+ update_preload_flag($request_id, 1) || return 0;
+ }
+
+ if ($self->os->is_ssh_responding()) {
+ notify($ERRORS{'OK'}, 0, "$computer_name is responding to SSH,
no additional steps need to be performed to provision lab computer during this
stage");
+ return 1;
+ }
else {
- notify($ERRORS{'OK'}, 0, "check_time result is
$request_check_time, reservation will be processed");
+ notify($ERRORS{'WARNING'}, 0, "unable to provision lab
computer, $computer_name is NOT responding to SSH");
+ return 0;
}
}
@@ -130,195 +105,62 @@ sub load {
=head2 node_status
- Parameters : [0]: computer node name (optional)
- [1]: log file path (optional)
- Returns : Depends on the context which node_status was called:
- default: string containing "READY" or "FAIL"
- boolean: true if ping, SSH, and VCL client checks are successful
- false if any checks fail
- list: array, values are 1 for SUCCESS, 0 for FAIL
- [0]: Node status ("READY" or "FAIL")
- [1]: Ping status (0 or 1)
- [2]: SSH status (0 or 1)
- [3]: VCL client daemon status (0 ir 1)
- arrayref: reference to array described above
- hashref: reference to hash with keys/values:
- {status} => <"READY","FAIL">
- {ping} => <0,1>
- {ssh} => <0,1>
- {vcl_client} => <0,1>
- Description : Checks the status of a lab machine. Checks if the machine is
- pingable, can be accessed via SSH, and the VCL client is
running.
+ Parameters : none
+ Returns : 'READY' or 'RELOAD'
+ Description : Checks if the lab computer is responding to SSH. If so, 'READY'
+ is returned. This prevents the need to call load(). If the
+ computer is not responding, 'RELOAD' is returned which will
+ result in load() being called.
=cut
sub node_status {
my $self = shift;
- my ($computer_node_name, $log);
-
- my ($management_node_os_name, $management_node_keys,
$computer_host_name, $computer_short_name, $computer_public_ip_address,
$image_os_name);
-
- # Check if subroutine was called as a class method
- if (ref($self) !~ /lab/i) {
- if (ref($self) eq 'HASH') {
- $log = $self->{logfile};
- notify($ERRORS{'DEBUG'}, $log, "self is a hash
reference");
- }
- # Check if node_status returned an array ref
- elsif (ref($self) eq 'ARRAY') {
- notify($ERRORS{'DEBUG'}, 0, "self is a array
reference");
- }
-
- $computer_node_name = $self->{hostname};
- $management_node_os_name = $self->{managementnode}->{OSNAME};
- $management_node_keys = $self->{managementnode}->{keys};
- $computer_host_name = $self->{hostname};
- $computer_public_ip_address = $self->{IPaddress};
- $image_os_name =
$self->{currentimage}->{OS}->{name};
-
- $log = 0 if !$log;
- $computer_short_name = $1 if ($computer_node_name =~
/([-_a-zA-Z0-9]*)(\.?)/);
-
- } ## end if (ref($self) !~ /lab/i)
- else {
- # Get the computer name from the DataStructure
- $computer_node_name = $self->data->get_computer_node_name();
-
- # Check if this was called as a class method, but a node name
was also specified as an argument
- my $node_name_argument = shift;
- $computer_node_name = $node_name_argument if
$node_name_argument;
-
- $management_node_os_name =
$self->data->get_management_node_os_name();
- $management_node_keys =
$self->data->get_management_node_keys();
- $computer_host_name =
$self->data->get_computer_host_name();
- $computer_short_name =
$self->data->get_computer_short_name();
- $computer_public_ip_address =
$self->data->get_computer_public_ip_address();
- $image_os_name = $self->data->get_image_os_name();
-
- $log = 0;
- } ## end else [ if (ref($self) !~ /lab/i)
-
- notify($ERRORS{'DEBUG'}, $log, "computer_short_name=
$computer_short_name ");
- notify($ERRORS{'DEBUG'}, $log, "computer_node_name= $computer_node_name
");
- notify($ERRORS{'DEBUG'}, $log, "image_os_name= $image_os_name");
- notify($ERRORS{'DEBUG'}, $log, "management_node_os_name=
$management_node_os_name");
- notify($ERRORS{'DEBUG'}, $log, "computer_public_ip_address=
$computer_public_ip_address");
- notify($ERRORS{'DEBUG'}, $log, "management_node_keys=
$management_node_keys");
-
-
- # Check the node name variable
- if (!$computer_node_name) {
- notify($ERRORS{'WARNING'}, $log, "node name could not be
determined");
- return 0;
- }
- notify($ERRORS{'DEBUG'}, $log, "checking status of node:
$computer_node_name");
-
- $computer_host_name = $computer_node_name;
-
- # Create a hash to store status components
- my %status;
-
- # Initialize all hash keys here to make sure they're defined
- $status{status} = 0;
- $status{ping} = 0;
- $status{ssh} = 0;
- $status{vcl_client} = 0;
-
- # Check if host is listed in management node's known_hosts file
- notify($ERRORS{'DEBUG'}, $log, "checking if $computer_host_name in
management node known_hosts file");
- if (known_hosts($computer_host_name, $management_node_os_name,
$computer_public_ip_address)) {
- notify($ERRORS{'OK'}, $log, "$computer_host_name public key
added to management node known_hosts file");
+ if (ref($self) !~ /VCL::Module/i) {
+ notify($ERRORS{'CRITICAL'}, 0, "subroutine was called as a
function, it must be called as a class method");
+ return;
+ }
+
+ my $computer_name = $self->data->get_computer_node_name();
+
+ if ($self->os->is_ssh_responding()) {
+ notify($ERRORS{'OK'}, 0, "$computer_name is responding to SSH,
returning 'READY'");
+ return 'READY';
}
else {
- notify($ERRORS{'WARNING'}, $log, "failed to add
$computer_host_name public key to management node known_hosts");
+ notify($ERRORS{'OK'}, 0, "$computer_name is NOT responding to
SSH, returning 'RELOAD'");
+ return 'RELOAD';
}
+}
+#/////////////////////////////////////////////////////////////////////////////
- # Check if node is pingable
- notify($ERRORS{'DEBUG'}, $log, "checking if $computer_public_ip_address
is pingable");
- if (_pingnode($computer_public_ip_address)) {
- notify($ERRORS{'OK'}, $log, "$computer_public_ip_address is
pingable");
- $status{ping} = 1;
- }
- else {
- notify($ERRORS{'OK'}, $log, "$computer_public_ip_address is not
pingable");
- $status{ping} = 0;
- }
+=head2 power_reset
+ Parameters : none
+ Returns : 1
+ Description :
- # Check if sshd is open on the admin port (24)
- notify($ERRORS{'DEBUG'}, $log, "checking if $computer_public_ip_address
sshd admin port 24 is accessible");
- if (check_ssh($computer_public_ip_address, 24, $log)) {
- notify($ERRORS{'OK'}, $log, "$computer_public_ip_address admin
sshd port 24 is accessible");
-
- # Run uname -n to make sure ssh is usable
- notify($ERRORS{'OK'}, $log, "checking if ssh command can be run
on $computer_public_ip_address");
- my ($uname_exit_status, $uname_output) =
run_ssh_command($computer_public_ip_address, $management_node_keys, "uname -n",
"vclstaff", 24);
- if (!defined($uname_output) || !$uname_output) {
- notify($ERRORS{'WARNING'}, $log, "unable to run 'uname
-n' ssh command on $computer_public_ip_address");
- $status{ssh} = 0;
- }
- else {
- notify($ERRORS{'OK'}, $log, "successfully ran 'uname
-n' ssh command on $computer_public_ip_address");
- $status{ssh} = 1;
- }
-
- ## Check the uname -n output lines, make sure computer name is
listed
- #if (grep /$computer_short_name/, @{$uname_output}) {
- # notify($ERRORS{'OK'}, $log, "found computer name in ssh
'uname -n' output");
- # #$status{ssh} = 1;
- #}
- #else {
- # my $uname_output_string = join("\n", @{$uname_output});
- # notify($ERRORS{'WARNING'}, $log, "unable to find
computer name in ssh 'uname -n' output output:\n$uname_output_string");
- # #$status{ssh} = 0;
- #}
-
- # Check if is VCL client daemon is running
- notify($ERRORS{'OK'}, $log, "checking if VCL client daemon is
running on $computer_public_ip_address");
- my ($pgrep_exit_status, $pgrep_output) =
run_ssh_command($computer_public_ip_address, $management_node_keys, "pgrep
vclclient", "vclstaff", 24);
- if (!defined($pgrep_output) || !$pgrep_output) {
- notify($ERRORS{'WARNING'}, $log, "unable to run 'pgrep
vclclient' command on $computer_public_ip_address");
- $status{vcl_client} = 0;
- }
-
- # Check the pgrep output lines, make sure process is listed
- if (grep /[0-9]+/, @{$pgrep_output}) {
- notify($ERRORS{'DEBUG'}, $log, "VCL client daemon is
running");
- $status{vcl_client} = 1;
- }
- else {
- my $pgrep_output_string = join("\n", @{$pgrep_output});
- notify($ERRORS{'WARNING'}, $log, "VCL client daemon is
not running, unable to find running process in 'pgrep vclclient'
output:\n$pgrep_output_string");
- $status{vcl_client} = 0;
- }
- } ## end if (check_ssh($computer_public_ip_address, 24, $log...
- else {
- notify($ERRORS{'WARNING'}, $log, "$computer_public_ip_address
sshd admin port 24 is not accessible");
- $status{ssh} = 0;
- $status{vcl_client} = 0;
- }
+=cut
- # Determine the overall machine status based on the individual status
results
- if ($status{vcl_client}) {
- $status{status} = 'READY';
- }
- else {
- # Lab machine is not available, return undefined to indicate
error occurred
- notify($ERRORS{'WARNING'}, 0, "lab machine $computer_host_name
($computer_public_ip_address) is not available");
- $status{status} = 'RELOAD';
- }
+sub power_reset {
+ return 1;
+}
- notify($ERRORS{'OK'}, 0, "returning node status hash reference with
{status}=$status{status}");
- return \%status;
-} ## end sub node_status
+#/////////////////////////////////////////////////////////////////////////////
+=head2 unload
-sub power_reset {
+ Parameters : none
+ Returns : 0
+ Description :
- return 1;
+=cut
+sub unload {
+ return 0;
}
+
#/////////////////////////////////////////////////////////////////////////////
1;
