Added instructions to start the dev envornment
Change-Id: I8bd87cd52b7e94fb56ff2a84dad20119bd5e3e24
diff --git a/frontend/Makefile b/frontend/Makefile
index 217c09d..7640cb0 100644
--- a/frontend/Makefile
+++ b/frontend/Makefile
@@ -78,9 +78,15 @@
ps:
sudo docker-compose ps
-enter-xos:
+enter-ui:
sudo docker exec -ti frontend_xos_ui_1 bash
+enter-bootstrap-ui:
+ sudo docker exec -ti frontendbs_xos_bootstrap_ui_1 bash
+
+enter-db:
+ sudo docker exec -ti frontendbs_xos_db_1 bash
+
django-restart:
sudo docker exec frontend_xos_ui_1 touch /opt/xos/xos/settings.py
diff --git a/frontend/README.md b/frontend/README.md
index 7e2ef02..17f2626 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -5,14 +5,27 @@
## Getting Started
-- Navigate to `/xos/configurations/frontend` folder
+- Navigate to `/service-profile/configurations/frontend` folder
- Run `make` command
You'll be able to visit XOS at `0.0.0.0:9000` and the `xos/core/xoslib` folder is shared with the container. This means that any update to that folder is automatically reported in the container.
-If you need to work on the Django application itself, comment out the "sleep" command
-for the `xos` container in docker-compose.yml and run `make`. Once the containers are
-up then type `make enter` to enter the running container.
+### Working on the Django Application
+If you need to work on the Django application itself:
+- comment out the `sleep 86400` command for the `xos_bootstrap_ui` container in `docker-compose-bootstrap.yml`
+- comment the `python /opt/xos/manage.py runserver 0.0.0.0:9998 --insecure --makemigrations` in the same file
+- run `make containers`.
+- run `make`
+
+You'll notice that the `make` command will hang on to `Waiting for XOS to start listening on port 9998`, so in another shell:
+- run `make enter-bootstrap-ui`, this will bring you inside the running bootstrap container
+- from inside the bootstrap container run `python /opt/xos/manage.py runserver 0.0.0.0:9998 --insecure --makemigrations`
+
+As this command finish his execution you'll notice that the `make` command will resume and end. Once it has endend your development environment is up and running.
+
+If you are working on core files (not involving services) you can use the `bootstrap_ui` container as target, so connect to port `9998`. To simplify the development `xos/core` and `xos/api/utility` folders are shared between the host filesystem and the container, so you don't have to manually copy file inside the the running `bootstrap_ui` container.
+
+If instead you are working on services or services API your target container should be the `ui` container, so connect to port `9999`. Note that the `ui` container can be rebuilt from the `synchronizer` container, and it will pull the container in the docker registry, not your local one.
> _NOTE:
> Please be careful and do not commit migrations, private keys or other autogenerated files._
@@ -20,13 +33,15 @@
### Using Vagrant
-Vagrant environment is provided with a ubuntu_14.04 box (ubuntu/trusty64). It will run xos on the following address `192.168.46.100:9999'.
-It also provide a shared folder between host machine (root folder of xos repository) and ubuntu client(/opt/xos).
+Vagrant environment is provided with a ubuntu_14.04 box (ubuntu/trusty64).
-Start the Vagrant box : vagrant up --provision
-SSH details : ssh vagrant@127.0.0.1 -p 2222
-password: vagrant
-Check status: vagrant global-status
+It will run xos on the following address `192.168.46.100:9999`.
+It will also share the `service-profile` and `xos` folder with the vagrant box. These two directory are intended to be side by side.
+
+How to set it up:
+- Start the Vagrant box: `vagrant up`
+- Enter Vagrant box: `vagrant ssh`
+- Start XOS: `cd /opt/service-profile/frontend` and run `make`
### Docker Helpers
diff --git a/frontend/Vagrantfile b/frontend/Vagrantfile
index 796977e..38b2a92 100644
--- a/frontend/Vagrantfile
+++ b/frontend/Vagrantfile
@@ -15,6 +15,4 @@
vb.customize ['modifyvm', :id,'--memory', '4096']
end
- # make the frontend config
- config.vm.provision "shell", inline: "cd /opt/service-profile/frontend/ && make"
end
diff --git a/frontend/docker-compose-bootstrap.yml b/frontend/docker-compose-bootstrap.yml
index 942c105..f2055fc 100644
--- a/frontend/docker-compose-bootstrap.yml
+++ b/frontend/docker-compose-bootstrap.yml
@@ -5,6 +5,7 @@
xos_bootstrap_ui:
image: xosproject/xos
+ # command: sleep 86400
command: python /opt/xos/manage.py runserver 0.0.0.0:9998 --insecure --makemigrations
environment:
- CONFIG_DIR
@@ -16,11 +17,12 @@
- ../common/xos_common_config:/opt/xos/xos_configuration/xos_common_config
- ../cord-pod/files/xos_vtn_config:/opt/xos/xos_configuration/xos_vtn_config:ro
- ../../xos_services:/opt/xos_services
+ - ../../xos/xos/api/utility:/opt/xos/api/utility
+ - ../../xos/xos/core:/opt/xos/core
xos_synchronizer_onboarding:
image: xosproject/xos-synchronizer-onboarding
command: bash -c "cd /opt/xos/synchronizers/onboarding; ./run.sh"
-# command: sleep 86400
labels:
org.xosproject.kind: synchronizer
org.xosproject.target: onboarding