Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit c926f9c

Browse files
authored
docs: No longer recommend that devs use devstack in a virtualenv (#1080)
The only thing that most developers use from the devstack requirements file is docker-compose, and that's already provided by a Docker installation on some operating systems. So just change the Docker installation instructions to mention docker-compose, and then drop virtualenvs from the getting started and main workflow docs. This commit does not change `docs/developing_on_named_release_branches.rst` as that file is for an uncommon use-case. Removing virtualenv instructions from that file would require getting multi-devstack set up in the first place and then removing all the virtualenv referenves from the scripts that are laid out in the doc. If it's worth doing that, it's best done by someone who already uses those instructions. Issue: #1076
1 parent 7f44faa commit c926f9c

2 files changed

Lines changed: 4 additions & 17 deletions

File tree

docs/getting_started.rst

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ You will need to have the following installed:
88

99
- make
1010
- Python 3.8
11-
- Docker
11+
- Docker, including ``docker-compose``
1212

1313
This project requires **Docker 17.06+ CE**. We recommend Docker Stable, but
14-
Docker Edge should work as well.
14+
Docker Edge should work as well. Ensure that your Docker installation includes
15+
``docker-compose``; on some operating systems (e.g. Ubuntu Linux) this may require
16+
a separate package.
1517

1618
**NOTE:** Switching between Docker Stable and Docker Edge will remove all images and
1719
settings. Don't forget to restore your memory setting and be prepared to
@@ -50,25 +52,13 @@ You should run all ``make`` commands described below on your local machinge, *no
5052
from within a Virtual Machine, as these commands are meant to stand up a VM-like environment using
5153
Docker containers.
5254

53-
However, you may want to run the ``make`` commands from within a Python 3 virtual
54-
environment. This will keep the Python packages required for Devstack separate from
55-
the ones installed globally on your system.
56-
5755
Directions to setup devstack
5856
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5957

6058
The default devstack services can be run by following the steps below.
6159

6260
**Note:** This will set up a large number of services, more than you are likely to need to work with, but that's only necessary for first-time provisioning. See :doc:`service_list` and the :doc:`most common development workflow <workflow>` for how to run and update devstack with just the services you need, rather than the ``large-and-slow`` default set.
6361

64-
#. Install the requirements inside of a `Python virtualenv`_.
65-
66-
.. code:: sh
67-
68-
make requirements
69-
70-
This will install docker-compose and other utilities into your virtualenv.
71-
7262
#. The Docker Compose file mounts a host volume for each service's executing
7363
code. The host directory defaults to be a sibling of this directory. For
7464
example, if this repo is cloned to ``~/workspace/devstack``, host volumes
@@ -170,5 +160,3 @@ This data collection is behind a consent flag, so please help devstack's maintai
170160
make metrics-opt-in
171161
172162
Now that you're up and running, read about the :doc:`most common development workflow <workflow>`.
173-
174-
.. _Python virtualenv: https://docs.python-guide.org/en/latest/dev/virtualenvs/#lower-level-virtualenv

docs/workflow.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ These instructions are written using the LMS as an example. Replace ``lms`` with
1111

1212
- Make sure your IDA's repo is checked out to the commit you want to use for development, and that that commit is based on an up to date branch, so that it matches the disk images devstack will pull.
1313

14-
#. Activate your devstack virtualenv. See the main Getting Started instructions if you don't already have one.
1514
#. Launch your service in a clean state:
1615

1716
#. Run ``make dev.remove-containers dev.pull.lms dev.up.lms`` to halt any running services and remove their containers, pull the latest disk images, and launch your service.

0 commit comments

Comments
 (0)