Skip to content

Commit 55acecf

Browse files
kambiz-aghaiepourgerritforge-inc
authored andcommitted
Merge "Update docs for --mod-cloud."
2 parents f20a785 + 2674bc3 commit 55acecf

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ QUADS automates the future scheduling, end-to-end provisioning and delivery of b
5252
* [Removing a Host from QUADS](#removing-a-host-from-quads)
5353
* [Using the QUADS JSON API](#using-the-quads-json-api)
5454
* [Additional Tools and Commands](#additional-tools-and-commands)
55+
* [Modifying Cloud-level Attributes](#modifying-cloud-level-attributes)
5556
* [Looking into the Future](#looking-into-the-future)
5657
* [Dry Run for Pending Actions](#dry-run-for-pending-actions)
5758
* [Find Free Cloud Environment](#find-free-cloud-environment)
@@ -585,6 +586,8 @@ if you need to clear the vlan association with your cloud, rerun your command an
585586
quads-cli --define-cloud cloud03 --description "Messaging AMQ" --force --cloud-owner epresley --cc-users "jdoe jhoffa" --cloud-ticket 423625 --qinq 1
586587
```
587588

589+
* Note: in QUADS `1.1.4` you can change any of these values selectively via the `--mod-cloud` command [described below](#modifying-cloud-level-attributes).
590+
588591
- Now that you've defined your new cloud you'll want to allocate machines and a schedule.
589592
- We're going to find the first 20 Dell r620's and assign them as an example.
590593

@@ -846,6 +849,26 @@ Removed: {'host': 'f03-h30-000-r720xd.rdu2.example.com'}
846849

847850
## Additional Tools and Commands
848851

852+
### Modifying Cloud-level Attributes
853+
* You can re-define or change any aspects of an already-defined cloud starting in `1.1.4` with the `--mod-cloud` command.
854+
* This can be done a per-parameter or combined basis:
855+
856+
```
857+
quads-cli --mod-cloud cloud02 --cloud-owner jhoffa
858+
```
859+
860+
```
861+
quads-cli --mod-cloud cloud04 --cc-users "tpetty fmercury"
862+
```
863+
864+
```
865+
quads-cli --mod-cloud cloud06 --vlan 604 --wipe
866+
```
867+
868+
```
869+
quads-cli --mod-cloud cloud50 --no-wipe
870+
```
871+
849872
### Looking into the Future
850873
* Because QUADS knows about all future schedules you can display what your environment will look like at any point in time using the `--date` command.
851874

@@ -948,6 +971,8 @@ quads-cli --ls-hosts --filter "interfaces.mac_address==ac:1f:6b:2d:19:48"
948971
## Interacting with MongoDB
949972
* In some scenarios you may wish to interrogate or modify values within MongoDB. You should be careful doing this and have good backups in place. Generally, we will try to implement data, object and document modification needs through quads-cli so you don't need to do this but sometimes it's useful for troubleshooting or other reasons.
950973

974+
* **NOTE**: For most of the below examples usage of `quads-cli --mod-cloud` supplants the need for making any changes in MongoDB post QUADS version `1.1.4`. We'll leave these examples below for posterity or in the case they can be modeled to do something else useful otherwise.
975+
951976
* Example: Toggling the `wipe:` cloud value that determines whether new systems entering an environment should be reprovisioned or not. In this example `cloud02` has the value of `wipe: 0` and we want to change this within Mongodb.
952977

953978
- First run `mongo` to enter cli mode

0 commit comments

Comments
 (0)