diff --git a/README.md b/README.md index 9682c8cb5689b84da154ba64ebc8df7f368e5d16..4b1925f0835b9e25f49ec729544a57bf7c79aec3 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,72 @@ # Lab-OS-Python +This is a boilerplate that replicates the exercise done in the [Lab-OS-CLI](https://githepia.hesge.ch/lsds/teaching/bachelor/cloud-and-deployment/lab-os-cli). +## NAME +**lab-os** - Python script to manage OpenStack Virtual Machines -## Getting started +## SYNOPSIS +`lab-os.py` [**create**|**destroy**|**start**|**stop**|**snapshot**] -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## DESCRIPTION +`lab-os.py` is a Python script designed to help manage OpenStack Virtual Machines with simple commands. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## OPTIONS -## Add your files +### **create** +Create a new virtual machine. This command returns a unique **ID** that can be used to manage the VM in subsequent commands. -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +### **destroy ID** +Destroy an existing virtual machine using the provided **ID**. -``` -cd existing_repo -git remote add origin https://gitedu.hesge.ch/lsds/teaching/bachelor/cloud-and-deployment/lab-os-python.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitedu.hesge.ch/lsds/teaching/bachelor/cloud-and-deployment/lab-os-python/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +### **start ID** +Start a virtual machine using the provided **ID**. -## Suggestions for a good README +### **stop ID** +Stop a running virtual machine using the provided **ID**. -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +### **snapshot ID** +Create a snapshot of the current state of the virtual machine using the provided **ID**. This command also returns a unique **ID** for the snapshot. -## Name -Choose a self-explaining name for your project. +## EXAMPLES -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +### Create a new virtual machine: +```python +# Run the Python script to create a VM +python lab-os-cli.py create +``` +This will return a unique ID for the newly created virtual machine. -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +### Start a virtual machine: +```python +# Start the virtual machine using the returned ID +python lab-os-cli.py start <ID> +``` +This starts the virtual machine associated with the provided **ID**. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +### Stop a virtual machine: +```python +# Stop the virtual machine using the returned ID +python lab-os-cli.py stop <ID> +``` +This stops the virtual machine associated with the provided **ID**. -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +### Create a snapshot of a virtual machine: +```python +# Create a snapshot using the VM ID +python lab-os-cli.py snapshot <ID> +``` +This creates a snapshot of the virtual machine associated with the provided **ID** and returns a unique **ID** for the snapshot. -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +### Destroy a virtual machine: +```python +# Destroy the virtual machine using the returned ID +python lab-os-cli.py destroy <ID> +``` +This destroys the virtual machine associated with the provided **ID**. -## License -For open source projects, say how it is licensed. +## AUTHOR +Written by Francisco Mendonca. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +## COPYRIGHT +This is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License. diff --git a/lab-os.py b/lab-os.py new file mode 100644 index 0000000000000000000000000000000000000000..eaeb6c624feee34291a6d8b1c265b6359d37b77d --- /dev/null +++ b/lab-os.py @@ -0,0 +1,101 @@ +#!/usr/bin/env python3 + +import logging +import sys + +# Setup logging configuration +def setup_logging(): + logger = logging.getLogger("lab-os-cli") + + # Log format + log_format = "[%(asctime)s] %(levelname)s: %(message)s" + + # Setting log level to DEBUG, this can be changed to INFO, WARNING, ERROR, or CRITICAL as needed + logger.setLevel(logging.DEBUG) + + # Create a stream handler to output logs to console + handler = logging.StreamHandler(sys.stdout) + handler.setLevel(logging.DEBUG) + handler.setFormatter(logging.Formatter(log_format)) + + # Add handler to logger + logger.addHandler(handler) + + return logger + +# Initialize the logger +logger = setup_logging() + +# Example function to create a VM +def create_vm(): + logger.info("Creating a new virtual machine...") + # Simulate the process of creating a VM + vm_id = "vm-12345" # This would be generated dynamically + logger.debug(f"Generated VM ID: {vm_id}") + return vm_id + +# Example function to start a VM +def start_vm(vm_id): + logger.info(f"Starting VM with ID: {vm_id}...") + # Simulate the process of starting a VM + logger.debug(f"VM {vm_id} started successfully.") + +# Example function to stop a VM +def stop_vm(vm_id): + logger.info(f"Stopping VM with ID: {vm_id}...") + # Simulate the process of stopping a VM + logger.debug(f"VM {vm_id} stopped successfully.") + +# Example function to destroy a VM +def destroy_vm(vm_id): + logger.info(f"Destroying VM with ID: {vm_id}...") + # Simulate the process of destroying a VM + logger.debug(f"VM {vm_id} destroyed successfully.") + +# Example function to create a snapshot +def create_snapshot(vm_id): + logger.info(f"Creating snapshot for VM with ID: {vm_id}...") + # Simulate the process of creating a snapshot + snapshot_id = "snap-67890" # This would be generated dynamically + logger.debug(f"Generated snapshot ID: {snapshot_id}") + return snapshot_id + +# Main function to simulate command-line arguments +if __name__ == "__main__": + if len(sys.argv) < 2: + logger.error("No command provided. Use 'create', 'start', 'stop', 'destroy', or 'snapshot'.") + sys.exit(1) + + command = sys.argv[1] + + if command == "create": + vm_id = create_vm() + logger.info(f"VM created with ID: {vm_id}") + elif command == "start": + if len(sys.argv) < 3: + logger.error("Please provide a VM ID to start.") + sys.exit(1) + vm_id = sys.argv[2] + start_vm(vm_id) + elif command == "stop": + if len(sys.argv) < 3: + logger.error("Please provide a VM ID to stop.") + sys.exit(1) + vm_id = sys.argv[2] + stop_vm(vm_id) + elif command == "destroy": + if len(sys.argv) < 3: + logger.error("Please provide a VM ID to destroy.") + sys.exit(1) + vm_id = sys.argv[2] + destroy_vm(vm_id) + elif command == "snapshot": + if len(sys.argv) < 3: + logger.error("Please provide a VM ID to create a snapshot.") + sys.exit(1) + vm_id = sys.argv[2] + snapshot_id = create_snapshot(vm_id) + logger.info(f"Snapshot created with ID: {snapshot_id}") + else: + logger.error(f"Unknown command: {command}. Use 'create', 'start', 'stop', 'destroy', or 'snapshot'.") + sys.exit(1)