diff --git a/adaptors/collections.md b/adaptors/collections.md index a693df81fc92..bb36846063bf 100644 --- a/adaptors/collections.md +++ b/adaptors/collections.md @@ -21,11 +21,29 @@ the collection (generated from the app at /profile/tokens). Learn more about Collections and common use cases in the [Collections Docs](/documentation/build/collections). -:::caution - -Collections must be created in the -[Platform Admin page](https://docs.openfn.org/documentation/build/collections#managing-collections) -before they can be used. +:::caution Collections is _not_ a long-term data storage solution! + +The OpenFn Collections feature is designed to be a _temporary_ data store or +integration “buffer” during data transfer and processing between digital +systems. + +- This feature is optimized for throughput and performance (rather then + long-term retention and making the data accessible to end users for + querying/analysis) +- Technically, collections is a key value store, so performance for complex + aggregations or queries is either unsupported or inefficient +- Collections doesn't support advance archiving, backup, and recovery features + that you’d want in a long-term storage solution +- Most buffer implementations have retention mechanisms that automatically + expire/purge data after a certain period of time to clear up space and memory + to ensure resources aren’t exhausted for active processing + +Therefore, if you're interested in storing data collected longer term–we +recommend you set up a dedicated database and configure OpenFn to route data to +there as a long-term storage and/or backup option. Ask on +[Community](https://community.openfn.org) or get in touch with +[our support team](mailto://support@openfn.org) to learn more about related +OpenFn services. ::: diff --git a/docs/deploy/options.md b/docs/deploy/options.md index 37bdd4455ea2..bef0b3c53e2a 100644 --- a/docs/deploy/options.md +++ b/docs/deploy/options.md @@ -17,7 +17,7 @@ We're committed to a **no vendor lock-in** experience. ::: -| Pathway | Free | Standard | Dedicated | Do-it-yourself (DIY) | +| Pathway | Free Cloud | OpenFn Cloud | Dedicated | Do-it-yourself (DIY) | | :-------------------: | :------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | | Description | Go live today on OpenFn.org for small scale projects | Scale up and down, pay only for what you need | A dedicated, unrestricted OpenFn installation anywhere in the world on our servers or yours | Deploy and manage your own solutions with OpenFn | | License | Free forever with usage limitations | **SaaS** [plans](https://www.openfn.org/pricing); contact enterprise@openfn.org for custom/invoice agreements | **SDaaS** includes deployment, maintenance, security patches, upgrades, and troubleshooting as a service; contact enterprise@openfn.org | LGPLv3 means use freely as part of any closed or open-source solution, but make all _derivative_ works open source | diff --git a/docs/get-started/security-compliance.md b/docs/get-started/security-compliance.md index 77a1a7ea33fa..68f60c257c29 100644 --- a/docs/get-started/security-compliance.md +++ b/docs/get-started/security-compliance.md @@ -24,21 +24,20 @@ See our main website to learn more about OpenFn ## OpenFn and data storage -In your digital ecosystem, **OpenFn serves as a data processing and transfer +In your digital ecosystem, typically **OpenFn serves as a data processing and transfer solution—not as a data storage service.** As an open source Digital Public Good, OpenFn can be deployed anywhere and -Workflows can be configured to adhere to your organization's specific data +workflows can be configured to adhere to your organization's specific data sharing agreements and security policies. Consult the `Manage Projects` docs pages for more on project and [data storage settings](../manage-projects/io-data-storage.md). -See the below diagram for an example architecture where even the cloud-hosted -OpenFn platform can be configured as a **“zero-persistence” data pipeline** to +See the below diagram for an example architecture where even the OpenFn Cloud can be configured as a **“zero-persistence” data pipeline** to ensure compliance with data security and residency requirements. This enables partners to rapidly configure and pilot projects using the turnkey OpenFn cloud-hosted platform, before migrating to a local deployment when they’re ready to scale. -![Sample Architecture](/img/zero_persistence_architecture.png) +![Sample Architecture](/img/zero-persistence.png) diff --git a/static/img/zero-persistence.png b/static/img/zero-persistence.png new file mode 100644 index 000000000000..c7a4715dc09c Binary files /dev/null and b/static/img/zero-persistence.png differ