def cli_change_kernel():
"""Change the kernel of an image
:raises UserWarning: When there is no image with kernel
"""
# Get all images
images_list = ImageManager.get_created_images()
# Select only images with kernel attribut
images_with_kernel = []
for image in images_list:
if hasattr(image, 'kernel'):
images_with_kernel.append(image.name)
# If there is no image with kernel, raise an exception
if not images_with_kernel:
raise UserWarning('Not any image with a kernel')
# Select the image to change kernel
image_name = select_from_list(images_with_kernel)
image = ImageManager.get_created_image(image_name)
print('\nCurrent kernel is: ' + image.kernel + '\n')
# Select an available kernel
new_kernel = KernelManager.cli_select_kernel()
# Set image kernel by using image method
KernelManager.change_kernel(image, new_kernel)
def cli_create_golden_image():
# Get all staging images
staging_images = NfsStagingImage.get_images()
# Check if there are staging images
if not staging_images:
raise UserWarning(
'No nfs staging images. Golden image creation require an nfs staging image.'
)
# Get staging images names
staging_images_names = [
staging_image.name for staging_image in staging_images
]
# Select a staging image for golden image creation
printc('[+] Select the nfs image to use for golden image creation:',
Color.GREEN)
staging_image_name = select_from_list(staging_images_names)
staging_image = ImageManager.get_created_image(staging_image_name)
# Condition to test if image name is compliant
while True:
printc('\n[+] Give a name for your image', Color.GREEN)
# Get new image name
selected_image_name = input('-->: ').replace(" ", "")
if selected_image_name == '':
raise UserWarning('Image name cannot be empty !')
if not ImageManager.is_image(selected_image_name):
break
# Else
print('Image ' + selected_image_name +
' already exist, use another image name.')
# Confirm image creation
printc(
'\n[+] Would you like to create a new nfs golden image with the following attributes: (yes/no)',
Color.GREEN)
print(' ├── Image name: \t\t' + selected_image_name)
print(' └── Staging image from: \t' + staging_image.name)
confirmation = input('-->: ').replace(" ", "")
if confirmation == 'yes':
# Create the image object
NfsGoldenImage(selected_image_name, staging_image)
printc('\n[OK] Done.', Color.GREEN)
elif confirmation == 'no':
printc('\nImage creation cancelled, return to main menu.',
Color.YELLOW)
return
else:
raise UserWarning('\nInvalid confirmation !')
def __init__(self, name, *args):
"""Class consructor.
The constructor take in argument the name of the image, and the creation arguments (in *args).
To get an already existing image that you have previously created, you must call this constructor whith only image 'name' to load it.
To create a new image, you must call this constructor with image 'name' and all other requiered class constructor arguments.
When you redefine Image class constructor you must define your constructor and create_new_image method as following:
def __init__(self, name, arg1 = None, arg2 = None, argX = None...): <- You must strictly follow this syntax with your custom args (arg1, arg2, argX ...)
super().__init__(name, arg1, arg2, argX...) <-
<-
def create_new_image(self, arg1, arg32, argX...): <-
...(your code) <- From here you can custom
For an exemple look at DemoClass class in demo_module.
:param name: The name of the image
:type name: str
:param *args: The list of arguments for image creation
:type *args: list of arguments
"""
# Check name format
if ((not isinstance(name, str)) or (len(name.split()) > 1)):
raise ValueError('Invalid name format.')
self.name = name
self.IMAGE_DIRECTORY = Image.IMAGES_DIRECTORY + self.name + '/'
# If image already exist, and not all other arguments excepts name are None:
# Bad usage of constructor
if os.path.isdir(self.IMAGE_DIRECTORY) and not all(arg is None
for arg in args):
raise ValueError(
'Bad constructor image: All arguments must be None except name when image already exist'
)
# If the image already exist, and all other arguments excepts name are None:
# Load existing image
elif os.path.isdir(self.IMAGE_DIRECTORY):
self.get_existing_image()
# If image don't already exist, create it
else:
# Register image in ongoing installations file
ImageManager.register_installation(self.name,
self.__class__.__name__)
# Create the image object with all constructor arguments except the name because it is already an image attribute
self.create_new_image(*args)
# Register all image attributs at the end of its creation for saving it
self.register_image()
# After image creation, unregister it from ongoing installations file
ImageManager.unregister_installation(self.name)
logging.info('Image \'' + self.name + '\' creation complete !')
def cli_manage_nodes():
# Get all golden images
golden_images = NfsGoldenImage.get_images()
if not golden_images:
raise UserWarning('No nfs golden image to manage.')
# Get golden images names
golden_images_names = [golden_image.name for golden_image in golden_images]
# Select the golden image to manage from list
printc('\n[+] Select the golden image to manage:', Color.GREEN)
golden_image_name = select_from_list(golden_images_names)
golden_image = ImageManager.get_created_image(golden_image_name)
# Choose an action for nodes management
printc('\n[+] Manages nodes of image ' + golden_image_name, Color.GREEN)
print(' 1 - List nodes with the image')
print(' 2 - Add nodes with the image')
print(' 3 - Remove nodes with the image')
action = input('-->: ')
# Print golden image nodes
if action == '1':
nodeset = golden_image.get_nodes()
print(nodeset)
printc('\n[OK] Done.', Color.GREEN)
# Add some nodes to the image
elif action == '2':
printc('\n[+] Actual image NodeSet is: ' + str(golden_image.nodes),
Color.GREEN)
printc('[+] Please enter nodes range to add:', Color.GREEN)
nodes_range = input('-->: ').replace(" ", "")
# Test if nodes_range is a valid range
try:
golden_image.add_nodes(nodes_range)
printc('\n[OK] Done.', Color.GREEN)
except KeyError:
raise UserWarning('The Node you have entered is not compliant.')
# Delete nodes from image
elif action == '3':
printc('\n[+] Please enter nodes range to remove:', Color.GREEN)
nodes_range = input('-->: ').replace(" ", "")
# Test if nodes_range is a valid range
try:
golden_image.remove_nodes(nodes_range)
printc('\n[OK] Done.', Color.GREEN)
except KeyError:
raise UserWarning('The Node you have entered is not compliant.')
else:
raise UserWarning('Not a valid entry')
def cli_resize_livenet_image():
# Get list of livenet images
livenet_images = LivenetImage.get_images()
# Check if there are livenet images
if not livenet_images:
raise UserWarning('No livenet images.')
# Get livenet images names
unmounted_images_names = [
livenet_image.name for livenet_image in livenet_images
if livenet_image.is_mounted is False
]
# Check if there are unmounted images
# An image must be unmounted to be resized
if not unmounted_images_names:
raise UserWarning('No unmounted livenet images.')
# Select a livenet to mount
printc('[+] Select the livenet image to mount:', Color.GREEN)
unmounted_image_name = select_from_list(unmounted_images_names)
unmounted_image = ImageManager.get_created_image(unmounted_image_name)
# Enter new size
printc(
'Please enter your new image size:\n(supported units: M=1024*1024, G=1024*1024*1024)\n(Examples: 5120M or 5G)',
Color.GREEN)
selected_size = input('-->: ')
# Check and convert the size
image_size = cli_get_size(selected_size)
# Check size compliance with livenet image expected size limits
if int(image_size) < (LivenetImage.MIN_LIVENET_SIZE) or int(image_size) > (
LivenetImage.MAX_LIVENET_SIZE):
raise UserWarning('\nSize out of limits !')
# Confirm image resizing
printc(
'\n[+] Are you sure you want to resize image \'' +
unmounted_image.name + '\' with the following size: (yes/no)',
Color.GREEN)
print(' └── Image size: ' + selected_size)
confirmation = input('-->: ').replace(" ", "")
if confirmation == 'yes':
# Create the image object
unmounted_image.resize(image_size)
printc('\n[OK] Done.', Color.GREEN)
elif confirmation == 'no':
printc('\n[+] Image resizing cancelled, return to main menu.',
Color.YELLOW)
return
def get_images(cls):
"""Get all images that are of this class type."""
# Get all images
images = ImageManager.get_created_images()
# Instantiate None class_image array
class_images = None
# If there is images
if images:
# Get all class images
class_images = [
image for image in images if image.image_class == cls.__name__
]
# Return all class images
return class_images
def cli_unmount_livenet_image():
livenet_images = LivenetImage.get_images()
# Check if there are staging images
if not livenet_images:
raise UserWarning('No livenet images.')
# Get staging images names
mounted_images_names = [livenet_image.name for livenet_image in livenet_images if livenet_image.is_mounted is True]
# Check if there unmounted images
if not mounted_images_names:
raise UserWarning('No mounted livenet images.')
# Select a staging image for golden image creation
printc('[+] Select the livenet image to unmount:', Color.GREEN)
mounted_image_name = select_from_list(mounted_images_names)
mounted_image = ImageManager.get_created_image(mounted_image_name)
mounted_image.unmount()
def cli_menu():
"""This method is needed for all diskless module to be available by cli interface."""
printc('\n == Welcome to demo image module == \n', Color.GREEN)
print('1 - Create my demo image')
print('\n Select an action')
main_action = input('-->: ')
print('')
if main_action == '1':
# Condition to test if image name is compliant
while True:
printc('[+] Give a name for your demo image', Color.GREEN)
# Get new image name
selected_image_name = input('-->: ').replace(" ", "")
if selected_image_name == '':
raise UserWarning('Image name cannot be empty !')
if not ImageManager.is_image(selected_image_name):
break
# Else
print('Image ' + selected_image_name +
' already exist, use another image name.')
printc('\nGive a message for your demo image:', Color.GREEN)
demo_message = input('-->: ')
# Create a DemoImage image
DemoImage(selected_image_name, demo_message)
# Bad entry
else:
raise UserWarning(
'\'' + main_action +
'\' is not a valid entry. Please enter another value.')
def cli_create_livenet_image():
# Get available kernels
kernel_list = KernelManager.get_available_kernels()
# If there are no kernels aise an exception
if not kernel_list:
raise UserWarning('No kernel available')
# Condition to test if image name is compliant
while True:
printc('[+] Give a name for your image', Color.GREEN)
# Get new image name
selected_image_name = input('-->: ').replace(" ", "")
if selected_image_name == '':
raise UserWarning('Image name cannot be empty !')
if not ImageManager.is_image(selected_image_name):
break
# Else
print('Image ' + selected_image_name +
' already exist, use another image name.')
# Select the kernel to use
printc('\n[+] Select your kernel:', Color.GREEN)
selected_kernel = select_from_list(kernel_list)
# Manage password
printc('\n[+] Give a password for your image', Color.GREEN)
selected_password = input(
'Enter clear root password of the new image: ').replace(" ", "")
# Select livenet type
types_list = [
'Standard: core (~1.3Gb)',
'Small: openssh, dnf and NetworkManager (~300Mb)',
'Minimal: openssh only (~270Mb)'
]
get_type = select_from_list(types_list)
if get_type == 'Standard: core (~1.3Gb)':
selected_type = LivenetImage.Type.STANDARD
elif get_type == 'Small: openssh, dnf and NetworkManager (~300Mb)':
selected_type = LivenetImage.Type.SMALL
elif get_type == 'Minimal: openssh only (~270Mb)':
selected_type = LivenetImage.Type.CORE
else:
raise UserWarning('Not a valid choice !')
# Select livenet size
printc(
'\nPlease choose image size:\n(supported units: M=1024*1024, G=1024*1024*1024)\n(Examples: 5120M or 5G)',
Color.GREEN)
selected_size = input('-->: ')
# Check and convert the size
image_size = cli_get_size(selected_size)
# Check size compliance with livenet image expected size limits
if int(image_size) < (LivenetImage.MIN_LIVENET_SIZE) or int(image_size) > (
LivenetImage.MAX_LIVENET_SIZE):
raise UserWarning('\nSize out of limits !')
# Inject ssh key or not
printc(
'\nEnter path to SSH public key (left empty to disable key injection)',
Color.GREEN)
selected_ssh_pub_key = input('-->: ')
if selected_ssh_pub_key != '' and not os.path.exists(selected_ssh_pub_key):
raise UserWarning('\nSSH public key not found ' + selected_ssh_pub_key)
if selected_ssh_pub_key == '':
selected_ssh_pub_key = None
# Activate SELinux or not
printc('\nActivate SELinux inside the image (yes/no) ?', Color.GREEN)
answer_selinux = input('-->: ')
if answer_selinux == 'yes':
selinux = True
elif answer_selinux == 'no':
selinux = False
else:
raise UserWarning('\nInvalid input !')
# Propose to user to install additional packages
printc(
'\nDo you want to customize your image with additional packages (yes/no) ? ',
Color.GREEN)
choice = input('-->: ')
# Install additional packages
if choice == 'yes':
# Get package list from user
additional_packages = Image.cli_add_packages()
# Don't install additional packages
elif choice == 'no':
additional_packages = None
else:
raise UserWarning('\nInvalid entry !')
# Propose to user to specify a release version
printc(
'\nSpecify a release version for installation (left empty to not use the --relasever option)',
Color.GREEN)
release_version = input('-->: ')
if release_version == '':
release_version = None
# Propose to optimize image packages
printc(
'\nDo you wish tool try to optimize image by using aggressive packages dependencies parameters ? ',
Color.GREEN)
printc(
'Note that this may collide with additional packages if asked for. (yes/no) ? ',
Color.GREEN)
answer_optimize = input('-->: ')
if answer_optimize == 'yes':
optimize = True
elif answer_optimize == 'no':
optimize = False
else:
raise UserWarning('\nInvalid input !')
# Confirm image creation
printc(
'\n[+] Would you like to create a new livenet image with the following attributes: (yes/no)',
Color.GREEN)
print(' ├── Image name: \t\t' + selected_image_name)
print(' ├── Image password: \t\t' + selected_password)
print(' ├── Image kernel: \t\t' + selected_kernel)
print(' ├── Image type: \t\t' + get_type)
print(' ├── Image size: \t\t' + selected_size)
print(' ├── Optimize packages: \t' + str(optimize))
# Print ssh pub key packages if there is one
if selected_ssh_pub_key is not None:
print(' ├── SSH pubkey: \t\t' + selected_ssh_pub_key)
# Print additional packages if there is
if additional_packages is not None:
print(' ├── Additional packages: \t' + str(additional_packages))
# Print release version if there is one
if release_version is not None:
print(' ├── Release version: \t\t' + release_version)
print(' └── Enable SELinux: \t\t' + str(selinux))
confirmation = input('-->: ').replace(" ", "")
if confirmation == 'yes':
# Create the image object
LivenetImage(selected_image_name, selected_password, selected_kernel,
selected_type, image_size, additional_packages,
selected_ssh_pub_key, selinux, release_version, optimize)
printc('\n[OK] Done.', Color.GREEN)
elif confirmation == 'no':
printc('\n[+] Image creation cancelled, return to main menu.',
Color.YELLOW)
return
else:
raise UserWarning('\nInvalid confirmation !')
# Answer to get the action to execute
print(' Select an action:')
# Prevent old inputs to be taken as current input by cleaning stdin buffer
tcflush(sys.stdin, TCIFLUSH)
# Get user choice
main_action = input('-->: ')
print('')
# Now that user has made a choice, we are not longer in the main menu
in_main_menu = False
# Clear potential previous bad installations before excecuting a main menu action
ImageManager.clean_intallations()
# With ImageManager.cli_use_modules() we can use all available modules
if main_action == '1':
ImageManager.cli_use_modules()
# Display already created diskless images
elif main_action == '2':
ImageManager.cli_display_images()
printc('\n[OK] Done.', Color.GREEN)
# Remove a diskless image
elif main_action == '3':
# Get image object to remove
image = ImageManager.get_created_image(
ImageManager.cli_select_created_image())
def cli_create_staging_image():
# Get available kernels
kernel_list = KernelManager.get_available_kernels()
# If there are no kernels aise an exception
if not kernel_list:
raise UserWarning('No kernel available')
# Condition to test if image name is compliant
while True:
printc('[+] Give a name for your image', Color.GREEN)
# Get new image name
selected_image_name = input('-->: ').replace(" ", "")
if selected_image_name == '':
raise UserWarning('Image name cannot be empty !')
if not ImageManager.is_image(selected_image_name):
break
# Else
print('Image ' + selected_image_name +
' already exist, use another image name.')
# Select the kernel to use
printc('\n[+] Select your kernel:', Color.GREEN)
selected_kernel = select_from_list(kernel_list)
# Manage password
printc('\n[+] Give a password for your image', Color.GREEN)
selected_password = input(
'Please enter clear root password of the new image: ').replace(
" ", "")
# Propose to user to install additional packages
printc(
'\nDo you want to customize your image with additional packages? (yes/no)',
Color.GREEN)
choice = input('-->: ')
# Install addictional packages
if choice == 'yes':
# Get package list from user
additional_packages = Image.cli_add_packages()
# Don't install additional packages
elif choice == 'no':
additional_packages = None
else:
raise UserWarning('\nInvalid entry !')
# Propose to user to specify a release version
printc(
'\nSpecify a release version for installation (left empty to not use the --relasever option)',
Color.GREEN)
release_version = input('-->: ')
if release_version == '':
release_version = None
# Confirm image creation
printc(
'\n[+] Would you like to create a new nfs staging image with the following attributes: (yes/no)',
Color.GREEN)
print(' ├── Image name: \t\t' + selected_image_name)
print(' ├── Image password : \t\t' + selected_password)
# Print additional packages if there is
if additional_packages is not None:
print(' ├── Additional packages: \t' + str(additional_packages))
# Print release version if there is one
if release_version is not None:
print(' ├── Release version: \t\t' + release_version)
print(' └── Image kernel: \t\t' + selected_kernel)
confirmation = input('-->: ').replace(" ", "")
if confirmation == 'yes':
# Create the image object
NfsStagingImage(selected_image_name, selected_password,
selected_kernel, additional_packages, release_version)
printc('\n[OK] Done.', Color.GREEN)
elif confirmation == 'no':
printc('\n[+] Image creation cancelled, return to main menu.',
Color.YELLOW)
return
else:
raise UserWarning('\nInvalid confirmation !')