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.

Sign up for GitHub

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

docs: add notes about removal of harbor from api and warning about upgrading #3773

Merged
merged 2 commits into from
Jul 19, 2024
Merged

docs: add notes about removal of harbor from api and warning about upgrading #3773

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a181655
docs: add notes about removal of harbor from api and warning about up…
shreddedbacon Jul 16, 2024
be2e364
docs: update wording around harbor version testing
shreddedbacon Jul 19, 2024
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
1 change: 1 addition & 0 deletions docs/releases/2.17.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ There are no required actions or considerations with this release. As always, we
* 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)
### 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)
### 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.
16 changes: 15 additions & 1 deletion docs/releases/2.20.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,23 @@
This version has not been released yet

## Upgrades
There are no required actions or considerations with this release. As always, we suggest upgrading all minor versions.

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` works with 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).
shreddedbacon marked this conversation as resolved.
Show resolved Hide resolved

## Deprecations

### Deleted Backups
* When a backup is deleted via the webhook, it will now actually 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.