From dac2edd9c2638060564df2a0c28fbcb3f1a6b696 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonas=20Kvarnstr=C3=B6m?= <jonas.kvarnstrom@liu.se>
Date: Mon, 12 Apr 2021 09:20:10 +0200
Subject: [PATCH] The lrs_devenv_common repo is already installed by playbooks,
so remove that from the docker instructions. Minor reorganization: No need
for distinct "login" and "install" pages for Docker.
---
README.md | 4 +--
...docker_login.md => docker_devenv_image.md} | 18 ++++++++++--
doc/docker_install.md | 28 -------------------
doc/docker_interfacing.md | 4 +--
4 files changed, 19 insertions(+), 35 deletions(-)
rename doc/{docker_login.md => docker_devenv_image.md} (57%)
delete mode 100644 doc/docker_install.md
diff --git a/README.md b/README.md
index a7c55cd..cc6a558 100644
--- a/README.md
+++ b/README.md
@@ -10,11 +10,9 @@ To install and configure a development environment, follow these steps:
- [Install local software on your development system](doc/install_playbooks.md) using Ansible Playbooks
-- [Log in to the LRS Docker Registry](doc/docker_login.md) using a Deploy Key or Gitlab user/keyword
-
- [Install Nvidia Docker drivers](doc/docker_nvidia.md) if you have an Nvidia graphics card and you are not using a virtual machine
-- [Install the Development Docker Image](doc/docker_install.md) containing the Docker-based Development Environment and the associated LRS modules.
+- [Install the Development Docker Image](doc/docker_devenv_image.md) containing the Docker-based Development Environment and the associated LRS modules
## Interacting with the Development Docker Container
diff --git a/doc/docker_login.md b/doc/docker_devenv_image.md
similarity index 57%
rename from doc/docker_login.md
rename to doc/docker_devenv_image.md
index c99e3e8..c61ee9f 100644
--- a/doc/docker_login.md
+++ b/doc/docker_devenv_image.md
@@ -1,6 +1,10 @@
-# Logging In to the LRS Docker Registry
+# Installing or Updating the Development Environment Image
-A large part of the software for the development environments is made available in Docker images. To access these images you need to log in to our Docker Registry using one of the following methods. (Another page describes how to actually download/pull the relevant Docker image.)
+A large part of the software for the development environments is made available in Docker images. To access these images you need to log in to our Docker Registry using one of the following methods, and then download/pull the relevant Docker image.
+
+## Logging In to the LRS Docker Registry
+
+To log in to the LRS Docker Registry:
- If you have received a Deploy Key from us, use this to log in according to the instructions we specified at that point.
@@ -17,3 +21,13 @@ A large part of the software for the development environments is made available
We are not sure if this option this works for external users. Please test if you are an external user and report back!
If you cannot use either of these methods, please contact us to be given access to the software.
+
+## Pulling the Development Docker Image
+
+Assuming you have followed the [setup instructions](../README.md) step by step, you already have access to the required scripts from the `lrs_devenv_common` repo as well as a number of other prerequisites for downloading the Development Environment image.
+
+To download a new image *or* update your existing image to the latest version, execute the following script on your Development System:
+
+```bash
+wpull
+```
diff --git a/doc/docker_install.md b/doc/docker_install.md
deleted file mode 100644
index c528868..0000000
--- a/doc/docker_install.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# Using LRS Dockers
-
-To install the Docker-based LRS modules, you must first have [logged in to the LRS Docker Registry](doc/docker_login.md) and possibly [installed Nvidia Docker drivers].
-
-Then you should clone the `lrs_devenv_common` repo, which (among other things) contains a number of scripts to be used together with the development environments:
-
-```bash
-git clone git@gitlab.liu.se:lrs/lrs_devenv_common.git
-```
-
-or if you need to specify the `wara_deploy` deploy key to gain access:
-```bash
-GIT_SSH_COMMAND='ssh -i ~/.ssh/wara_deploy -o IdentitiesOnly=yes' git clone git@gitlab.liu.se:lrs/waraps.git
-```
-
-Put the script directory of the `lrs_devenv_common` repo in your `PATH` and add the following variables, for example in .bashrc:
-
-```bash
-export PATH="...../lrs_devenv_common/script:$PATH"
-```
-
-Finally, pull (download) the latest version of the Development Docker Image. You may have to start a new `bash` shell for this to work (scripts such as `wpull` are in the script directory that was just added to your PATH):
-
-```bash
-wpull
-```
-
-If you want to update this image to the latest version, run `wpull` again.
diff --git a/doc/docker_interfacing.md b/doc/docker_interfacing.md
index d27a494..9fecedd 100644
--- a/doc/docker_interfacing.md
+++ b/doc/docker_interfacing.md
@@ -19,11 +19,11 @@ See the following for an overview of the available functionality:
## Scripts
-Since you have [installed the Development Docker Images](docker_install.md), you now have the following scripts in your path. These scripts are intended to be executed directly on the Development System but are used to *interact* with the Docker Container. Concrete examples of using the scripts are given in the next section.
+As long as you have followed the [installation instructions](../README.md) step by step, you now have the following scripts in your path. These scripts are intended to be executed directly on the Development System but are used to *interact* with the Docker Container. Concrete examples of using the scripts are given in the next section.
### wpull
-Pull (update to) the most recent version of the Development Environment docker image. You should already have done this once, but you can do it again if you want to check for (and download) a new version.
+Use `wpull` to pull (update to) the most recent version of the Development Environment docker image. You should already have done this once, but you can do it again if you want to check for (and download) a new version.
The contents of this script:
```bash
--
GitLab