OpenStack Cloud Rescue

Open source cloud image for rescuing cloud instances on OpenStack platforms.
Explore the docs »

Report Bug · Request Feature

About The Project

This cloud-ready image is based on Ubuntu 22.04 LTS. On top of the base operating system, this image integrates several troubleshooting packages such as curl, dnsutils, ncdu, mdadm and more. This image is primarily meant to be used with OpenStack's rescue mode.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

How to use this image

1. Set your OpenStack environment variables

2. Download the latest image from release page

3. Upload image to your OpenStack environment

   openstack image create --disk-format=qcow2 --container-format=bare --file cloud-rescue-<VERSION>-x86_64.qcow2  'OpenStack Cloud Rescue'

4. Start your instance in rescue mode, specifying the rescue image id

   openstack server rescue --image RESCUE_IMAGE_ID INSTANCE_ID

   If you want to use password authentication, add --password

   openstack server rescue --image RESCUE_IMAGE_ID --password YOUR_PASSWORD INSTANCE_ID

5. You can now logging via SSH (with public key or password) or VNC console.
   The default user is rescue-user

6. Once done, turn off rescue mode

   openstack server unrescue INSTANCE_ID
   

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

(back to top)

Contact

Kevin Allioli - @linit_io - kevin@linit.io

Project Link: https://github.com/linitio/openstack-cloud-rescue-image

(back to top)