Skip to content

Commit

Permalink
Adding info about reinitializing the appliance (#852)
Browse files Browse the repository at this point in the history
* Adding info about reinitializing the appliance

* Comments from Anchal on reinit

* Added link to wrapper topic.

* More info about retagging appliance VM.

* Beefed up the warning against clicking reinit

* Reverted warning about pressing reinit button

* Removed references to topic on registering with different PSC.

* Deleted PSC topic (kept backup copy for later use)
  • Loading branch information
stuclem authored Sep 29, 2017
1 parent 2ac6a96 commit 58f6e96
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/user_doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
* [Upgrade Plug-In VCSA](vic_vsphere_admin/upgrade_h5_plugin_vcsa.md)
* [Managing the Appliance](vic_vsphere_admin/manage_appliance.md)
* [Reconfigure the Appliance](vic_vsphere_admin/reconfigure_appliance.md)
* [Reinitialize the Appliance](vic_vsphere_admin/reinitialize_appliance.md)
* [Re-Tag the Appliance](vic_vsphere_admin/retag_appliance.md)
* [Check Service Status](vic_vsphere_admin/service_status.md)
* [Restart Services](vic_vsphere_admin/restart_services.md)
* [Troubleshooting](vic_vsphere_admin/troubleshoot_vic.md)
Expand Down
4 changes: 3 additions & 1 deletion docs/user_doc/vic_vsphere_admin/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,10 @@
* [Upgrade Plug-In VCSA](upgrade_h5_plugin_vcsa.md)
* [Managing the Appliance](manage_appliance.md)
* [Reconfigure the Appliance](reconfigure_appliance.md)
* [Reinitialize the Appliance](reinitialize_appliance.md)
* [Re-Tag the Appliance](retag_appliance.md)
* [Check Service Status](service_status.md)
* [Restart Services](restart_services.md)
* [Restart Services](restart_services.md)
* [Troubleshooting](troubleshoot_vic.md)
* [Access Log Bundles](log_bundles.md)
* [VCH Deployment Times Out](ts_vch_deployment_timeout.md)
Expand Down
11 changes: 4 additions & 7 deletions docs/user_doc/vic_vsphere_admin/deploy_vic_appliance.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,14 @@ You install vSphere Integrated Containers by deploying a virtual appliance. The

11. In a browser, go to http://<i>vic_appliance_address</i> and enter the address and single sign-on credentials of the vCenter Server instance on which you deployed the appliance.

**IMPORTANT**: The installation process requires the single sign-on credentials to register vSphere Integrated Containers Management Portal and Registry with the Platform Services Controller. The vSphere Integrated Containers Management Portal and Registry services cannot start if you do not complete this step.
**IMPORTANT**: The installation process requires the single sign-on credentials to register vSphere Integrated Containers Management Portal and Registry with the Platform Services Controller and to tag the appliance VM for use in Docker content trust. The vSphere Integrated Containers Management Portal and Registry services cannot start if you do not complete this step.

**Result**

- You see the vSphere Integrated Containers Getting Started page at http://<i>vic_appliance_address</i>. The Getting Started page includes links to the vSphere Integrated Containers Management Portal, the Demo VCH Installer Wizard, the download for the vSphere Integrated Containers Engine bundle, and to documentation.
- If you see the error `Failed to register with PSC. Please check the vSphere user domain PSC settings and try again`, see the procedure in [vSphere Integrated Containers Appliance Fails to Register with PSC](ts_register_psc_fails.md) to register vSphere Integrated Containers with the Platform Services Controller.
- If the initialization fails with any other error, see [Reinitialize the vSphere Integrated Containers Appliance](reinitialize_appliance.md). You should not reinitialize the appliance in any circumstances other than those described in that topic.


**What to Do Next**

Expand All @@ -107,9 +109,4 @@ Access the different vSphere Integrated Containers components from the vSphere

- To remove security warnings when you connect to the Getting Started page or management portal, see [Obtain the Thumbprints and CA Files of the vSphere Integrated Containers Appliance Certificates](obtain_appliance_certs.md) and [Verify and Trust vSphere Integrated Containers Appliance Certificates](../vic_cloud_admin/trust_vic_certs.md).
- If you see a certificate error when you attempt to go to http://<i>vic_appliance_address</i>, see [Browser Rejects Certificates with `ERR_CERT_INVALID` Error](ts_cert_error.md).
- If necessary, you can reconfigure the appliance after deployment by editing the settings of the appliance VM. For information about reconfiguring the appliance, see [Reconfigure the vSphere Integrated Containers Appliance](reconfigure_appliance.md).





- If necessary, you can reconfigure the appliance after deployment by editing the settings of the appliance VM. For information about reconfiguring the appliance, see [Reconfigure the vSphere Integrated Containers Appliance](reconfigure_appliance.md).
1 change: 1 addition & 0 deletions docs/user_doc/vic_vsphere_admin/manage_appliance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
This section provides information about how to manage your vSphere Integrated Containers appliance.

* [Reconfigure the vSphere Integrated Containers Appliance](reconfigure_appliance.md)
* [Reinitialize the Appliance](reinitialize_appliance.md)
* [Check the Status of the vSphere Integrated Containers Services](service_status.md)
* [Restart the vSphere Integrated Containers Services](restart_services.md)
15 changes: 15 additions & 0 deletions docs/user_doc/vic_vsphere_admin/reinitialize_appliance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Reinitialize the vSphere Integrated Containers Appliance

After you power on the vSphere Integrated Containers appliance for the first time, you are prompted to enter the vCenter Server credentials and Platform Services Controller settings. This allows the OVA installer to perform two tasks to initialize the appliance:

- Tag the appliance VM for content trust
- Register the appliance with the Platform Services Controller

After initialization, the vSphere Integrated Containers Getting Started page should display a success message at the top of the page. In this case, no action is necessary.

The Getting Started Page includes a button labeled **Re-Initialize the vSphere Integrated Containers Appliance**.

**IMPORTANT**: Only reinitialize the appliance in the following circumstances:

* The initialization of the appliance did not succeed and the Getting Started page includes a red error alert instead of a green success alert. For example, you see the error `Failed to locate VIC Appliance. Please check the vCenter Server provided and try again`.
* You need to re-tag the appliance for Docker content trust. For more information, see [Re-Tag the vSphere Integrated Containers Appliance](retag_appliance.md).
14 changes: 14 additions & 0 deletions docs/user_doc/vic_vsphere_admin/retag_appliance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Re-Tag the vSphere Integrated Containers Appliance #

vSphere Integrated Containers Registry implements Docker content trust to sign images. As such, the vSphere Integrated Containers appliance requires a specific VM tag to identify it as a content trust source.

In some cases, you might need to re-tag the appliance VM, for example if the tag has been accidentally deleted, or if the tagging of the VM failed during the first initialization of the appliance. If the tagging of the VM failed during initialization, you see the error `Failed to locate VIC Appliance. Please check the vCenter Server provided and try again` in the Getting Started page.

**Procedure**

1. In the Hosts and Clusters view of the vSphere Client right-click the OVA VM and select **Tags & Custom Attributes** > **Remove Tag**.
2. Check that the `ProductVM` tag is present in the list of tags and click **Cancel**.
3. If the `ProductVM` tag is missing, go to the vSphere Integrated Containers Getting Started page at http://<i>vic_appliance_address</i>.
4. Scroll to the bottom of the page and click the **Re-Initialize the vSphere Integrated Containers Appliance** button.
5. Enter the vCenter Server address and credentials and click **Continue**.
6. After initialization, check in the vSphere Client that the `ProductVM` tag is present.

0 comments on commit 58f6e96

Please sign in to comment.