Setting up local deconst#

This document takes you through the instructions for setting up deconst on your local machine.

For more information on the Deconst staging, see the Deconst README.

Installing deconst#

  1. Install Docker for Mac from the Managed Software Center.

  2. Test everything is installed:

    docker --version
    docker-compose --version
    docker-machine --version
    

    Each command should return with the appropriate version numbers. For example, Docker version 17.03.1-ce, build c6d412e.

  3. Create a new folder for your tool work. For example, Users/alex7376/Tools.

  4. Download Kitematic: https://github.com/docker/kitematic/releases .. note:

    We use Kitematic for simplicity and a GUI-wrapped way of managing
    containers. However, this is  a beta product.
    
  5. Install the Docker Toolbox for Mac: https://docs.docker.com/toolbox/toolbox_install_mac/

  6. Fork and clone the deconst/integrated repo into your Tools folder: https://github.com/deconst/integrated/

  7. Fork and clone the nexus-control repo into your Tools folder: https://github.com/rackerlabs/nexus-control

  8. Fork and clone docs-rpc and/or rackspace-how-to:

    Note

    You can use any content repo, and here are some sample ones to use

  9. In your clone of deconst/integrated, rename env.example to env and change the following lines:

    • Line 12: enter the value 1111 after the equal sign.
    • Line 16: change deconst.horse to support.rackspace.com or developer.rackspace.com.
    • Line 30: enter the path to your nexus-control repo clone (e.g., /Users/laur0616/nexus-control).
    • Line 66: enter “true” (with quotes) after the equal sign.
  10. Open your terminal with two tabs or windows.

  11. In both windows, navigate to the deconst/integrated directory.

  12. In one terminal, run script/up. You will see deconst running with debugging turned up to full.

  13. Once that terminal has stopped loading, leave it running. In the other terminal, run the following commands in order:

    1. script/add-assets <path-to-nexus-control> (e.g., script/add-assets ~/nexus-control)
    2. script/add-<type> <path-to-content-repo> (e.g., script/add-jekyll ~/rackspace-how-to/ or script/add-sphinx ~/docs-rpc/)
  14. Refresh Kitematic to see your containers. Click “View” and then “Refresh Container List”.

  15. You should now be able to go to localhost/<repo-link> (e.g., localhost/how-to/ or localhost/docs/private-cloud/rpc/v14/) in your browser to see the delivered content.

Additional information#

If you change the control repo, run script/refresh in the same terminal window where you ran script/add-assets. If that does not work, you can restart everything in one of two ways:

  1. Use the terminal to stop all containers. Use the second terminal window, and run the following command to stop all containers:
docker stop $(docker ps -a -q)
  1. Use Kitematic to stop all containers. You must stop each container, not restart it. Deconst needs to go up all at once to work properly.