Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README doc for new argument skip-snapshot. #28

Merged
merged 1 commit into from
Sep 22, 2023
Merged

Update README doc for new argument skip-snapshot. #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,20 @@ $ export PATH=$PATH:$(python3 -m site --user-base)/bin
## Usage ##

```
$ gce-rescue --help

USAGE: gce-rescue [flags]
flags:

./gce-rescue.py:
--[no]debug: Print to the log file in debug level.
(default: 'false')
--[no]force: Don't ask for confirmation.
(default: 'false')
--name: Instance name.
--project: The project-id that has the instance.
--zone: Zone where the instance is created.

Try --helpfull to get a list of all flags.
gce-rescue --help
usage: gce-rescue [-h] [-p PROJECT] -z ZONE -n NAME [-d] [-f] [--skip-snapshot]

GCE Rescue v0.4-beta - Set/Reset GCE instances to boot in rescue mode.

optional arguments:
-h, --help show this help message and exit
-p PROJECT, --project PROJECT
The project-id that has the instance.
-z ZONE, --zone ZONE Zone where the instance is created.
-n NAME, --name NAME Instance name.
-d, --debug Print to the log file in debug leve
-f, --force Don't ask for confirmation.
--skip-snapshot Skip backing up the disk using a snapshot.
```

- ### --zone ###
Expand All @@ -87,8 +86,12 @@ Try --helpfull to get a list of all flags.
- If provided, the log output will be set to DEBUG level. (OPTIONAL)
- The log file will be created on ./ containing the VM name and timestamp on the name, that can be used to help to troubleshoot failed executions as well as to manually recover the instance's original configuration, if necessary.

- > The log files contain important information about the initial state of the VM instance that may be required to manually restore it.

> The log files contain important information about the initial state of the VM instance that may be required to manually restore it.

- ### --skip-snapshot ###
- Skip the snapshot creation. (OPTIONAL)
- Before setting your instance in rescue mode, GCE Rescue will always create a snapshot of your boot disk before taking any action. For some users this might be time consuming and not always necessary. Use this argument if you want to skip this step.

---

Expand Down
Loading