From d48ad445927a12adaded3a9db6445aa99ff48a62 Mon Sep 17 00:00:00 2001 From: yenchiafeng Date: Thu, 11 Dec 2025 09:44:26 -0800 Subject: [PATCH] docs: Add How to Locate and Trigger the Plan v5 Routine (Lowside and Highside) --- ...gger-the-plan-v5-routine-lowside-and-hi.md | 113 ++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 docs/deployment/how-to-locate-and-trigger-the-plan-v5-routine-lowside-and-hi.md diff --git a/docs/deployment/how-to-locate-and-trigger-the-plan-v5-routine-lowside-and-hi.md b/docs/deployment/how-to-locate-and-trigger-the-plan-v5-routine-lowside-and-hi.md new file mode 100644 index 0000000..448b92c --- /dev/null +++ b/docs/deployment/how-to-locate-and-trigger-the-plan-v5-routine-lowside-and-hi.md @@ -0,0 +1,113 @@ +# How to Locate and Trigger the Plan v5 Routine (Lowside and Highside) + +## Overview + +This guide explains where the Plan v5 routine is currently located and how to trigger it for both lowside and highside environments. It is based on the available Slack Q&A and notes where additional information is still required. + +## Prerequisites + +- Access to the internal systems or services where Plan v5 is deployed. +- Appropriate permissions to trigger routines in both lowside and highside environments. +- Knowledge of your organization’s standard deployment and execution workflows (for example, how you typically run or trigger routines/services in each environment). + +> Note: The original Slack answer referenced an internal discussion thread for details. That content is not fully available here, so some steps and commands are inferred and may be incomplete. + +## Current Location of Plan v5 Routine + +The Slack answer indicates that the details about the Plan v5 routine’s location are documented in an internal thread. However, the exact: + +- service name, +- repository path, +- deployment location, and +- configuration files + +are not explicitly provided in the available text. + +You will likely find the Plan v5 routine: + +- In the same service or repository where earlier Plan versions (e.g., Plan v4) are defined, or +- In a dedicated “plan” or “planning” service/module in your codebase or orchestration configuration. + +To confirm the exact location, you may need to: + +1. Search your code repository for references to `plan_v5`, `plan-v5`, or similar identifiers. +2. Check your deployment or orchestration configuration (for example, Kubernetes manifests, Terraform modules, or internal configuration files) for a Plan v5 entry. +3. Review your internal documentation or runbooks for “Plan v5” or “planning routine v5”. + +## How to Trigger Plan v5 (Lowside and Highside) + +The Slack answer does not provide explicit commands or API calls. Based on common patterns, Plan v5 is likely triggered in one of the following ways: + +1. **Via an API endpoint** + - A REST or gRPC endpoint such as: + - `POST /plan/v5` + - `POST /api/plan/v5` + - You would call this endpoint with the appropriate payload and authentication for: + - Lowside (typically a development or lower-security environment) + - Highside (typically a production or higher-security environment) + +2. **Via a command-line interface (CLI) or internal tool** + - A command such as: + - `plan-cli run --version v5 --env lowside` + - `plan-cli run --version v5 --env highside` + - Or a similar internal tool that accepts a `--plan-version` or `--routine` parameter. + +3. **Via a workflow/orchestration system** + - Triggering a job or workflow named something like: + - `plan-v5-lowside` + - `plan-v5-highside` + - Through your internal orchestration UI or automation scripts. + +Because the exact mechanism is not specified, you should: + +1. Check your existing Plan v4 trigger mechanism and look for a v5 variant. +2. Search your internal documentation for “Plan v5 trigger” or “Plan v5 routine”. +3. Ask your platform or infrastructure team which endpoint, job, or command corresponds to Plan v5 in each environment. + +## Important Notes and Caveats + +- **Environment separation:** Lowside and highside are typically isolated; ensure you are using the correct endpoints, credentials, and configuration for each environment. +- **Version coexistence:** If Plan v4 and Plan v5 both exist, confirm whether: + - v5 is fully production-ready, or + - v5 is experimental and should only be used in lowside or specific test scenarios. +- **Access control:** Highside environments often have stricter access controls. You may need additional approvals or roles to trigger Plan v5 there. +- **Configuration differences:** Plan v5 may rely on different configuration flags, feature toggles, or model versions than earlier plans. Verify configuration before triggering in highside. + +## Troubleshooting + +If you cannot find or trigger Plan v5: + +1. **Cannot locate the routine:** + - Search your repositories for `plan_v5`, `plan-v5`, or `v5` in planning-related modules. + - Check your service or job registry (for example, internal service catalog, CI/CD pipelines, or job scheduler) for a Plan v5 entry. + - Verify whether Plan v5 has actually been deployed to both lowside and highside. + +2. **Trigger fails or returns errors:** + - Confirm you are using the correct environment-specific endpoint or command. + - Check authentication/authorization (tokens, roles, VPN, or network access). + - Review logs for the Plan v5 service or job to identify configuration or dependency issues. + +3. **Behavior differs between lowside and highside:** + - Compare configuration files, feature flags, and model versions between environments. + - Ensure both environments are running the same Plan v5 build or release. + +## Information Still Needed + +To complete this documentation with precise, actionable steps, the following details are required from the internal thread or system owners: + +- Exact location of the Plan v5 routine: + - Service name + - Repository path + - Configuration files or modules +- Exact method to trigger Plan v5: + - API endpoint(s) and example requests, or + - CLI command(s) and flags, or + - Orchestration job/workflow names and how to invoke them +- Any environment-specific differences between lowside and highside: + - Different URLs, credentials, or feature flags + - Any restrictions on using Plan v5 in highside + +Once those details are available, they should be added to the “Current Location of Plan v5 Routine” and “How to Trigger Plan v5” sections as concrete commands, URLs, and examples. + +--- +*Source: [Original Slack thread](https://distylai.slack.com/archives/impl-tower-sales/p1764889500660159)*