Merge "Adding mock-detached util function and cleaning up util help output"
[apex.git] / docs / installation-instructions / verification.rst
index a574c31..0ff5632 100644 (file)
@@ -1,22 +1,25 @@
 Verifying the Setup
 -------------------
 
-Once the deployment has finished, the OPNFV deployment can be accessed via the Instack node. From
-the jump host ssh to the instack host and become the stack user. Alternativly ssh keys have been
-setup such that the root user on the jump host can ssh to Instack directly as the stack user.
-
-| ``ssh root@192.0.2.1``
+Once the deployment has finished, the OPNFV deployment can be accessed via the Undercloud node. From
+the jump host ssh to the Undercloud host and become the stack user. Alternativly ssh keys have been
+setup such that the root user on the jump host can ssh to Undercloud directly as the stack user. For
+convenience a utility script has been provided to look up the undercloud's ip address and ssh to the
+undercloud all in one command. An optional user name can be passed to indicate whether to connect as
+the stack or root user. The stack user is default if a username is not specified.
+
+| ``opnfv-util undercloud root``
 | ``su - stack``
 
-Once connected to Instack as the stack user look for two keystone files that can be used to
+Once connected to Undercloud as the stack user look for two keystone files that can be used to
 interact with the undercloud and the overcloud. Source the appropriate RC file to interact with
 the respective OpenStack deployment.
 
-| ``source stackrc`` (undercloud / Instack)
-| ``source overcloudrc`` (overcloud / OPNFV)
+| ``source stackrc`` (Undercloud)
+| ``source overcloudrc`` (Overcloud / OPNFV)
 
-The contents of these files include the credentials for the administrative user for Instack and
-OPNFV respectivly. At this point both Instack and OPNFV can be interacted with just as any
+The contents of these files include the credentials for the administrative user for Undercloud and
+OPNFV respectivly. At this point both Undercloud and OPNFV can be interacted with just as any
 OpenStack installation can be. Start by listing the nodes in the undercloud that were used
 to deploy the overcloud.