WIP: Doc updates for Create VCH Wizard #1259
Conversation
There was a problem hiding this comment.
Feedback on Compute Capacity (it's basically just the same comment, applied in a few places).
|
|
||
| #### Create VCH Wizard | ||
|
|
||
| In the **CPU** text box, leave the default value of `Unlimited`, or optionally enter a limit of between 1 and 9779 MHz. |
There was a problem hiding this comment.
9779 MHz
I don't think this is a global maximum; I suspect this was just the maximum on the system you were looking at, for the cluster/resource pool you had selected.
Perhaps "between 1 and 9779 MHz" could be re-written as "between the minimum and maximum shown" or something along those lines.
There was a problem hiding this comment.
Fixed as per your suggestion.
|
|
||
| `--cpu`, no short name | ||
|
|
||
| Specify a CPU limit value of between 1 and 9779 MHz. If not specified, `vic-machine create` sets the limit to 0 (unlimited). |
There was a problem hiding this comment.
between 1 and 9779 MHz
I don't think this applies to the CLI.
|
|
||
| #### Create VCH Wizard | ||
|
|
||
| In the **Memory** text box, leave the default value of `Unlimited`, or optionally enter a limit of between 1 and 21765 MB. |
There was a problem hiding this comment.
As above; the minimum/maximum values shown in the UI are based on choices the user made earlier in the wizard.
|
|
||
| `--memory`, `--mem` | ||
|
|
||
| Specify a limit of between 1 and 21765 MB. If not specified, `vic-machine create` sets the limit to 0 (unlimited). |
There was a problem hiding this comment.
As above; I don't think we provide minimum/maximum guidance for the CLI.
| #### Create VCH Wizard | ||
|
|
||
| 1. Expand **Advanced**. | ||
| 2. In the **CPU reservation** text box, leave the default value of 1, or optionally enter a limit of between 1 and 9779 MHz. |
|
|
||
| `--cpu-reservation`, `--cpur` | ||
|
|
||
| Specify a limit of between 1 and 9779 MHz. If not specified, `vic-machine create` sets the reservation to 1. |
| #### Create VCH Wizard | ||
|
|
||
| 1. Expand **Advanced**. | ||
| 2. In the **Memory reservation** text box, leave the default value of 1, or optionally enter a limit of between 1 and 21153 MB. |
|
|
||
| `--memory-reservation`, `--memr` | ||
|
|
||
| Specify a limit of between 1 and 21153 MB. If not specified, `vic-machine create` sets the reservation to 1. |
| #### Create VCH Wizard | ||
|
|
||
| 1. Expand **Advanced**. | ||
| 2. In the **Memory** text box, leave the default value of 2048 MB, or enter a value of between 1 and 21765 MB. |
|
|
||
| `--endpoint-memory `, no short name | ||
|
|
||
| Specify a value of between 1 and 21765 MB. If not specified, `vic-machine create` sets memory to 2048 MB. |
| 4. Click **Finish** to deploy the VCH. | ||
| 5. In the **Virtual Container Hosts** tab, click the **>** icon next to the new VCH to follow its deployment progress. | ||
|
|
||
| At the end of a successful deployment, the deployment log shows connection details for this VCH, and a success message. |
There was a problem hiding this comment.
Wizard-based deployments don't show connection details as a part of the deployment log (but that information is available in the list view/table).
There was a problem hiding this comment.
Changed to "At the end of a successful deployment, you can see the connection details for this VCH in the Virtual Container Hosts view."
|
|
||
| ## Example `vic-machine` Commmand <a id="example"></a> | ||
| Specify a value in GB or MB. If not specified, `vic-machine create` sets the image size to 8 MB. |
There was a problem hiding this comment.
... sets the image size to 8 MB.
This should be 8 GB.
There was a problem hiding this comment.
Virtual Container Host Storage Capacity - the main page LGTM. The Specify Volume Datastores sub-topic is pending review from @matthewavery.
|
|
||
| If you specify `--tls-cname`, you can optionally specify `--organization`. If not specified, `vic-machine create` uses the name of the VCH as the `organization` value. | ||
|
|
||
| **NOTE**: If you specify a static IP address on the client network, the `client-ip-address` is used for `CommonName` but not for `Organisation`. |
There was a problem hiding this comment.
Organisation
nit-pick: should be Organization
There was a problem hiding this comment.
Fixed. Old British English habits die hard....
|
Thanks @zjs and @anchal-agrawal. I integrated your comments. All good now? |
|
Spent some time reading it, Looks good! I did not see anything that needs changing. |
|
Thanks @matthewavery @zjs @anchal-agrawal @AngieCris @hmahmood @lcastellano @lgayatri @alextopuzov ! Finally merging. |
Updating and reorganizing the docs for VCH creation to include the new Create VCH wizard.
Introducing the Create VCH Wizard has led me to completely reorganize and redo how we document VCH creation, in such as way as both the wizard and the CLI methods are documented, but avoiding duplication of information that is applicable to both methods.
This is a big reorg, so I think that the best bet is to review the generated HTML content on github.io rather than in this PR. And also probably in chunks.
The whole of the Deploy VCHs chapter has been reorg'd.
https://stuclem.github.io/vic-product/assets/files/html/1.3/vic_vsphere_admin/deploy_vch.html
TBD: Add table of topics/reviewers, and add the list of issues fixed in this PR.