feat: update instance workflow

BB-9946

Author: kaustavb12

.github/workflows/scripts/update_config.py

@@ -0,0 +1,81 @@
+"""
+Update a Tutor instance config.yml with the built image reference.
+
+Usage:
+  python update_config_image.py \
+    --config-file instances/<instance>/config.yml \
+    --service <openedx|mfe> \
+    --image-name <repo/name or repo/name:tag> \
+    --image-tag <tag>
+
+Behavior:
+  - If image-name already contains a ':', it is used as-is.
+  - Otherwise, ':<image-tag>' is appended (image-tag must be provided).
+  - The service name is mapped to the config key to update.
+"""
+
+import argparse
+from pathlib import Path
+
+import yaml
+
+
+def merge_dicts(dict1, dict2):
+    """Given two dict, merge the second dict into the first.
+
+    The dicts can have arbitrary nesting.
+    """
+    for key in dict2:
+        if isinstance(dict2[key], dict):
+            if key in dict1 and key in dict2:
+                merge_dicts(dict1[key], dict2[key])
+            else:
+                dict1[key] = dict2[key]
+        else:
+            # At scalar types, we iterate and merge the
+            # current dict that we're on.
+            dict1[key] = dict2[key]
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="Update config.yml image reference based on service"
+    )
+    parser.add_argument(
+        "--config-file", required=True, help="Path to instance config.yml"
+    )
+    # parser.add_argument(
+    #     "--new-config", required=True, help="Service name, e.g. 'openedx' or 'mfe'"
+    # )
+    return parser.parse_args()
+
+
+def load_yaml(path: Path) -> dict:
+    if not path.exists():
+        return {}
+
+    with path.open("r", encoding="utf-8") as f:
+        data = yaml.safe_load(f) or {}
+
+        if not isinstance(data, dict):
+            raise SystemExit("Root of YAML must be a mapping (object)")
+
+        return data
+
+
+def save_yaml(path: Path, data: dict) -> None:
+    with path.open("w", encoding="utf-8") as f:
+        yaml.safe_dump(data, f, sort_keys=False)
+
+
+def main() -> None:
+    args = parse_args()
+    config_path = Path(args.config_file)
+
+    data = load_yaml(config_path)
+    merge_dicts(data, {"EDX_PLATFORM_VERSION": "release/ulmo"})
+    save_yaml(config_path, data)
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/update-instance.yml

@@ -0,0 +1,80 @@
+name: Update Instance
+
+on:
+  workflow_call:
+    inputs:
+      INSTANCE_NAME:
+        description: "Instance to build"
+        required: true
+        type: string
+      RUNNER_WORKFLOW_LABEL:
+        description: 'The label of the runner workflow to run'
+        required: false
+        type: string
+        default: "ubuntu-latest"
+    secrets:
+      SSH_PRIVATE_KEY:
+        description: "Private SSH key for accessing private repositories"
+        required: true
+
+jobs:
+  update-instance:
+    needs:
+      - generate-env-dir
+    runs-on: ${{ inputs.RUNNER_WORKFLOW_LABEL }}
+    concurrency:
+      group: update-instance-${{ inputs.INSTANCE_NAME }}
+      cancel-in-progress: false
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'pip'
+
+      - name: Install PyYAML
+        run: pip install pyyaml
+
+      - name: Setup SSH agent
+        uses: webfactory/ssh-agent@v0.9.0
+        with:
+          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+
+      - name: Add GitHub to known hosts
+        run: ssh-keyscan github.com >> ~/.ssh/known_hosts
+
+      - name: Configure git
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Checkout workflow scripts
+        uses: actions/checkout@v4
+        with:
+          repository: open-craft/phd-cluster-template
+          ref: main
+          path: workflow-scripts
+
+      - name: Update config.yml with provided configs
+        env:
+          CONFIG_FILE: instances/${{ inputs.INSTANCE_NAME }}/config.yml
+          SCRIPT_PATH: workflow-scripts/.github/workflows/scripts/update_config.py
+        run: |
+          # Update config.yml
+          python "$SCRIPT_PATH" \
+            --config-file "$CONFIG_FILE"
+
+      - name: Commit and push changes
+        run: |
+          git add instances/${{ inputs.INSTANCE_NAME }}
+
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "chore: update config for ${{ inputs.INSTANCE_NAME }}"
+            git pull origin ${{ github.ref_name }} --rebase
+            git push
+          fi