From 69180355be251c377dedf21a01ebe4fa4dc2abd2 Mon Sep 17 00:00:00 2001 From: Chris Martin Date: Sun, 27 Jan 2019 14:27:29 -0600 Subject: [PATCH 1/2] Add docker-compose as dependency and fix broken links --- docs/developing_lagoon/index.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/developing_lagoon/index.md b/docs/developing_lagoon/index.md index 84373c7703..effe584ef8 100644 --- a/docs/developing_lagoon/index.md +++ b/docs/developing_lagoon/index.md @@ -6,6 +6,10 @@ Development of Lagoon happens locally via Docker. We are using the new [Docker M Please check the [official Docs of Docker](https://docs.docker.com/engine/installation/) how to install Docker. +## On Linux Install Docker Compose + +Docker compose is included in Docker for Mac installations. For linux installations see the directions here: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/). + ## Start Services 1. Add `192.168.99.0/24` to insecure registries in Docker (see [here](https://docs.docker.com/registry/insecure/) how to do that). Also make sure that you give your Docker Host minimum 4 CPUs and 4GB Ram. @@ -41,7 +45,7 @@ make logs make tests ``` -6. Look what happens in OpenShift: [https://192.168.99.100:8443/console]() (developer/developer) +6. Look what happens in OpenShift: [https://192.168.99.100:8443/console](https://192.168.99.100:8443/console) (developer/developer) ## Local Development @@ -78,7 +82,7 @@ Some ISPs set up a "search domain" to catch domain name errors. Virtualbox will into minishift which can cause domain resolution errors in the openshift pods. To check for this problem, look at the `/etc/resolv.conf` in your failing pod and check for errant search domains. -![OpenShift pod resolver settings](/images/pod_search_domains.jpg) +![OpenShift pod resolver settings](../images/pod_search_domains.jpg) To fix, you must remove the extra search domain. Login to the minishift vm (`minishift ssh`) and remove the setting from `/etc/resolv.conf`. Restart openshift docker, `sudo docker restart origin`. From f3a8fbf9c9c11517002f70cf2028ae594231e7f7 Mon Sep 17 00:00:00 2001 From: Chris Martin Date: Sun, 27 Jan 2019 14:36:21 -0600 Subject: [PATCH 2/2] Adjust heading sizes for better experience on make docs --- docs/developing_lagoon/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developing_lagoon/index.md b/docs/developing_lagoon/index.md index effe584ef8..21cb6ba3b7 100644 --- a/docs/developing_lagoon/index.md +++ b/docs/developing_lagoon/index.md @@ -6,7 +6,7 @@ Development of Lagoon happens locally via Docker. We are using the new [Docker M Please check the [official Docs of Docker](https://docs.docker.com/engine/installation/) how to install Docker. -## On Linux Install Docker Compose +### On Linux Install Docker Compose Docker compose is included in Docker for Mac installations. For linux installations see the directions here: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/). @@ -61,7 +61,7 @@ The services not only share many node packages, but also share actual custom cod The API uses a puppet compatible yaml format to store it's data. On production this hiera is in another git repository. For local development there is a folder `local-hiera` which contains testdata that is used during development and testing, plus has no client related data in them. For easier development there is `local-hiera-watcher-pusher` which watches the `local-hiera` folder and on every changes pushes the changes into `local-git-server` which emulates a git server like it is on production. The api service is connecting to this local git server and updates it's data from it. -### Troubleshooting +## Troubleshooting **I can't build any docker image for any Node.js based service**