Skip to content

Commit

Permalink
Merge pull request #2996 from uselagoon/scp_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tobybellwood authored Jan 17, 2022
2 parents f5bd15b + 3e2a0c0 commit ae8b206
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/docker-images/mariadb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This Dockerfile is intended to be used to set up a standalone MariaDB database s

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* `readiness-probe.sh` script to check when MariaDB container is ready.

## Included tools
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ This Dockerfile is intended to be used to set up a standalone MongoDB database s

This image is prepared to be used on Lagoon, which leverages OpenShift. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user, and therefore also on OpenShift.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user, and therefore also on OpenShift.
2 changes: 1 addition & 1 deletion docs/docker-images/nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This Dockerfile is intended to be used as a base for any web servers within Lago

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* The files within `/etc/nginx/*` are parsed through [`envplate`](https://github.com/kreuzwerker/envplate) with a container-entrypoint.

## Included `NGINX` configuration \(`static-files.conf`\)
Expand Down
4 changes: 2 additions & 2 deletions docs/docker-images/nginx/nginx-drupal.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The [Lagoon `nginx-drupal` Docker image](https://github.com/uselagoon/lagoon-ima

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* To keep `drupal.conf` 's configuration file as clean and customizable as possible, we added `include` directives in the main sections of the file:`server`, `location /`, `location @drupal` and `location @php`.
* Further information in the section [`Drupal.conf` customization](nginx-drupal.md#drupal-conf-customization).

Expand Down Expand Up @@ -63,7 +63,7 @@ RUN fix-permissions /etc/nginx/conf.d/drupal/location_drupal_prepend.conf

## Drupal Core Statistics Module Configuration

If you're using the core Statistics module, you may run into an issue that needs a quick configuration change.
If you're using the core Statistics module, you may run into an issue that needs a quick configuration change.

With the default NGINX configuration, the request to the tracking endpoint `/core/modules/statistics/statistics.php` is denied \(404\).

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/php-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ All PHP versions use their own Dockerfiles.

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* `COMPOSER_ALLOW_SUPERUSER=1` removes warning about use of Composer as root.
* `80-shell-timeout.sh` script checks if containers are running in a Kubernetes environment and then set a 10 minutes timeout to idle `cli` pods.
* `cli` containers use an SSH key injected by Lagoon or defined into `SSH_PRIVATE_KEY`environment variable.
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/php-cli/php-cli-drupal.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ All PHP versions use their own Dockerfiles.

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
2 changes: 1 addition & 1 deletion docs/docker-images/php-fpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ All PHP versions use their own Dockerfiles.

This image is prepared to be used on Lagoon. There are therefore some things are already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* The `/usr/local/etc/php/php.ini` and `/usr/local/etc/php-fpm.conf`, plus all files within `/usr/local/etc/php-fpm.d/` , are parsed through [`envplate`](https://github.com/kreuzwerker/envplate) with a container-entrypoint.
* See the [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm/7.4.Dockerfile) for installed `PHP` extensions.
* To install further extensions, extend your Dockerfile from this image. Install extensions according to the docs, under the heading [How to install more PHP extensions.](https://github.com/docker-library/docs/blob/master/php/README.md#how-to-install-more-php-extensions)
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ By default, the RabbitMQ broker is started as single node. If you want to start

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* The file `/etc/rabbitmq/definitions.json` is parsed through [`envplate`](https://github.com/kreuzwerker/envplate) with a container-entrypoint.

## Included RabbitMQ default schema \(definitions.json\)
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ We don't suggest to use the persistent image for in-memory cache scenarios as th

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions)so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions)so this image will work with a random user.
* The files within `/etc/redis/*` are parsed through [`envplate`](https://github.com/kreuzwerker/envplate)with a container-entrypoint.

## Included `redis.conf` configuration file
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/solr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This Dockerfile is intended to be used to set up a standalone Solr server with a

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.
* `10-solr-port.sh` script to fix and check `Solr` port.
* `20-solr-datadir.sh` script to check if `Solr` config is compliant for Lagoon. This sets directory paths, and configures the correct lock type.

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/varnish/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By default, `vmod-dynamic` and `vmod-bodyaccess` modules are installed.

This image is prepared to be used on Lagoon. There are therefore some things already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/uselagoon/lagoon-images/blob/main/images/commons/fix-permissions), so this image will work with a random user.

## Included varnish modules

Expand Down
12 changes: 11 additions & 1 deletion docs/using-lagoon-advanced/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,14 @@ For example, to connect to the `php` container within the `nginx` pod:

```bash
ssh -p 32222 -t drupal-example-main@ssh.lagoon.amazeeio.cloud service=nginx container=php
```
```

## SCP

### Copying a local file into a pod

To copy a file from your local machine to a pod running on Lagoon, use the following syntax:

```bash
ssh -t -o "UserKnownHostsFile=/dev/null" -o "StrictHostKeyChecking=no" -p 32222 [project_name]-[environment_name]@ssh.lagoon.amazeeio.cloud service=[name_of_service] pod=[name_of_pod] sh -c "cat > /tmp/[name_of_file]" < [name_of_file]
```

0 comments on commit ae8b206

Please sign in to comment.