Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merge latest docs changes #3552

Merged
merged 10 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Chat with us on the Lagoon Discord: [https://discord.gg/te5hHe95JE
7. **Lagoon is completely integration tested**. This means we can test the whole process. From receiving Git webhooks to deploying into a Docker container, the same Git hash is deployed in the cluster.
8. **Most important: It's a work in progress**. It's not done yet. At amazee.io, we believe that as a hosting community, we need to work together and share code where we can.

We want you to understand the Lagoon infrastructure and how the services work together. Here is a schema \(it's a little out of date - it doesn't include some of the more recent services we've added, or cover Kubernetes, so we're working on an update!\): [https://www.lucidchart.com/documents/view/a3cf0c4f-1bc1-438f-977d-4b26f235ceac](https://www.lucidchart.com/documents/view/a3cf0c4f-1bc1-438f-977d-4b26f235ceac) ‌
We want you to understand the Lagoon infrastructure and how the services work together. Here is a schema \(it's a little out of date - it doesn't include some of the more recent services we've added, or cover Kubernetes, so we're working on an update!\): [Lucid Chart](https://lucid.app/documents/view/cb441054-e04a-4389-b98b-c75bcda8ea0d) ‌

## History of Lagoon

Expand Down
2 changes: 2 additions & 0 deletions docs/administering-lagoon/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Here is a table that lists the roles and the access they have:
| deployEnvironmentBranch | environment | deploy:development | projectID |
| deployEnvironmentPullrequest | environment | deploy:development | projectID |
| deployEnvironmentPromote | environment | deploy:development | projectID |
| userCanSshToEnvironment | environment | ssh:development | projectID |
| getNotificationsByProjectId | notification | view | projectID |
| addTask | task | add:development | projectID |
| taskDrushArchiveDump | task | drushArchiveDump:development | projectID |
Expand Down Expand Up @@ -165,6 +166,7 @@ Here is a table that lists the roles and the access they have:
| deployEnvironmentBranch | environment | deploy:production | projectID |
| deployEnvironmentPullrequest | environment | deploy:production | projectID |
| deployEnvironmentPromote | environment | deploy:production | projectID |
| userCanSshToEnvironment | environment | ssh:production | projectID |
| updateGroup | group | update | groupID |
| deleteGroup | group | delete | groupID |
| addUserToGroup | group | addUser | groupID |
Expand Down
6 changes: 3 additions & 3 deletions docs/administering-lagoon/using-harbor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ If you are running Lagoon locally, you can access that UI at [localhost:8084](ht

Once logged in, the first screen is a list of all repositories your user has access to. Each "repository" in Harbor correlates to a project in Lagoon.

![Harbor Projects Overview](.././projects_overview.png)
![Harbor Projects Overview](projects_overview.png)

Within each Harbor repository, you'll see a list of container images from all environments with a single Lagoon project.

![Harbor Repositories Overview](.././repositories_overview.png)
![Harbor Repositories Overview](repositories_overview.png)

From here, you can drill down into an individual container in order to see its details, including an overview of its security scan results.

![Harbor Container Overview](.././container_overview.png)
![Harbor Container Overview](container_overview.png)
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Harbor comes with a built-in security scanning solution provided by the Trivy se

An example of a security scan in Harbor, showing applicable vulnerabilities for a scanned container:

![Harbor Security Scanning Example Image](.././scanning_image_1.png)
![Harbor Security Scanning Example Image](scanning_image_1.png)
2 changes: 1 addition & 1 deletion docs/applications/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

Lagoon provides [Node.js images](https://github.com/uselagoon/lagoon-images/tree/main/images/node) that are based on [the official Node Alpine images](https://hub.docker.com/_/node/).

More information on how to adapt your project to run on Lagoon can be found in our [Node.js Docker Images](../../docker-images/nodejs) section.
More information on how to adapt your project to run on Lagoon can be found in our [Node.js Docker Images](../docker-images/nodejs.md) section.
2 changes: 1 addition & 1 deletion docs/applications/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Lagoon supports Redis as a cache backend. In production, some users provision a

## Search

Lagoon supports Elasticsearch, Solr and (soon) OpenSearch as search providers. External search providers can also be configured if required.
Lagoon supports Elasticsearch, Solr and OpenSearch as search providers. External search providers can also be configured if required.

## Ingress/Routes

Expand Down
4 changes: 2 additions & 2 deletions docs/applications/php.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

## Introduction

Lagoon supports a wide range of PHP-based applications, such as [Drupal](../../drupal), Laravel, [Wordpress](../wordpress), Magento and Symfony.
Lagoon supports a wide range of PHP-based applications, such as [Drupal](../drupal/index.md), Laravel, [Wordpress](wordpress.md), Magento and Symfony.

More information on how to adapt your PHP project to run on Lagoon can be found in our [PHP-cli Docker Images](../../docker-images/php-cli) and [PHP-FPM Docker Images](../../docker-images/php-fpm) sections.
More information on how to adapt your PHP project to run on Lagoon can be found in our [PHP-cli Docker Images](../docker-images/php-cli.md) and [PHP-FPM Docker Images](../docker-images/php-fpm.md) sections.
2 changes: 1 addition & 1 deletion docs/applications/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

Lagoon provides images for [Python 3.7 and above](https://github.com/uselagoon/lagoon-images/tree/main/images/python) that can be used to build web apps in a wide range of Python-based frameworks and applications.

More information on how to adapt your Python project to run on Lagoon can be found in our [Python Docker Images](../../docker-images/python) section.
More information on how to adapt your Python project to run on Lagoon can be found in our [Python Docker Images](../docker-images/python.md) section.
2 changes: 1 addition & 1 deletion docs/applications/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you look at the [dockerfile](https://github.com/lagoon-examples/ruby-on-rails

### Logging

The Lagoon logging infrastructure is described in the [docs here](../logging/logging/). Essentially, in order to make use of the infrastructure, logs need to be sent via a UDP message to `udp://application-logs.lagoon.svc:5140`.
The Lagoon logging infrastructure is described in the [docs here](../logging/logging.md). Essentially, in order to make use of the infrastructure, logs need to be sent via a UDP message to `udp://application-logs.lagoon.svc:5140`.

In our Rails example, we're importing the `logstash-logger` gem, and then in our `config/application.rb` we're initializing it with the following:

Expand Down
30 changes: 0 additions & 30 deletions docs/docker-images/elasticsearch.md

This file was deleted.

3 changes: 2 additions & 1 deletion docs/docker-images/mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

MariaDB is the open source successor to MySQL.

The [Lagoon `MariaDB` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.5.Dockerfile). Based on the official packages [`mariadb`](https://pkgs.alpinelinux.org/packages?name=mariadb&branch=edge) and [`mariadb-client`](https://pkgs.alpinelinux.org/packages?name=mariadb-client&branch=edge) provided by the the upstream Alpine image.
The [Lagoon `MariaDB` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.6.Dockerfile). Based on the official packages [`mariadb`](https://pkgs.alpinelinux.org/packages?name=mariadb&branch=edge) and [`mariadb-client`](https://pkgs.alpinelinux.org/packages?name=mariadb-client&branch=edge) provided by the the upstream Alpine image.

This Dockerfile is intended to be used to set up a standalone MariaDB database server.

* 10.4 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.4.Dockerfile) (Alpine 3.12 Support until May 2022) - `uselagoon/mariadb-10.4`
* 10.5 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.5.Dockerfile) (Alpine 3.14 Support until May 2023) - `uselagoon/mariadb-10.5`
* 10.6 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.6.Dockerfile) (Alpine 3.16 Support until May 2024) - `uselagoon/mariadb-10.6`
* 10.11 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/10.11.Dockerfile) (Alpine 3.18 Support until May 2025) - `uselagoon/mariadb-10.11`

!!! Info
As these images are not built from the upstream MariaDB images, their support follows a different cycle - and will only receive updates as long as the underlying Alpine images receive support - see [https://alpinelinux.org/releases/](https://alpinelinux.org/releases/) for more information. In practice, most MariaDB users will only be running these containers locally - the production instances will use the Managed Cloud Databases provided by the DBaaS Operator
Expand Down
3 changes: 2 additions & 1 deletion docs/docker-images/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ We ship 2 versions of Node.js images: the normal `node:version` image and the `n
The builder variant of those images comes with additional tooling that is needed when you build Node.js apps (such as the build libraries, npm and Yarn). For a full list check out their [Dockerfile](https://github.com/uselagoon/lagoon-images/tree/main/images/node-builder).

* 12 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-12`
* 14 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/14.Dockerfile) (Security Support until April 2023) - `uselagoon/node-14`
* 14 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-14`
* 16 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/16.Dockerfile) (Security Support until September 2023) - `uselagoon/node-16`
* 18 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/18.Dockerfile) (Security Support until April 2025) - `uselagoon/node-18`
* 20 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/20.Dockerfile) (Security Support until April 2026) - `uselagoon/node-20`

!!! Tip
We stop updating EOL Node.js images usually with the Lagoon release that comes after the officially communicated EOL date: [https://nodejs.org/en/about/releases/](https://nodejs.org/en/about/releases/).
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/varnish.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This image is prepared to be used on Lagoon. There are therefore some things alr

## Included `default.vcl` configuration file

The image ships a _default_ `vcl` configuration file, optimized to work on Lagoon. Some options are configurable via environments variables \(see [Environment Variables](./#environment-variables)\).
The image ships a _default_ `vcl` configuration file, optimized to work on Lagoon. Some options are configurable via environments variables \(see [Environment Variables](#environment-variables)\).

## Environment Variables

Expand Down
8 changes: 4 additions & 4 deletions docs/drupal/services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[Documentation on the MariaDB-Drupal image.](./mariadb.md)

[Documentation on the plain MariaDB image](../../docker-images/mariadb/) (the MariaDB-Drupal image is built on this).
[Documentation on the plain MariaDB image](../../docker-images/mariadb.md) (the MariaDB-Drupal image is built on this).

## Redis is a fast, open-source, in-memory key-value data store for use as a database, cache, message broker, and queue

Expand All @@ -18,14 +18,14 @@

[Learn about Solr with Drupal.](solr.md)

[Documentation on the Solr-Drupal image.](./solr.md)
[Documentation on the Solr-Drupal image.](solr.md)

[Documentation on the plain Solr image](../../docker-images/solr/) \(the Solr-Drupal image is built on this\).
[Documentation on the plain Solr image](../../docker-images/solr.md) \(the Solr-Drupal image is built on this\).

## Varnish is a powerful, open-source HTTP engine and reverse HTTP proxy that helps to speed up your website

[Learn about Varnish with Drupal](varnish.md)

[Documentation on the Varnish-Drupal image.](./varnish.md)

[Documentation on the plain Varnish image](../../docker-images/varnish/) \(the Varnish-Drupal image is built on this\).
[Documentation on the plain Varnish image](../../docker-images/varnish.md) \(the Varnish-Drupal image is built on this\).
2 changes: 1 addition & 1 deletion docs/installing-lagoon/lagoon-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Lagoon integrates with OpenSearch to store application, container and router log

In addition, it should be installed in the `lagoon-core` cluster to collect logs from the `lagoon-core` service. This is configured in the `LagoonLogs` section.

Logging Overview: [https://lucid.app/lucidchart/b1da011f-2b91-4798-9518-4164b19d327d/view](https://lucid.app/lucidchart/b1da011f-2b91-4798-9518-4164b19d327d/view)
Logging Overview: [Lucid Chart](https://lucid.app/lucidchart/70f9610e-cfd7-42e8-8b5b-3d03293a439c/view?page=Uq-x~LhSIxrp&invitationId=inv_4e891071-f795-4ada-bbd3-2ff63b8eb1f7#)

See also: [Logging](../logging/logging.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/using-lagoon-advanced/base-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ If your project makes use of [queues](https://laravel.com/docs/5.8/queues), you

## Understanding the process of building a base image

There are several parts to the process of building a base image. All of the major steps are represented in the Makefile. The Jenkinsfile contains a more stripped-down view. Taking a look at both files will give you a good understanding of what happens during this process. Most steps can be tested locally \(this is important when building new versions of the base image\). After you’ve created and tested everything locally and pushed it up, the actual base image is built by [Jenkins](https://jenkins.io/) and pushed to [Harbor](../administering-lagoon/using-harbor/).
There are several parts to the process of building a base image. All of the major steps are represented in the Makefile. The Jenkinsfile contains a more stripped-down view. Taking a look at both files will give you a good understanding of what happens during this process. Most steps can be tested locally \(this is important when building new versions of the base image\). After you’ve created and tested everything locally and pushed it up, the actual base image is built by [Jenkins](https://jenkins.io/) and pushed to [Harbor](../administering-lagoon/using-harbor/README.md).

### Makefile and build assumptions

Expand Down
2 changes: 1 addition & 1 deletion docs/using-lagoon-the-basics/build-and-deploy-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Creation of these objects will also automatically cause Kubernetes or OpenShift

Now Lagoon waits! It waits for all of the just-triggered deployments of the new pods to be finished, as well as for their health checks to be successful.

If any of the deployments or health checks fail, the deployment will be stopped here, and you will be informed via the [defined notification systems](../administering-lagoon/graphql-queries/#adding-notifications-to-the-project) \(like Slack\) that the deployment has failed.
If any of the deployments or health checks fail, the deployment will be stopped here, and you will be informed via the [defined notification systems](../administering-lagoon/graphql-queries.md#adding-notifications-to-the-project) \(like Slack\) that the deployment has failed.

## 11. Run defined post-rollout tasks

Expand Down
2 changes: 1 addition & 1 deletion docs/using-lagoon-the-basics/going-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ environments:

### Redirects

If you need non-www to www redirects, make sure you have them set up in the `redirects-map.conf` - [see Documentation](../../docker-images/nginx/#redirects-mapconf).
If you need non-www to www redirects, make sure you have them set up in the `redirects-map.conf` - [see Documentation](../docker-images/nginx.md#redirects-mapconf).

### Cron jobs

Expand Down
Loading
Loading