From 9b7b064110bf471b541ed3c37a0208eaefddda45 Mon Sep 17 00:00:00 2001 From: mishaschwartz <4380924+mishaschwartz@users.noreply.github.com> Date: Wed, 27 Nov 2024 10:52:04 -0500 Subject: [PATCH] deprecate stac populator --- CHANGES.md | 4 ++++ .../stac-populator/default.env | 0 .../stac-populator/docker-compose-extra.yml | 0 birdhouse/optional-components/README.rst | 16 ---------------- 4 files changed, 4 insertions(+), 16 deletions(-) rename birdhouse/{optional-components => deprecated-components}/stac-populator/default.env (100%) rename birdhouse/{optional-components => deprecated-components}/stac-populator/docker-compose-extra.yml (100%) diff --git a/CHANGES.md b/CHANGES.md index c2dcd236b..569518328 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -22,6 +22,10 @@ Update description of the `configs` subcommand to better describe it. The description when calling `bin/birdhouse -h` now matches the description when calling `bin/birdhouse configs -h` +- Deprecate `stac-populator` optional component + + This component has not been functional since it was deprecated in https://github.com/crim-ca/stac-populator/pull/12 + [2.6.1](https://github.com/bird-house/birdhouse-deploy/tree/2.6.1) (2024-11-22) ------------------------------------------------------------------------------------------------------------------ diff --git a/birdhouse/optional-components/stac-populator/default.env b/birdhouse/deprecated-components/stac-populator/default.env similarity index 100% rename from birdhouse/optional-components/stac-populator/default.env rename to birdhouse/deprecated-components/stac-populator/default.env diff --git a/birdhouse/optional-components/stac-populator/docker-compose-extra.yml b/birdhouse/deprecated-components/stac-populator/docker-compose-extra.yml similarity index 100% rename from birdhouse/optional-components/stac-populator/docker-compose-extra.yml rename to birdhouse/deprecated-components/stac-populator/docker-compose-extra.yml diff --git a/birdhouse/optional-components/README.rst b/birdhouse/optional-components/README.rst index 2210bbe1b..43375f2cc 100644 --- a/birdhouse/optional-components/README.rst +++ b/birdhouse/optional-components/README.rst @@ -321,22 +321,6 @@ correctly. This component also customizes the JupyterHub config according to the .. |test_cowbird_jupyter| replace:: notebook -Populate STAC catalog with sample data --------------------------------------------------------- - -STAC Populator contains the workflow logic to ingest sample STAC item into the STAC catalog. - -Once enabled in the stack, this component will run automatically on stack boot time in order to populate the catalog. -On stack initialization, STAC item generation workflows will run for ``STAC_ASSET_GENERATOR_TIMEOUT`` seconds in order -to populate the catalog with sample data. Change this timeout as needed, as there are no impact on the stack boot, -except time required to feed the catalog. - -To enable this optional-component: - -- Edit ``env.local`` (a copy of `env.local.example`_) -- Add ``./optional-components/stac-populator`` to ``BIRDHOUSE_EXTRA_CONF_DIRS``. - - Allow public access to STAC catalog --------------------------------------------------------