diff --git a/.github/workflows/test-mkdocs.yml b/.github/workflows/test-mkdocs.yml index 463b9f7860..c8920c6137 100644 --- a/.github/workflows/test-mkdocs.yml +++ b/.github/workflows/test-mkdocs.yml @@ -3,6 +3,7 @@ on: push: branches: - 'docs/**' + - 'mkdocs' pull_request: branches: - 'main' diff --git a/docs/docker-images/deprecated-images.md b/docs/docker-images/deprecated-images.md new file mode 100644 index 0000000000..a0ce568fbb --- /dev/null +++ b/docs/docker-images/deprecated-images.md @@ -0,0 +1,53 @@ +# Deprecated Images + +From time to time, the Lagoon team may need to mark images as deprecated. + +This is conveyed in a "sh.lagoon.image.deprecated" . It can be viewed in Docker Desktop, via a `docker inspect` command, or in future releases of Lagoon, highlighted in a build. + +If the image has a suggested replacement, it will be conveyed in a "sh.lagoon.image.deprecated.suggested" label attached the deprecated image. + +## Changing the image + +In all cases, changing to a suggested or updated image will require a change in your codebase. Any reference to the image in a Dockerfile, or in your docker-compose.yml will need to be updated. + +## Reasons for deprecating + +We have three main reasons for deprecating an image: + +### Replaced +An image will be marked as "replaced" when the image reference needs to be changed. This could be because of a naming change, a repository change, or a versioning change. In these cases a new image will usually be recommended for use instead, and using it should be a fairly easy switch. + +Some examples of this are: + +* the migration from `amazeeio/{image}` to `uselagoon/{image}` - these images should be identical +* the versioning of an image from `uselagoon/mongo` to `uselagoon/mongo-4` - these images should be identical + +### End of Life +An image will be marked as "endoflife" when the version published is no longer actively supported or maintained upstream. In these cases a new image will usually be recommended for use instead, but upgrading to it may require updating some of your application code, so should always be tested thoroughly. Also note that any suggested image may also be marked as endoflife (especially if the upstream moves quickly) + +Some examples of this are: + +* PHP 8.0 reached EOL in November 2023, and any `uselagoon/php-8.0-{variant}` image will suggest `uselagoon/php-8.3-{variant}` as it is the current latest release of PHP. Upgrades here _may_ be straightforward as it's within a major version. +* Python 2.7 reached EOL in January 2020, and the `uselagoon/php-2.7` images will suggest `uselagoon/python-3.12` as it is the current latest release of Python. Upgrades here will be complex, owing to it being a major version change. + +### Discontinued +An image will be marked as "discontinued when the variant is no longer being published by the Lagoon team (although the upstream may still be supported). In these cases a replacement image _may_ be suggested, but any migration will be involved, and require updating of application code, client libraries, data directories etc, or removal of functionality completely. + +* A CKAN variant of Python 2.7 image `uselagoon/python-2.7-ckan` stopped being published in August 2021 and no replacement is suggested. +* An AthenaPDF image `uselagoon/athenapdf-service` stopped being published in October 2022 and no replacement image is suggested. +* An Elasticsearch 7 image `uselagoon/elasticsearch-7` stopped being published in April 2023 due to licensing concerns, and although images may suggest `uselagoon/opensearch-2` - any upgrade here will be extremely involved. + + +## "amazeeio/" image variants + +Historically, all Lagoon images were dual published to the [uselagoon](https://hub.docker.com/u/uselagoon) and [amazeeio](https://hub.docker.com/u/amazeeio) Docker Hub organizations. + +In August 2024, we ceased this dual-publishing model, and have used the deprecated image tooling to suggest the correct replacements. + +We encourage anyone still using the `amazeeio` variants to switch to the `uselagoon` variants as soon as possible. + +As well as being easier for us to maintain, the uselagoon versions: + +* Are routinely published and updated. No `amazeeio` image will be updated beyond July 2024. +* Are published as multi-architecture images by default, so will work natively on Linux, Windows or MacOS machines. +* Are free from any rate-limit restrictions, as the `uselagoon` organization is [Docker Sponsored Open Source](https://docs.docker.com/trusted-content/dsos-program/) diff --git a/docs/docker-images/nodejs.md b/docs/docker-images/nodejs.md index 51d5279247..998636f3c2 100644 --- a/docs/docker-images/nodejs.md +++ b/docs/docker-images/nodejs.md @@ -11,7 +11,7 @@ The builder variant of those images comes with additional tooling that is needed * 12 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-12` * 14 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-14` * 16 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-16` -* 18 \(available for compatibility only, no longer officially supported\) - `uselagoon/node-18` +* 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` * 22 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/22.Dockerfile) (Security Support until April 2027) - `uselagoon/node-22` diff --git a/docs/ja/concepts-basics/docker-compose-yml.md b/docs/ja/concepts-basics/docker-compose-yml.md index 0bdca3704e..2b38c73462 100644 --- a/docs/ja/concepts-basics/docker-compose-yml.md +++ b/docs/ja/concepts-basics/docker-compose-yml.md @@ -71,7 +71,7 @@ services: 1. ここで[マルチコンテナポッド](docker-compose-yml.md#multi-container-pods)に注目してください。 2. ここで[マルチコンテナポッド](docker-compose-yml.md#multi-container-pods)に注目してください。 -## 基本設定 +## 基本設定 { #basic-settings } `x-lagoon-project`: @@ -107,7 +107,7 @@ Linuxを使用していて、`1000`以外のユーザーで実行したい場合 !!! Warning "警告" 一度サービスの名前を設定したら、修正しないでください。修正すると、コンテナ内で様々な問題が発生し、不整合が発生する可能性があります。 -### Dockerイメージ +### Dockerイメージ { #docker-images } #### `build` @@ -127,17 +127,17 @@ Linuxを使用していて、`1000`以外のユーザーで実行したい場合 Dockerfileをビルドする必要がなく、既存のDockerfileを使用したい場合は、`image`で定義します。 -### タイプ +### タイプ { #types } Lagoonは、KubernetesやOpenShiftのオブジェクトを正しく設定するために、デプロイするサービスのタイプを知る必要があります。 これは`lagoon.type`ラベルを通じて行われます。選択できるタイプは多数あります。すべてのタイプと追加設定の可能性を見るには、[サービスタイプ](../concepts-advanced/service-types.md)を確認してください。 -#### コンテナのスキップ/無視 +#### コンテナのスキップ/無視 { #skipignore-containers } たとえば、ローカル開発時にのみコンテナが必要な場合など、Lagoonにサービスを完全に無視させたい場合は、そのタイプに`none`を指定します。 -### 永続的なストレージ +### 永続的なストレージ { #persistent-storage } 一部のコンテナには永続的なストレージが必要です。Lagoonでは、各コンテナが最大1つの永続的なストレージボリュームをコンテナに接続できるようにしています。コンテナに自身の永続的なストレージボリュームを要求させることができ(それを他のコンテナにマウントさせることも可能)、また、コンテナに他のコンテナが作成した永続的なストレージをマウントするよう指示することもできます。 @@ -148,13 +148,13 @@ Lagoonは、KubernetesやOpenShiftのオブジェクトを正しく設定する * `lagoon.persistent.size` - 必要な永続的なストレージのサイズ(Lagoonは通常、最小5Gの永続的なストレージを提供します。もしもっと必要なら、ここで定義してください)。 * `lagoon.persistent.class` - デフォルトではLagoonは自動的に適切なストレージクラス(MySQLのSSD、Nginxの大量ストレージなど)をサービスに割り当てます。これを上書きする必要がある場合は、ここで行うことができます。これは、Lagoonが動作するKubernetes/OpenShiftのインフラ基盤に大きく依存します。これについてはLagoonの管理者に問い合わせてください。 -### 自動生成されるルート +### 自動生成されるルート { #auto-generated-routes } docker-compose.ymlファイルは、サービスごとに[自動生成されるルート](./lagoon-yml.md#routes)を有効または無効にすることもサポートしています。 * `lagoon.autogeneratedroute: false` ラベルを使用すると、そのサービスに対して自動的に生成されるルートが停止します。これは自動生成されるルートを持つすべてのサービスに適用できますが、データベースサービスなどの追加の内部向けサービスを作成する際に[`basic`](../concepts-advanced/service-types.md#basic)および[`basic-persistent`](../concepts-advanced/service-types.md#basic-persistent)サービスタイプで特に便利です。逆もまた同様に、.lagoon.ymlファイルがそれらを[無効にする](lagoon-yml.md#routesautogenerate)ときに、サービスに対して自動生成されるルートを有効にします。 -## マルチコンテナーポッド +## マルチコンテナーポッド { #multi-container-pods } KubernetesとOpenShiftは単純なコンテナーをデプロイしません。代わりに、それぞれが1つ以上のコンテナーを持つポッドをデプロイします。通常、Lagoonは定義された`docker-compose`サービスごとにコンテナーが内部にある単一のポッドを作成します。しかし、あるケースでは、これらのコンテナーが互いに非常に依存していて、常に一緒にいるべきであるため、単一のポッド内に2つのコンテナーを配置する必要があります。そのような状況の一例は、PHPコンテナとNGINXコンテナがDrupalのようなウェブアプリケーションのPHPコードを含む場合です。 @@ -197,11 +197,11 @@ php: Lagoonはどのサービスが`nginx`、`php`であるかを認識するために、`lagoon.deployment.servicetype: nginx`および`lagoon.deployment.servicetype: php`と定義します。 -## Helmテンプレート (Kubernetesのみ) +## Helmテンプレート (Kubernetesのみ) { #helm-templates-kubernetes-only } LagoonはKubernetesでのテンプレート作成に[Helm](https://helm.sh/)を使用します。これを行うために、一連の[チャート](https://github.com/uselagoon/build-deploy-tool/tree/main/legacy/helmcharts)が`build-deploy-tool`イメージに含まれています。 -## カスタムロールアウトモニタータイプ +## カスタムロールアウトモニタータイプ { #custom-rollout-monitor-types } デフォルトでは、LagoonはカスタムテンプレートからのサービスがKubernetesまたはOpenshift内の[`DeploymentConfig`](https://docs.openshift.com/container-platform/4.4/applications/deployments/what-deployments-are.html#deployments-and-deploymentconfigs_what-deployments-are)オブジェクトを介してロールアウトされることを期待しています。それに基づいてロールアウトを監視します。場合によっては、カスタムデプロイメントで定義されたサービスが異なる監視方法を必要とすることがあります。これは`lagoon.rollout`を通じて定義することができます: @@ -211,7 +211,7 @@ LagoonはKubernetesでのテンプレート作成に[Helm](https://helm.sh/)を また、特定の環境のみにロールアウトを上書きすることもできます。これは[`.lagoon.yml`](lagoon-yml.md#environments-name-rollouts)で行います。 -## Docker Compose v2互換性 +## Docker Compose v2互換性 { #docker-compose-v2-compatibility } !!! Bug "バグ" ローカルでDocker Compose V2の古いバージョンを使用していると、一部の既知の問題が発生することがあります - これらの問題は後のリリース(v2.17.3以降)で解決されています。 @@ -239,21 +239,21 @@ no such service: container:amazeeio-ssh-agent * このメッセージは、ローカルで実行されているコンテナへのSSHアクセスを提供するサービスが、あなたのDocker Composeスタックの外部で実行され、アクセスできないことを意味します。 * あなたのローカル環境からSSHアクセスが必要ない場合、`docker-compose.yml`ファイルからこのセクションを削除することもできます。 -## BuildKitとLagoon +## BuildKitとLagoon { #buildkit-and-lagoon } BuildKitは、ソースコードを効率的で表現力豊かで繰り返し利用可能な方法でビルド成果物に変換するためのツールキットです。 Lagoon v2.11.0のリリースにより、Lagoonはより高度なBuildKitベースのdocker-composeビルドをサポートするようになりました。プロジェクトまたは環境でBuildKitを有効にするには、Lagoonプロジェクトまたは環境に`DOCKER_BUILDKIT=1`をビルド時の変数として追加してください。 -## LagoonビルドでのDocker Composeエラー +## LagoonビルドでのDocker Composeエラー { #docker-compose-errors-in-lagoon-builds } Docker Composeで一般的なビルドエラーの解決方法については、[Lagoonビルドエラーページ](../using-lagoon-the-basics/lagoon-build-errors-and-warnings.md#docker-compose-errors)を参照してください。 -## よくあるDocker Composeの問題 +## よくあるDocker Composeの問題 { #common-docker-compose-issues } このセクションでは、一般的なDocker Composeのエラーとその対処方法について説明します。これらはローカル開発で発生するか、または[Lagoonビルドエラーと警告](../using-lagoon-the-basics/lagoon-build-errors-and-warnings.md#docker-compose-errors)として発生するかもしれません。 -### 二重マッピングキー +### 二重マッピングキー { #dual-mapping-keys } ``` shell title="マッピングキーのエラーを示すDocker Composeの出力" ERR: yaml: unmarshal errors: line 22: mapping key "<<" already defined at line 21 diff --git a/docs/ja/concepts-basics/lagoon-yml.md b/docs/ja/concepts-basics/lagoon-yml.md index db13b2487c..68cc75195e 100644 --- a/docs/ja/concepts-basics/lagoon-yml.md +++ b/docs/ja/concepts-basics/lagoon-yml.md @@ -54,7 +54,7 @@ - it ``` -## タスク +## タスク { #tasks } 定義可能なタスクには複数の種類があり、それらはビルドフローの中のどのタイミングで実行されるかが異なります。 @@ -96,12 +96,12 @@ * `when` * タスクの条件付き実行を可能にします。タスクを実行するか決定するために、true/falseに評価される式であることを期待されます。 -注: デプロイメント中にpre/post-rolloutタスクを一時的に無効にしたい場合は、APIで以下の環境変数をプロジェクトレベルまたは環境に設定します([環境変数](../concepts-advanced/environment-variables.md)の設定方法についてはここを参照してください)。 +注: デプロイメント中にpre/post-rolloutタスクを一時的に無効にしたい場合は、APIで以下の環境変数をプロジェクトレベルまたは環境に設定します([環境変数](../../concepts-advanced/environment-variables.md)の設定方法についてはここを参照してください)。 * `LAGOON_PREROLLOUT_DISABLED=true` * `LAGOON_POSTROLLOUT_DISABLED=true` -#### post-rolloutタスクの例 +#### post-rolloutタスクの例 { #example-post-rollout-tasks } 以下はいくつかの有用なpost-rolloutタスクの例です。 @@ -165,7 +165,7 @@ Drupal & Drush 9: マスター環境からデータベースとファイルを 1. ここではプロジェクトに適したエイリアスを使用してください。 -## バックアップの保持期間 +## バックアップの保持期間 ( #backup-retention } ### `backup-retention.production.monthly` @@ -191,7 +191,7 @@ Drupal & Drush 9: マスター環境からデータベースとファイルを この値が指定されていない場合、デフォルトは `0` です。 -## バックアップスケジュール +## バックアップスケジュール { #backup-schedule } ### `backup-schedule.production` @@ -199,7 +199,7 @@ Drupal & Drush 9: マスター環境からデータベースとファイルを この値が指定されていない場合、グローバルデフォルトは `M H(22-2) * * *` です。注意して頂きたいのは、 これらのバックアップは、クラスタのローカルタイムゾーンを使用します。 -## 環境 +## 環境 { #environments } 環境名は、デプロイされたブランチ名やプルリクエスト名と一致します。これにより、各環境で異なる設定を持つことが可能になります。私たちの例では、`main`と`staging`環境に適用されます。 @@ -245,7 +245,7 @@ Drupal & Drush 9: マスター環境からデータベースとファイルを !!! Info "情報" 証明書認証機関(CA)によって署名されたSSL証明書からLet's Encrypt証明書に切り替える予定の場合、移行を監視するためにLagoon管理者に連絡することをお勧めします。 -### 特定のパスの監視 +### 特定のパスの監視 { #monitoring-a-specific-path } [UptimeRobot](https://uptimerobot.com/)があなたのクラスター(KubernetesまたはOpenShift)に設定されている場合、Lagoonは各ルート/イングレスにannotationを設定して`stakater/IngressControllerMonitor`を使用します。デフォルトのアクションはルートのホームページを監視することです。特定のルートを監視したい場合、ルート仕様に`monitoring-path`を追加することでこれをオーバーライドできます。一般的な使用法は、キャッシングをバイパスする監視用のパスを設定し、サイトのリアルタイムの監視を可能にすることです。 @@ -254,14 +254,14 @@ Drupal & Drush 9: マスター環境からデータベースとファイルを monitoring-path: "/bypass-cache" ``` -### Ingress annotations +### Ingress annotations { #ingress-annotations } !!! Warning "警告" ルート/Ingressのannotationsは、nginx-ingressコントローラーを実行するクラスターにデプロイされるプロジェクトのみがサポートしています。これがサポートされているかどうかはLagoon管理者に確認してください。 * `annotations`は、[nginx-ingressコントローラーがサポートするannotations](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/)のYAMLマップです。これは特に、簡単なリダイレクトや他の設定に便利です。 -#### 制限事項 +#### 制限事項 { #restrictions } Lagoonでは、一部のannotationsが禁止されているか、または部分的に制限されています。 以下の表は、これらのルールを説明しています。 @@ -277,8 +277,7 @@ Lagoonでは、一部のannotationsが禁止されているか、または部分 | `nginx.ingress.kubernetes.io/stream-snippet` | 禁止 | | `nginx.ingress.kubernetes.io/use-regex` | 禁止 | -#### Ingressのannotationsリダイレクト - +#### Ingressのannotationsリダイレクト { #ingress-annotations-redirects } この例では、`example.ch`への任意のリクエストが、フォルダーやクエリパラメータを保持したまま `https://www.example.ch`にリダイレクトされます(`example.com/folder?query` -> `https://www.example.ch/folder?query`)。 ```yaml title=".lagoon.yml" @@ -296,7 +295,7 @@ Lagoonにホストされていない他の任意のURLにリダイレクトす nginx.ingress.kubernetes.io/permanent-redirect: https://www.google.com ``` -#### 信頼されるリバースプロキシ +#### 信頼されるリバースプロキシ { #trusted-reverse-proxies } !!! Warning "警告" Kubernetesは単一の`nginx.ingress.kubernetes.io/server-snippet`アノテーションのみを処理します。非本番環境のルートでこのアノテーションを使用する場合は、`add_header X-Robots-Tag "noindex, nofollow";`アノテーションもサーバースニペットの一部として含めてください。これは、開発環境でロボットがクロールするのを防ぐために必要です。ingressテンプレートの開発環境でこれを防ぐために設定されたデフォルトのserver-snippetは、`.lagoon.yml`に設定された`server-snippets`によって上書きされます。 @@ -345,7 +344,7 @@ Lagoonのビルドプロセスは、`docker-compose.yml`ファイルから`lagoo * `service-name`は、`docker-compose.yml`から上書きしたいサービスの名前です。 * `template-file`は、この環境でこのサービスに使用するテンプレートのパスと名前です。 -#### テンプレート上書きの例 +#### テンプレート上書きの例 { #example-template-override } ```yaml title=".lagoon.yml" environments: @@ -354,7 +353,7 @@ environments: mariadb: mariadb.main.deployment.yml ``` -### `environments.[name].rollouts` +### `environments.[name].rollouts` { #environments-name-rollouts } Lagoonのビルドプロセス `lagoon.rollout`ラベルを`docker-compose.yml`ファイルから調べて、サービスが特別なロールアウトタイプを必要とするかどうかを確認します(`docker-compose.yml`の[ドキュメンテーション](docker-compose-yml.md#custom-rollout-monitor-types)で詳しく読むことができます)。 @@ -365,7 +364,7 @@ Lagoonのビルドプロセス `lagoon.rollout`ラベルを`docker-compose.yml` * `service-name`は、上書きしたい`docker-compose.yml`のサービスの名前です。 * `rollout-type`は、ロールアウトのタイプです。可能な値については、`docker-compose.yml`の[ドキュメンテーション](docker-compose-yml.md#custom-rollout-monitor-types)を参照してください。 -#### カスタムロールアウトタイプの例 +#### カスタムロールアウトタイプの例 { #custom-rollout-type-example } ```yaml title=".lagoon.yml" environments: @@ -393,7 +392,7 @@ environments: Cronジョブは、通常、すべての環境で同じものを実行することは望ましくないため、各環境で明示的に定義する必要があります。定義したスケジュールにより、CronジョブはKubernetesネイティブの`CronJob`として、または定義したサービスのcrontabを介したin-pod cronジョブとして実行される場合があります。 -#### Cronジョブの例 +#### Cronジョブの例 { #cron-job-example } ```yaml title=".lagoon.yml" cronjobs: @@ -430,7 +429,7 @@ cronjobs: * `service`:コマンドをプロジェクトのどのサービスで実行するかを指定します。ほとんどのプロジェクトでは、これは`cli`サービスであるべきです。 -## ポリサイト +## ポリサイト { #polysite ) Lagoonでは、同じGitリポジトリを複数のプロジェクトに追加することができ、これをポリサイトと呼びます。これにより、同じコードベースを実行しながら、異なる独立したデータベースと永続的なファイルを許可することができます。 `.lagoon.yml`では、現在、ポリサイトプロジェクトのためのカスタムルートを指定することのみをサポートしています。標準プロジェクトとの主な違いは、`environments`が二次元要素となり、プロジェクト名が最上位要素となることです。 @@ -440,7 +439,7 @@ Lagoonでは、同じGitリポジトリを複数のプロジェクトに追加 2. 各プロジェクトのデプロイキーをGitリポジトリに追加します。 3. (もし必要なら)リポジトリのウェブフックを設定します - その後、プッシュ/デプロイが可能になります。リポジトリへのプッシュは、そのGit URLに対するすべてのプロジェクト/ブランチを同時にデプロイします。 -### Polysiteの例 +### Polysiteの例 { #polysite-example } ```yaml title=".lagoon.yml" poly-project1: @@ -457,7 +456,7 @@ poly-project2: - project2.com ``` -## 特別な項目 +## 特別な項目 { #specials } ### `api` @@ -484,7 +483,7 @@ poly-project2: * APIで環境変数として定義する * .lagoon.ymlファイルにハードコードする(ただし、これは推奨しません) -#### 環境変数として定義する方法 +#### 環境変数として定義する方法 { #environment-variables-method } まず、.lagoon.ymlにコンテナレジストリを定義します。ここではユーザー名やパスワードを定義する必要はありません。カスタムレジストリを使用する場合でも、URLを指定する必要があります。例えば次のように定義します: @@ -507,7 +506,7 @@ container-registries: * lagoon add variable -p <プロジェクト名> -N <レジストリユーザーの変数名> -V <ユーザー> -S container_registry * lagoon add variable -p <プロジェクト名> -N <レジストリパスワードの変数名> -V <パスワード> -S container_registry -* \(詳しくは[環境変数](/concepts-advanced/environment-variables/)を参照\) +* \(詳しくは[環境変数](../../concepts-advanced/environment-variables.md)を参照\) 変数の名前は.lagoon.ymlファイルで定義されたレジストリの名前と一致する必要があります。次のように設定してください: @@ -542,8 +541,7 @@ container-registries: サポートされているパスワードの変数が提供されている場合、カスタム名の変数の代わりにそれが使用されます。 -#### ハードコードされた値の方法 - +#### ハードコードされた値の方法 { #hardcoded-values-method } 推奨されませんが、`.lagoon.yml` ファイルに直接プレーンテキストとしてパスワードを定義することもできます: ```yaml title=".lagoon.yml" @@ -559,7 +557,7 @@ container-registries: password: MyCustomSecretPassword ``` -### カスタムまたはプライベートなコンテナレジストリイメージの使用 +### カスタムまたはプライベートなコンテナレジストリイメージの使用 { #consuming-a-custom-or-private-container-registry-image } カスタムまたはプライベートなコンテナレジストリイメージを使用するには、`docker-compose.yml` ファイル内のサービスを更新して、イメージを定義する代わりにビルドコンテキストを使用するようにする必要があります: @@ -577,7 +575,7 @@ services: FROM dockerhubuser/my-private-database:tag ``` -## `.lagoon.yml` の例 +## `.lagoon.yml` の例 { #example-lagoonyml } これは全ての可能な設定を示した `.lagoon.yml` の例です。プロジェクトに合わせて調整する必要があります。 @@ -647,7 +645,7 @@ environments: service: cli ``` -## 非推奨 +## 非推奨 { #deprecated } これらの設定は非推奨となり、あなたの `.lagoon.yml` から削除するべきです。 diff --git a/docs/ja/docker-images/nodejs.md b/docs/ja/docker-images/nodejs.md index 1768985034..cef23e5f86 100644 --- a/docs/ja/docker-images/nodejs.md +++ b/docs/ja/docker-images/nodejs.md @@ -11,9 +11,9 @@ Node.jsのイメージは2つのバージョンがあります。通常の`node: * 12 \(互換性のためのみ利用可能、公式サポートは終了しています\) - `uselagoon/node-12` * 14 \(互換性のためのみ利用可能、公式サポートは終了しています\) - `uselagoon/node-14` * 16 \(互換性のためのみ利用可能、公式サポートは終了しています\) - `uselagoon/node-16` -* 18 \(互換性のためのみ利用可能、公式サポートは終了しています\) - `uselagoon/node-18` -* 20 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/20.Dockerfile) (2025年4月までのセキュリティサポート) - `uselagoon/node-20` -* 22 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/22.Dockerfile) (2026年4月までのセキュリティサポート) - `uselagoon/node-22` +* 18 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/18.Dockerfile) (2025年4月までのセキュリティサポート) - `uselagoon/node-18` +* 20 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/20.Dockerfile) (2026年4月までのセキュリティサポート) - `uselagoon/node-20` +* 22 [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/node/22.Dockerfile) (2027年4月までのセキュリティサポート) - `uselagoon/node-22` !!! Tip "ヒント" Lagoonは、公式にアナウンスされた終了日(EOL)の後にリリースされるバージョンで、EOLに達したNode.jsイメージの更新を停止します。詳細は[https://nodejs.org/en/about/releases/](https://nodejs.org/en/about/releases/)を参照して下さい。 diff --git a/docs/releases/2.10.0.md b/docs/releases/2.10.0.md index 5bf0733b80..132e09f874 100644 --- a/docs/releases/2.10.0.md +++ b/docs/releases/2.10.0.md @@ -11,4 +11,4 @@ You *must* upgrade to Lagoon v2.9.x before upgrading to v2.10.0. Ensure you read ## Deprecations -There are no required actions or considerations with this release +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.12.0.md b/docs/releases/2.12.0.md index 9876bf5efe..557e6a5f58 100644 --- a/docs/releases/2.12.0.md +++ b/docs/releases/2.12.0.md @@ -14,4 +14,4 @@ The minimum supported version of Kubernetes is 1.21 as of this release. ## Deprecations -There are no required actions or considerations with this release +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.14.1.md b/docs/releases/2.14.1.md index 49c18f08f6..70c40aa117 100644 --- a/docs/releases/2.14.1.md +++ b/docs/releases/2.14.1.md @@ -5,6 +5,10 @@ * lagoon-core chart [1.28.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.28.0) * lagoon-remote chart [0.76.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-remote-0.76.0) +## Release Notes + +This release was superseded, and the [2.14.2](./2.14.2.md) release is recommended to be installed instead. + ## Upgrades This release was superseded, and the [2.14.2](./2.14.2.md) release is recommended to be installed instead. diff --git a/docs/releases/2.14.2.md b/docs/releases/2.14.2.md index 86460409fa..f589216657 100644 --- a/docs/releases/2.14.2.md +++ b/docs/releases/2.14.2.md @@ -5,10 +5,14 @@ * lagoon-core chart [1.28.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.28.0) * lagoon-remote chart [0.76.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-remote-0.76.0) +## Release Notes + +This release resolved a couple of minor issues discovered after releasing the [2.14.0](./2.14.0.md) and [2.14.1](./2.14.1.md) releases. + ## Upgrades There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. ## Deprecations -There are no required actions or considerations with this release +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.15.0.md b/docs/releases/2.15.0.md index 719d8c3241..f1dd4c6d13 100644 --- a/docs/releases/2.15.0.md +++ b/docs/releases/2.15.0.md @@ -4,6 +4,10 @@ * lagoon-build-deploy [core-v2.15.0](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.15.0) * lagoon-core chart [1.29.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.29.0) +## Release Notes + +This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. + ## Upgrades This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. diff --git a/docs/releases/2.15.1.md b/docs/releases/2.15.1.md index b2c3d8d58e..d6bbe54e17 100644 --- a/docs/releases/2.15.1.md +++ b/docs/releases/2.15.1.md @@ -4,6 +4,10 @@ * lagoon-build-deploy [core-v2.15.1](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.15.1) * lagoon-core chart [1.31.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.31.0) +## Release Notes + +This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. + ## Upgrades This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. diff --git a/docs/releases/2.15.2.md b/docs/releases/2.15.2.md index 1eb50defd4..a646c55512 100644 --- a/docs/releases/2.15.2.md +++ b/docs/releases/2.15.2.md @@ -4,6 +4,9 @@ * lagoon-build-deploy [core-v2.15.2](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.15.2) * lagoon-core chart [1.34.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.34.0) +## Release Notes +This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. + ## Upgrades This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. diff --git a/docs/releases/2.15.3.md b/docs/releases/2.15.3.md index 1e7ee8395d..9de48df684 100644 --- a/docs/releases/2.15.3.md +++ b/docs/releases/2.15.3.md @@ -4,6 +4,10 @@ * lagoon-build-deploy [core-v2.15.3](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.15.3) * lagoon-core chart [1.35.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.35.0) +## Release Notes + +This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. + ## Upgrades This release was superseded, and the [2.15.4](./2.15.4.md) release is recommended to be installed instead. diff --git a/docs/releases/2.15.4.md b/docs/releases/2.15.4.md index 8bf8b01e63..3dc0da98b0 100644 --- a/docs/releases/2.15.4.md +++ b/docs/releases/2.15.4.md @@ -4,10 +4,14 @@ * lagoon-build-deploy [core-v2.15.4](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.15.4) * lagoon-core chart [1.36.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.36.0) +## Release Notes + +This release resolved a couple of minor issues discovered after releasing the [2.15.0](./2.15.0.md), [2.15.1](./2.15.1.md), [2.15.2](./2.15.2.md), and [2.15.3](./2.15.3.md) releases. + ## Upgrades There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. ## Deprecations -There are no required actions or considerations with this release +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.16.0.md b/docs/releases/2.16.0.md index 9426e96644..9210632926 100644 --- a/docs/releases/2.16.0.md +++ b/docs/releases/2.16.0.md @@ -10,4 +10,4 @@ There are no required actions or considerations with this release. As always, we ## Deprecations -There are no required actions or considerations with this release +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.17.0.md b/docs/releases/2.17.0.md index 792e0c57c0..7c4024da4b 100644 --- a/docs/releases/2.17.0.md +++ b/docs/releases/2.17.0.md @@ -12,9 +12,9 @@ There are no required actions or considerations with this release. As always, we ## Deprecations ### activestandby task image -* This release introduces a new active/standby task image that does not require the use of the [dioscuri controller](https://github.com/amazeeio/dioscuri). Dioscuri is deprecated and will eventually be removed from the `lagoon-remote` helm chart. If you use active/standby functionality in your clusters, you should upgrade to lagoon v2.17.0 and update your remote clusters to the version of the `lagoon-remote` helm chart the v2.17.0 release says to use (see release notes for v2.17.0) +* This release introduces a new active/standby task image that does not require the use of the [dioscuri controller](https://github.com/amazeeio/dioscuri). Dioscuri is deprecated and will eventually be removed from the `lagoon-remote` helm chart. If you use active/standby functionality in your clusters, you should upgrade to lagoon v2.17.0 and update your remote clusters to the version of the `lagoon-remote` helm chart the in the [2.17.0](./2.17.0.md) release. ### API Harbor support * Support for Harbor in the API will be removed in a future release. If you currently have your core installation with Harbor support, you should move to using the integration within lagoon-remote instead. See the documentation [here](https://docs.lagoon.sh/installing-lagoon/install-lagoon-remote) and read the section about Harbor. -* Removed in [v2.20.0](https://docs.lagoon.sh/releases/2.20.0) +* Removed in [2.20.1](./2.20.1.md) ### Harbor 2.1 and earlier support * Support for Harbor 2.1.x (chart version 1.5.x) and older in `lagoon-remote` will be removed in a future release. You should consider upgrading Harbor to a newer version (currently Lagoon supports up to v2.9.x (chart version 1.13.x)), following any recommended upgrade paths from Harbor. diff --git a/docs/releases/2.18.0.md b/docs/releases/2.18.0.md index 5e86216a71..1595e03006 100644 --- a/docs/releases/2.18.0.md +++ b/docs/releases/2.18.0.md @@ -5,20 +5,14 @@ * lagoon-core chart [1.42.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.42.0) * lagoon-remote chart [0.88.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-remote-0.88.0) +## Release Notes + +This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. + ## Upgrades + This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. ## Deprecations -### In-built Drupal Tasks -* The standard drupal based tasks that Lagoon ships with (Drush ....) have been flagged as deprecated and should not be used anymore. These will need to be replaced with [custom tasks](https://docs.lagoon.sh/using-lagoon-advanced/custom-tasks/). Example replacement tasks will be provided prior to their removal. -### setEnvironmentServices -* This release introduces a deprecation of the `setEnvironmentServices` mutation to updated services for an environment, it is being replaced with `addOrUpdateEnvironmentService` and `deleteEnvironmentService`. This is because the type is being refactored to support additional information, and eventually additional functionality. For now, the actions-handler service will still support the older `setEnvironmentServices` for backwards compatibility for a short period to allow older versions of `lagoon-remote` to still work, but a new version of `lagoon-remote` will be available that will no longer provides the payload that the actions-handler uses. -### Core Registry variable -* The value for `registry` which was previously required by the `lagoon-core` chart is no longer required. If you are using this, you will need to add it under the new `unauthenticatedRegistry` setting when installing `lagoon-remote` in the `lagoon-build-deploy` section of your values file. If you aren't using an actual registry and have the example `disabled-only-use-harbor-via-deploy-controller.invalid` value, then you do not need to do anything except you can now remove the `registry` setting from your core values file. -### bytesUsed -* The environment storage return field named `bytesUsed` is deprecated. The actual value stored is `kibibytes`. A new return field called `kibUsed` exists and should be used, the returned data is the same and both fields are still returned. `bytesUsed` will be removed in a future release, make any adjustments now to use `kibUsed`. This will be a breaking change in a future release. -### addOrUpdateEnvironmentStorage -* `addOrUpdateEnvironmentStorage` is deprecated, `addOrUpdateStorageOnEnvironment` is the replacement to use as it supports the updated input value for `kibUsed`. `addOrUpdateEnvironmentStorage` will be completely removed in a future release. -### activesystems -* The ability to configure projects to use different subsystems for managing deployments/tasks has been removed. Setting any values for the `activeSystems*` fields on the project will have no effect and the fields will be removed in a future release. +This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. diff --git a/docs/releases/2.18.1.md b/docs/releases/2.18.1.md index da632f7dd3..8e5b000bd5 100644 --- a/docs/releases/2.18.1.md +++ b/docs/releases/2.18.1.md @@ -2,8 +2,14 @@ * lagoon [v2.18.1](https://github.com/uselagoon/lagoon/releases/tag/v2.18.1) * lagoon-core chart [1.43.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.43.0) +## Release Notes + +This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. + ## Upgrades + This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. ## Deprecations -As per the [2.18.0](./2.18.0.md) release + +This release was superseded, and the [2.18.2](./2.18.2.md) release is recommended to be installed instead. diff --git a/docs/releases/2.18.2.md b/docs/releases/2.18.2.md index 68cdf3e29c..29afd927ef 100644 --- a/docs/releases/2.18.2.md +++ b/docs/releases/2.18.2.md @@ -2,8 +2,25 @@ * lagoon [v2.18.2](https://github.com/uselagoon/lagoon/releases/tag/v2.18.2) * lagoon-core chart [1.44.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.44.0) +## Release Notes +This release resolved a couple of minor issues discovered after releasing the [2.18.0](./2.18.0.md) and [2.18.1](./2.18.2.md) release. + ## Upgrades + There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. ## Deprecations -As per the [2.18.0](./2.18.0.md) release + +### In-built Drupal Tasks +* The standard drupal based tasks that Lagoon ships with (Drush ....) have been flagged as deprecated and should not be used anymore. These will need to be replaced with [custom tasks](https://docs.lagoon.sh/using-lagoon-advanced/custom-tasks/). Example replacement tasks will be provided prior to their removal. +### setEnvironmentServices +* This release introduces a deprecation of the `setEnvironmentServices` mutation to updated services for an environment, it is being replaced with `addOrUpdateEnvironmentService` and `deleteEnvironmentService`. This is because the type is being refactored to support additional information, and eventually additional functionality. For now, the actions-handler service will still support the older `setEnvironmentServices` for backwards compatibility for a short period to allow older versions of `lagoon-remote` to still work, but a new version of `lagoon-remote` will be available that will no longer provides the payload that the actions-handler uses. +### Core Registry variable +* The value for `registry` which was previously required by the `lagoon-core` chart is no longer required. If you are using this, you will need to add it under the new `unauthenticatedRegistry` setting when installing `lagoon-remote` in the `lagoon-build-deploy` section of your values file. If you aren't using an actual registry and have the example `disabled-only-use-harbor-via-deploy-controller.invalid` value, then you do not need to do anything except you can now remove the `registry` setting from your core values file. +### bytesUsed +* The environment storage return field named `bytesUsed` is deprecated. The actual value stored is `kibibytes`. A new return field called `kibUsed` exists and should be used, the returned data is the same and both fields are still returned. `bytesUsed` will be removed in a future release, make any adjustments now to use `kibUsed`. This will be a breaking change in a future release. +### addOrUpdateEnvironmentStorage +* `addOrUpdateEnvironmentStorage` is deprecated, `addOrUpdateStorageOnEnvironment` is the replacement to use as it supports the updated input value for `kibUsed`. `addOrUpdateEnvironmentStorage` will be completely removed in a future release. +### activesystems +* The ability to configure projects to use different subsystems for managing deployments/tasks has been removed. Setting any values for the `activeSystems*` fields on the project will have no effect and the fields will be removed in a future release. + diff --git a/docs/releases/2.19.0.md b/docs/releases/2.19.0.md index cb4cd7c496..148d8546e7 100644 --- a/docs/releases/2.19.0.md +++ b/docs/releases/2.19.0.md @@ -4,11 +4,11 @@ * lagoon-build-deploy [core-v2.19.0](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.19.0) * lagoon-core chart [1.45.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.45.0) * lagoon-remote chart [0.89.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-remote-0.89.0) -* lagoon-test chart: [0.57.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-test-0.57.0) - ## Upgrades + There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. ## Deprecations -There are no required actions or considerations with this release + +There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions. diff --git a/docs/releases/2.20.0.md b/docs/releases/2.20.0.md index d2d6a01995..4fa7a8a750 100644 --- a/docs/releases/2.20.0.md +++ b/docs/releases/2.20.0.md @@ -4,29 +4,14 @@ * lagoon-build-deploy [core-v2.20.0](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.20.0) * lagoon-core chart [1.46.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.46.0) * lagoon-remote chart [0.92.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-remote-0.92.0) -* lagoon-test chart: [0.58.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-test-0.58.0) -## Upgrades +## Release Notes +This release was superseded, and the [2.20.1](./2.20.1.md) release is recommended to be installed instead. -This release contains changes that you may need to be aware of. Read carefully before you upgrade. +## Upgrades -### Harbor 2.1.x and earlier -* This release removes the support for Harbor from the Lagoon API. If you're still using the Harbor support in the API, you should NOT upgrade until you have configured your `lagoon-remote` installations to use Harbor instead. See the documentation [here](https://docs.lagoon.sh/installing-lagoon/install-lagoon-remote) and read the section about Harbor. -* We also recommend that if you're using Harbor version 2.1.x and earlier, that you upgrade this as soon as possible. Follow any instructions that Harbor recommend for upgrading. As of this release, `lagoon-remote` has been tested up to Harbor version 2.10.0 (helm chart version 1.14.0). [Lagoon will stop supporting Harbor 2.1.x and earlier in a future release](https://docs.lagoon.sh/releases/2.17.0/#harbor-21-and-earlier-support). +This release was superseded, and the [2.20.1](./2.20.1.md) release is recommended to be installed instead. ## Deprecations -### Kubernetes minimum supported version is now 1.25, tested up to 1.30 -* The minimum supported version of Kubernetes is now 1.25, owing to deprecations in some core [API functions](https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25), and the availability of upstream charts. The v2.20.0 release will not install into an earlier version of Kubernetes, so any Kubernetes upgrades will need to be performed prior to the Lagoon update. - -### Deleted Backups -* When a backup is deleted via the webhook, it will now actually be removed from the API rather than being flagged as deleted. The `Backup` type field `deleted` is deprecated, and will be removed in a future release. Additionally, `includeDeleted` if requested when querying backups will not change the result as there will be no deleted backups to include. - -### API Harbor support -* In [v2.17.0](https://docs.lagoon.sh/releases/2.17.0/#api-harbor-support) we announced that Harbor support in the API was deprecated. This release of Lagoon removes all support for Harbor from the API. See upgrade notes above. - -### DeleteAll/RemoveAll mutations removed -* This release removes all `DeleteAllX` and `RemoveAllX` from the API. These were only ever meant for local development and are no longer relevant. - -### Error handling on deployment triggers -* In the past, if triggering a deployment using any of the `DeployEnvironmentX` mutations and an error was encountered, the API would not return an actual error, just a string that contained the error. This was changed in this release to actually return an error now. As this is a change in behaviour, it may impact any users that may have previously been capturing the string error text and parsing it to check for errors. +This release was superseded, and the [2.20.1](./2.20.1.md) release is recommended to be installed instead. diff --git a/docs/releases/2.20.1.md b/docs/releases/2.20.1.md new file mode 100644 index 0000000000..6e741e9192 --- /dev/null +++ b/docs/releases/2.20.1.md @@ -0,0 +1,35 @@ +#### Release Links +* lagoon [v2.20.1](https://github.com/uselagoon/lagoon/releases/tag/v2.20.1) +* lagoon-ui [core-v2.20.1](https://github.com/uselagoon/lagoon-ui/releases/tag/core-v2.20.1) +* lagoon-build-deploy [core-v2.20.1](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.20.1) +* lagoon-core chart [1.47.0](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-1.47.0) + +## Release Notes + +This release resolved a couple of minor issues discovered after releasing the [2.20.0](./2.20.0.md) release. + +## Upgrades + +This release contains changes that you may need to be aware of. Read carefully before you upgrade. + +### Harbor 2.1.x and earlier +* This release removes the support for Harbor from the Lagoon API. If you're still using the Harbor support in the API, you should NOT upgrade until you have configured your `lagoon-remote` installations to use Harbor instead. See the documentation [here](https://docs.lagoon.sh/installing-lagoon/install-lagoon-remote) and read the section about Harbor. +* We also recommend that if you're using Harbor version 2.1.x and earlier, that you upgrade this as soon as possible. Follow any instructions that Harbor recommend for upgrading. As of this release, `lagoon-remote` has been tested up to Harbor version 2.10.0 (helm chart version 1.14.0). [Lagoon will stop supporting Harbor 2.1.x and earlier in a future release](./2.17.0.md#harbor-21-and-earlier-support). + +## Deprecations + +### Kubernetes minimum supported version is now 1.25, tested up to 1.30 +* The minimum supported version of Kubernetes is now 1.25, owing to deprecations in some core [API functions](https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25), and the availability of upstream charts. The v2.20.0 release will not install into an earlier version of Kubernetes, so any Kubernetes upgrades will need to be performed prior to the Lagoon update. + +### Deleted Backups +* When a backup is deleted via the webhook, it will now actually be removed from the API rather than being flagged as deleted. The `Backup` type field `deleted` is deprecated, and will be removed in a future release. Additionally, `includeDeleted` if requested when querying backups will not change the result as there will be no deleted backups to include. + +### API Harbor support +* In [2.17.0](./2.17.0.md#api-harbor-support) we announced that Harbor support in the API was deprecated. This release of Lagoon removes all support for Harbor from the API. See upgrade notes above. + +### DeleteAll/RemoveAll mutations removed +* This release removes all `DeleteAllX` and `RemoveAllX` from the API. These were only ever meant for local development and are no longer relevant. + +### Error handling on deployment triggers +* In the past, if triggering a deployment using any of the `DeployEnvironmentX` mutations and an error was encountered, the API would not return an actual error, just a string that contained the error. This was changed in this release to actually return an error now. As this is a change in behaviour, it may impact any users that may have previously been capturing the string error text and parsing it to check for errors. + diff --git a/docs/releases/2.21.0.md b/docs/releases/2.21.0.md new file mode 100644 index 0000000000..0379103558 --- /dev/null +++ b/docs/releases/2.21.0.md @@ -0,0 +1,18 @@ +#### Release Links +* lagoon [v2.21.0](https://github.com/uselagoon/lagoon/releases/tag/v2.21.0) +* lagoon-ui [core-v2.21.0](https://github.com/uselagoon/lagoon-ui/releases/tag/core-v2.21.0) +* lagoon-build-deploy [core-v2.21.0](https://github.com/uselagoon/build-deploy-tool/releases/tag/core-v2.21.0) +* lagoon-core chart [x.xx.x](https://github.com/uselagoon/lagoon-charts/releases/tag/lagoon-core-x.xx.0) + +## Release Notes + +tbc + +## Upgrades + +### Upgrade to v2.20.x first +You *must* upgrade to Lagoon v2.20.x before upgrading to v2.21.0. Ensure you read all the linked release notes. + +## Deprecations + +tbc diff --git a/mkdocs.yml b/mkdocs.yml index 11bde1d8ba..935e5c75fa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,6 +49,7 @@ nav: - Solr: docker-images/solr.md - Redis: docker-images/redis.md - Varnish: docker-images/varnish.md + - Deprecated Images: docker-images/deprecated-images.md - Configuring Applications: - Overview: applications/index.md - Options: applications/options.md @@ -363,6 +364,7 @@ plugins: # Shortcut URLs for build and compose errors 'lagoon-build-errors.md': 'using-lagoon-the-basics/lagoon-build-errors-and-warnings.md' 'docker-compose-errors.md': 'using-lagoon-the-basics/lagoon-build-errors-and-warnings.md#docker-compose-errors' + 'deprecated-images.md': 'docker-images/deprecated-images.md' # Redirect existing Gitbooks traffic from lagoon/* prefix 'lagoon/README.md': 'README.md' 'lagoon/getting-started/README.md': 'README.md'