diff --git a/docs/using_lagoon/docker-compose_yml.md b/docs/using_lagoon/docker-compose_yml.md index 44adc9cda1..d7aff0fc40 100644 --- a/docs/using_lagoon/docker-compose_yml.md +++ b/docs/using_lagoon/docker-compose_yml.md @@ -66,7 +66,7 @@ If you don't need to build a Dockerfile and just want to use an existing Dockerf Lagoon needs to know what type of service you are deploying in order to configure the correct Kubernetes and OpenShift Objects. -This is done via the `lagoon.type` label. There are many different types to choose from, check [Service Types](./service_types.md) to see all of them and their additional configuration possibilities. +This is done via the `lagoon.type` label. There are many different types to choose from, check [Service Types](service_types.md) to see all of them and their additional configuration possibilities. #### Skip/Ignore containers @@ -129,7 +129,7 @@ Additionally twice the `lagoon.name: nginx` is defined, which will cause Lagoon If you need some changes on the OpenShift Templates, you can define your own template via `lagoon.template`. Check out the shipped Templates from the [templates folder of `oc-build-deploy-dind`](https://github.com/amazeeio/lagoon/tree/master/images/oc-build-deploy-dind/openshift-templates). Important: The template is called with `oc process`, so you should define the same parameters like in the default templates. -You can also overwrite the templates only for a specific environment, this is done in the [`.lagoon.yml`](/using_lagoon/lagoon_yml.md/#environmentsnametypes) +You can also overwrite the templates only for a specific environment, this is done in the [`.lagoon.yml`](lagoon_yml.md#environmentsnametypes) #### Custom Rollout Monitor Types @@ -140,7 +140,7 @@ By default Lagoon expects that the way services from custom templates are rolled - `daemonset` - expects a `Daemonset` object in the template for the service - `false` - will not monitor any rollouts and just be happy of the template applies and does not throw any errors -You can also overwrite the rollout only for a specific environment, this is done in the [`.lagoon.yml`](/using_lagoon/lagoon_yml.md/#environmentsnamerollouts) +You can also overwrite the rollout only for a specific environment, this is done in the [`.lagoon.yml`](lagoon_yml.md#environmentsnamerollouts) #### Custom Type diff --git a/docs/using_lagoon/index.md b/docs/using_lagoon/index.md index 3cfa71a3c8..18d060dfb3 100644 --- a/docs/using_lagoon/index.md +++ b/docs/using_lagoon/index.md @@ -13,7 +13,7 @@ TL;DR: install and start `pygmy`: gem install pygmy pygmy up -Learn more about Lagoon and [Local Development Environments](./local_development_environments.md) +Learn more about Lagoon and [Local Development Environments](local_development_environments.md) ## Step by Step Guides @@ -27,11 +27,11 @@ Learn more about Lagoon and [Local Development Environments](./local_development ### `.lagoon.yml` -They main file that will be used by Lagoon to understand what should be deployed and many more things. See [Documentation for .lagoon.yml](/using_lagoon/lagoon_yml.md) +They main file that will be used by Lagoon to understand what should be deployed and many more things. See [Documentation for .lagoon.yml](lagoon_yml.md) ### `docker-compose.yml` -This file is used by Docker Compose to start you Local Development environment. Lagoon also uses it to understand which of the Services should be deployed, which type and how to build them. This happens via `labels`. See [Documentation for docker-compose.yml](/using_lagoon/docker-compose_yml.md) +This file is used by Docker Compose to start you Local Development environment. Lagoon also uses it to understand which of the Services should be deployed, which type and how to build them. This happens via `labels`. See [Documentation for docker-compose.yml](docker-compose_yml.md) ### Dockerfiles diff --git a/docs/using_lagoon/lagoon_yml.md b/docs/using_lagoon/lagoon_yml.md index 57887b8d70..b3192c5c58 100644 --- a/docs/using_lagoon/lagoon_yml.md +++ b/docs/using_lagoon/lagoon_yml.md @@ -160,7 +160,7 @@ environments: ``` #### `environments.[name].templates` -The Lagoon Build processes checks the `lagoon.template` label from the `docker-compose.yml` file in order to check if the service needs a custom template file (read more about them in the [documentation of `docker-compose.yml`](/using_lagoon/docker-compose_yml/#custom-templates)) +The Lagoon Build processes checks the `lagoon.template` label from the `docker-compose.yml` file in order to check if the service needs a custom template file (read more about them in the [documentation of `docker-compose.yml`](docker-compose_yml.md#custom-templates)) Sometimes though you would like to override the template just for a single environment and not for all of them: @@ -179,14 +179,14 @@ environments: ``` #### `environments.[name].rollouts` -The Lagoon Build processes checks the `lagoon.rollout` label from the `docker-compose.yml` file in order to check if the service needs a special rollout type (read more about them in the [documentation of `docker-compose.yml`](/using_lagoon/docker-compose_yml/#custom-deploymentconfig-templates)) +The Lagoon Build processes checks the `lagoon.rollout` label from the `docker-compose.yml` file in order to check if the service needs a special rollout type (read more about them in the [documentation of `docker-compose.yml`](docker-compose_yml.md#custom-deploymentconfig-templates)) Sometimes though you would like to override the rollout type just for a single environment, especially if you also overwrote the template type for the environment `service-name: rollout-type` * `service-name` - is the name of the service from `docker-compose.yml` you would like to override -* `rollout-type` - the type of rollout, see [documentation of `docker-compose.yml`](/using_lagoon/docker-compose_yml/#custom-rollout-monitor-types)) for possible values +* `rollout-type` - the type of rollout, see [documentation of `docker-compose.yml`](docker-compose_yml.md#custom-rollout-monitor-types)) for possible values Example: diff --git a/docs/using_lagoon/service_types.md b/docs/using_lagoon/service_types.md index e6b0011999..2b32887e63 100644 --- a/docs/using_lagoon/service_types.md +++ b/docs/using_lagoon/service_types.md @@ -1,6 +1,6 @@ # Service Types -This table lists all service types that can be defined via `lagoon.type` within a [`docker-compose.yml` file](/using_lagoon/docker-compose_yml.md) +This table lists all service types that can be defined via `lagoon.type` within a [`docker-compose.yml` file](docker-compose_yml.md) | Type | Description | Healtcheck | Exposed Ports | Auto generated routes | Additional customization parameters | | ---------------| -----------------------------------------------------|-----------------|-------|-------------| ---------------------------------------------------| @@ -26,4 +26,4 @@ This table lists all service types that can be defined via `lagoon.type` within | `elasticsearch` | Elasticsearch container, will auto generate persistent storage under `/usr/share/elasticsearch/data` | HTTP on `localhost:9200/_cluster/health?local=true` | `9200` | - | `lagoon.persistent.size` | | `elasticsearch-cluster` | Elasticsearch Cluster with 3 nodes, users Statefulset, will auto generate persistent storage for each cluster node under `/usr/share/elasticsearch/data` | HTTP on `localhost:9200/_cluster/health?local=true` | `9200`, `9300` | - | - | | `none` | Instructs Lagoon to completely ignore this service | - | - | - | - | -| `custom` | Full custom definition, see [documentation](./docker-compose_yml.md) | - | - | - | - | +| `custom` | Full custom definition, see [documentation](docker-compose_yml.md) | - | - | - | - |