Merge branch 'master' of github.com:Shuffle/shuffle-docs

Author: 0x0elliot

articles/2.1.0-rc2.md

@@ -0,0 +1,67 @@
+# Shuffle 2.1.0 release candidate: Deterministic AI Agents, High Availability and Datastore Automation
+
+**2.1.0 Release Candidate**: May 7th - June 17th, 2025
+
+![image](https://github.com/user-attachments/assets/10ce7e2d-eabe-4418-bb64-67401f2f6733)
+
+## ✅ Important Updates
+There are more important updates on using deterministic, controlled AI Agents and LLM's coming in the full 2.1.0 release. 
+We will be running a few release candidates before 2.1.0 is properly released at the start of August.  
+
+- *High Availability for Orborus:*  
+  Added high availability and tracking for Orborus in both cloud and on-prem environments, improving reliability and failover support.
+
+- *Datastore Category Automation and Publishing*
+  Making Datastore Categories public is now available, and can be controlled on the [/admin?tab=datastore](https://shuffler.io/admin?tab=datastore) page.
+  This system allows e.g. subscribing to others' published threat lists or publishing your own detection rulesets. 
+
+![image](https://github.com/user-attachments/assets/94343581-a3e4-4f23-acef-8a29e7ee7385)
+
+  Datastore Automation can be controlled from within specific categories. For now, it supports running workflows and sending webhooks natively.
+
+![image](https://github.com/user-attachments/assets/4cbb1c63-ea3f-4b1f-b1b0-605daab81952)
+
+## 🚀 Features
+
+- *Singul*:
+Singul is now able to upload translations automatically to the Shuffle Datastore. It is additionally getting a frontend library to manage apps and authentication in third-party platforms.
+
+- *Partner & Use Case System:*  
+  Introduced a new system for managing partners and use cases, enhancing organizational and workflow flexibility.
+
+- *Bulk Datastore Updates:*  
+  Now allows setting datastore entries in bulk. Datastore has been updated with categories able to handle hundreds of thousands of entries.
+
+- *Sub-organization Management Improvements:*  
+  - Sub-organization deletion and associated cache management.
+  - Ability to skip SSO for admin on sub-organizations, simplifying admin experience.
+  - Added a button with verification to the UI to delete a suborg
+ 
+![image](https://github.com/user-attachments/assets/191d0bb9-b57e-48f4-8ab3-d4430eaaca22)
+
+## 🐞 Bug Fixes
+
+- *Multi-tenant Workflow Loading:*  
+  Resolved issues where sub-organization workflows would incorrectly load distributed workflows from the parent organization, preventing reference mismatches.
+
+- *Organization Cache Fixes:*  
+  - Multiple fixes improving cache handling, particularly for large organizations and during org region redirection.
+  - Ensured sub-organization cache is properly deleted when authentication is updated.
+
+- *App Activation in Suborgs:*  
+  Fixed a problem where apps with the same app_name would not activate correctly in sub-organizations.
+
+- *Failover Fixes:*  
+  Addressed failover edge cases for Orborus, improving stability.
+
+- *Region Propagation:*  
+  Fixed issues with region information not propagating correctly across the platform.
+
+## 🔧 Other Updates
+
+- *Minor Print and Documentation Edits:*  
+  Various improvements in print statements and minor documentation updates.
+
+- *Performance Optimizations:*  
+  - Various cache optimizations for faster loading of large organizations.
+  - Removed unnecessary organization cache before request redirection.

articles/Shuffle_Pricing.md

@@ -0,0 +1,19 @@
+![Shuffle Pricing](https://github.com/frikky/shuffle-docs/blob/master/assets/Shuffle_Pricing.png?raw=true)
+
+# Overview
+
+Shuffle's pricing is primarily based on two things:
+1. License - Based on App-Runs.
+2. Support - Based on Post-Onboarding Needs.
+
+We also have [training](https://shuffler.io/training) and [professional services](https://shuffler.io/professional-services), but they are optional and available if you need them.
+
+## What are App-Runs?
+
+App-runs are the actual actions that run inside your workflow. They are a simple and transparent way to track the platform's usage.
+
+For example, the workflow below has many nodes or 'actions'. Whenever it runs, these actions are counted as app-runs.
+
+Only the actions that run are counted; the rest are ignored and not counted. In the workflow below, even though it has many actions, if it stops at the (red) filter action, only 4 app-runs are counted.
+
+![Shuffle Pricing](https://github.com/frikky/shuffle-docs/blob/master/assets/Shuffle_Pricing_Workflow.png?raw=true)

assets/Shuffle_Pricing.png

@@ -243,6 +243,98 @@ curl https://shuffler.io/api/v1/workflows/{workflow_id}/executions/{execution_id
 {"success": true}
 ```
 
+## Datastore API
+Datastore is a persistent storage mechanism you can use for workflows to talk to each other between executions, or for normal storage. Below are the endpoints related to datastore (cache) creation, listing, deletion and more. This API is available to Python apps by using self.set_cache("key", "value") and self.get_cache("key")
+
+### Add a key
+To add a key to a specific category, add `"category": "name"` to the JSON body.
+
+Methods: POST, PUT
+
+```bash
+curl https://shuffler.io/api/v1/orgs/{org_id}/set_cache -H "Authorization: Bearer APIKEY" -d '{"key":"hi", "value":"1234", "category": "category"}'
+```
+
+
+**Success response** 
+```json
+{"success": true}
+```
+
+### Add multiple keys
+To add a key to a specific category, add `"category": "name"` to the JSON body. Only keys of the first discovered category will be added.
+
+Methods: POST, PUT
+
+```bash
+curl https://shuffler.io/api/v2/datastore?bulk=true -H "Authorization: Bearer APIKEY" -d '[{"key":"hi", "value":"1234", "category": "category"}]'
+```
+
+
+**Success response** 
+```json
+{"success": true}
+```
+
+
+### Get a key
+Search for a cache key. For keys set in a workflow, it may unavailable with the normal API, and require execution_id & authorization in the JSON body.
+
+To get a key from a specific category, add `"category": "name"` to the JSON body.
+ 
+Methods: POST
+
+```bash
+curl https://shuffler.io/api/v1/orgs/{org_id}/get_cache -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
+```
+
+
+**Success response** 
+```json
+{"success":false,"workflow_id":"99951014-f0b1-473d-a474-4dc9afecaa75","execution_id":"f0b2b4e9-90ca-4835-bdd4-2889ef5f926f","org_id":"2e7b6a08-b63b-4fc2-bd70-718091509db1","key":"hi","value":"1234"}
+```
+
+
+### List all keys
+List existing datastore (cache) keys. By default, this will include the 50 last modified keys from any category. 
+
+To list keys from a specific category, ?category=<name> to the URL.
+
+Available queries:
+- top: default 50. How many keys to return.
+- cursor: to get the next page
+- category: the category to get
+
+Methods: GET
+
+```bash
+curl https://shuffler.io/api/v1/orgs/{org_id}/list_cache -H "Authorization: Bearer APIKEY"
+```
+
+
+**Success response** 
+```json
+{"success":true,"keys":[{"success":false,"workflow_id":"99951014-f0b1-473d-a474-4dc9afecaa75","execution_id":"f0b2b4e9-90ca-4835-bdd4-2889ef5f926f","org_id":"2e7b6a08-b63b-4fc2-bd70-718091509db1","key":"hi","value":"1234"}]}
+```
+
+### Delete a key
+Deletes a key, completely removing all references to it. 
+
+To delete a key from a specific category, add `"category": "name"` to the JSON body.
+
+Methods: DELETE
+
+```bash
+curl https://shuffler.io/api/v1/orgs/{org_id}/delete_cache  -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
+```
+
+
+**Success response** 
+```json
+{"success": true}
+```
+
+
 ## App API
 Apps are the building blocks used in [workflows](/docs/apps#workflows), as they contain the actions to be executed. First of all, there are two types of apps:
 
@@ -589,83 +681,6 @@ curl https://shuffler.io/api/v1/users/generateapikey -H "Authorization: Bearer A
 {"success": true, "username": "username", "verified": false, "apikey": "new apikey"}
 ```
 
-## Datastore API
-Datastore is a persistent storage mechanism you can use for workflows to talk to each other between executions, or for normal storage. Below are the endpoints related to datastore (cache) creation, listing, deletion and more. This API is available to Python apps by using self.set_cache("key", "value") and self.get_cache("key")
-
-### Add a key
-To add or edit a cache key use 
-
-To add a key to a specific category, add `"category": "name"` to the JSON body.
-
-Methods: POST, PUT
-
-```bash
-curl https://shuffler.io/api/v1/orgs/{org_id}/set_cache -H "Authorization: Bearer APIKEY" -d '{"key":"hi", "value":"1234"}'
-```
-
-
-**Success response** 
-```json
-{"success": true}
-```
-
-### Get a key
-Search for a cache key. For keys set in a workflow, it may unavailable with the normal API, and require execution_id & authorization in the JSON body.
-
-To get a key from a specific category, add `"category": "name"` to the JSON body.
- 
-Methods: POST
-
-```bash
-curl https://shuffler.io/api/v1/orgs/{org_id}/get_cache -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
-```
-
-
-**Success response** 
-```json
-{"success":false,"workflow_id":"99951014-f0b1-473d-a474-4dc9afecaa75","execution_id":"f0b2b4e9-90ca-4835-bdd4-2889ef5f926f","org_id":"2e7b6a08-b63b-4fc2-bd70-718091509db1","key":"hi","value":"1234"}
-```
-
-
-### List all keys
-List existing datastore (cache) keys. By default, this will include the 50 last modified keys from any category. 
-
-To list keys from a specific category, ?category=<name> to the URL.
-
-Available queries:
-- top: default 50. How many keys to return.
-- cursor: to get the next page
-- category: the category to get
-
-Methods: GET
-
-```bash
-curl https://shuffler.io/api/v1/orgs/{org_id}/list_cache -H "Authorization: Bearer APIKEY"
-```
-
-
-**Success response** 
-```json
-{"success":true,"keys":[{"success":false,"workflow_id":"99951014-f0b1-473d-a474-4dc9afecaa75","execution_id":"f0b2b4e9-90ca-4835-bdd4-2889ef5f926f","org_id":"2e7b6a08-b63b-4fc2-bd70-718091509db1","key":"hi","value":"1234"}]}
-```
-
-### Delete a key
-Deletes a key, completely removing all references to it. 
-
-To delete a key from a specific category, add `"category": "name"` to the JSON body.
-
-Methods: DELETE
-
-```bash
-curl https://shuffler.io/api/v1/orgs/{org_id}/delete_cache  -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
-```
-
-
-**Success response** 
-```json
-{"success": true}
-```
-
 ## File API
 Below are the endpoints related to file creation, uploading, downloading, listing and more. This API is available to Python apps by using self.set_files(files) and self.get_file(file_id)
 
@@ -1154,4 +1169,4 @@ As you can see, I triggered this Singul execution through the Singul app (not th
 <img src="https://github.com/frikky/shuffle-docs/blob/master/assets/singul-debugging-step2.png?raw=true">
 
 
-Based on the output, and the input mentioned in "Body", you should be able to figure out what is going on here.
+Based on the output, and the input mentioned in "Body", you should be able to figure out what is going on here.