-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create the node functionalities for IBMCloud with Bare Metal (#9202)
* Create the node functionalities for IBMCloud BM, create a new test file for testing the node restart functionalities, Add a new marker 'provider_client_platform_required' Signed-off-by: Itzhak Kave <[email protected]> * Add few small fixes - add one Polarion ID, and create two new Polarion IDs - Add the 'region' param to the config file - Increase timeout waiting for the pods - Fix the init method of the class 'IBMCloudBM' Signed-off-by: Itzhak Kave <[email protected]> --------- Signed-off-by: Itzhak Kave <[email protected]> Co-authored-by: Itzhak Kave <[email protected]>
- Loading branch information
Showing
5 changed files
with
563 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| # -*- coding: utf8 -*- | ||
| """ | ||
| Module for interactions with IBM Cloud Cluster. | ||
| """ | ||
|
|
||
| import json | ||
| import logging | ||
|
|
||
| from ocs_ci.framework import config | ||
| from ocs_ci.ocs.exceptions import CommandFailed | ||
| from ocs_ci.utility.utils import run_cmd | ||
|
|
||
|
|
||
| logger = logging.getLogger(name=__file__) | ||
| ibm_config = config.AUTH.get("ibmcloud", {}) | ||
|
|
||
|
|
||
| class IBMCloudBM(object): | ||
| """ | ||
| Wrapper for IBM Cloud with Bare metal machines | ||
| """ | ||
|
|
||
| def __init__(self, region=None): | ||
| """ | ||
| Constructor for IBM Cloud Bare Metal machines | ||
| Args: | ||
| region (str): The region of the IBM Cloud Bare Metal machines | ||
| """ | ||
| self.api_key = ibm_config["api_key"] | ||
| self.account_id = ibm_config.get("account_id") | ||
| self.region = region or config.ENV_DATA.get("region") | ||
|
|
||
| def login(self): | ||
| """ | ||
| Login to IBM Cloud account | ||
| """ | ||
| login_cmd = f"ibmcloud login --apikey {self.api_key} -c {self.account_id} -r {self.region}" | ||
| logger.info("Logging to IBM cloud") | ||
| run_cmd(login_cmd, secrets=[self.api_key]) | ||
| logger.info("Successfully logged in to IBM cloud") | ||
|
|
||
| def run_ibmcloud_bm_cmd( | ||
| self, cmd, secrets=None, timeout=600, ignore_error=False, **kwargs | ||
| ): | ||
| """ | ||
| Wrapper function for `run_cmd` which if needed will perform IBM Cloud login | ||
| command before running the ibmcloud bare metal command. In the case run_cmd will fail | ||
| because the IBM cloud got disconnected, it will login and re-try. | ||
| Args: | ||
| cmd (str): command to run | ||
| secrets (list): A list of secrets to be masked with asterisks | ||
| This kwarg is popped in order to not interfere with | ||
| subprocess.run(``**kwargs``) | ||
| timeout (int): Timeout for the command, defaults to 600 seconds. | ||
| ignore_error (bool): True if ignore non zero return code and do not | ||
| raise the exception. | ||
| """ | ||
| basic_cmd = "ibmcloud sl hardware " | ||
| cmd = basic_cmd + cmd | ||
|
|
||
| try: | ||
| return run_cmd(cmd, secrets, timeout, ignore_error, **kwargs) | ||
| except CommandFailed as ex: | ||
| login_error_messages = [ | ||
| "Error: Failed to get", | ||
| "Access Denied", | ||
| "Please login", | ||
| ] | ||
| # Check if we need to re-login to IBM Cloud account | ||
| if any([error_msg in str(ex) for error_msg in login_error_messages]): | ||
| self.login() | ||
| return run_cmd(cmd, secrets, timeout, ignore_error, **kwargs) | ||
|
|
||
| def get_all_machines(self): | ||
| """ | ||
| Get all the machines in the IBMCloud Bare metal machines | ||
| Returns: | ||
| list: List of dictionaries. List of all the machines in the IBMCloud Bare metal machines | ||
| """ | ||
| cmd = "list --output json" | ||
| machine_list = json.loads(self.run_ibmcloud_bm_cmd(cmd)) | ||
| return machine_list | ||
|
|
||
| def get_machines_by_ips(self, machine_ips): | ||
| """ | ||
| Get the machines in the IBMCloud Bare metal machines that have the given machine IPs | ||
| Args: | ||
| machine_ips (list): The list of the machine IPs to search for. | ||
| Returns: | ||
| Get the machines in the IBMCloud Bare metal machines that have the given machine IPs | ||
| """ | ||
| machine_list = self.get_all_machines() | ||
| return [m for m in machine_list if m["primaryIpAddress"] in machine_ips] | ||
|
|
||
| def stop_machines(self, machines): | ||
| """ | ||
| Stop the IBMCloud Bare metal machines | ||
| Args: | ||
| machines (list): List of the IBMCLoud Bare metal machines objects to stop | ||
| """ | ||
| for m in machines: | ||
| logger.info(f"Powering off the machine with ip {m['primaryIpAddress']}") | ||
| cmd = f"power-off {m['id']} -f" | ||
| self.run_ibmcloud_bm_cmd(cmd) | ||
|
|
||
| def start_machines(self, machines): | ||
| """ | ||
| Start the IBMCloud Bare metal machines | ||
| Args: | ||
| machines (list): List of the IBMCLoud Bare metal machines objects to start | ||
| """ | ||
| for m in machines: | ||
| logger.info(f"Powering on the machine with ip {m['primaryIpAddress']}") | ||
| cmd = f"power-on {m['id']}" | ||
| self.run_ibmcloud_bm_cmd(cmd) | ||
|
|
||
| def restart_machines(self, machines, force=False): | ||
| """ | ||
| Reboot the IBMCloud Bare metal machines | ||
| Args: | ||
| machines (list): List of the IBMCLoud Bare metal machines objects to restart | ||
| force (bool): If False, will perform a soft reboot. Otherwise, if True, will perform a hard reboot | ||
| """ | ||
| reboot_type = "hard" if force else "soft" | ||
| for m in machines: | ||
| logger.info(f"Reboot the machine with the ip {m['primaryIpAddress']}") | ||
| cmd = f"reboot {m['id']} -f --{reboot_type}" | ||
| self.run_ibmcloud_bm_cmd(cmd) | ||
|
|
||
| def restart_machines_by_stop_and_start(self, machines): | ||
| """ | ||
| Restart the IBMCloud Bare metal machines by stop and start | ||
| Args: | ||
| machines (list): List of the IBMCLoud Bare metal machines objects to restart | ||
| """ | ||
| self.stop_machines(machines) | ||
| self.start_machines(machines) |
Oops, something went wrong.