Merge pull request #2895 from matthewmcdaniel/batch-demo

OCI Batch Service - Video transcoding asset

Author: johnkarasoulos

app-dev/developer-tools-and-lowcode/batch/video-transcoding/20190530-SPITZRf-0001-Stars of Cephus~small.mp4

@@ -0,0 +1,16 @@
+
+FROM ubuntu:22.04
+
+RUN apt-get update && \
+    apt-get install -y ffmpeg curl python3 python3-pip unzip && \
+    pip3 install oci-cli && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN mkdir -p /video && chmod 777 /video
+
+WORKDIR /video
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

app-dev/developer-tools-and-lowcode/batch/video-transcoding/Dockerfile

@@ -0,0 +1,35 @@
+Copyright (c) 2026 Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

app-dev/developer-tools-and-lowcode/batch/video-transcoding/LICENSE

@@ -0,0 +1,212 @@
+# OCI Batch Demo - Video transcoding pipeline
+
+# Table of Contents
+
+1. [Description](#description)
+2. [Prerequisites](#prerequisites)
+3. [Instructions](#instructions)
+4. [Useful Links](#useful-links)
+5. [License](#license)
+
+# Description
+
+This project contains a small Oracle Cloud Infrastructure (OCI) media-transcoding demo. It builds a Docker image that runs as an OCI Batch task, reads an input video from OCI Object Storage, converts it with `ffmpeg`, and writes the converted output back to Object Storage.
+
+This demo performs the following:
+- Downloads an `.mp4` video from an OCI Object Storage bucket.
+- Converts the `.mp4` to `.avi` using `ffmpeg`.
+- Uploads the resulting `.avi` file to an OCI Object Storage bucket.
+
+# Prerequisites
+
+- An OCI environment with permission to read the input object and create or overwrite the output object in Object Storage.
+- The required OCI IAM setup from the `OCI IAM Setup` section below.
+- A network in which the batch jobs will run.
+- A service gateway to route requests to OCI Object Storage.
+- If you do not have access to a browser, you will need the OCI CLI.
+
+## OCI IAM Setup
+
+
+For this demo, you will need to add IAM policies to authorize your users to modify Batch resources. Furthermore, you will need to add policies that authorizes the Batch service to fetch and upload files to Object Storage. Please follow [this](https://docs.oracle.com/en-us/iaas/Content/oci-batch/iam-policy-example.htm) documentation to create the necessary policies.
+
+Replace the placeholders with your actual compartment name(s).
+
+
+# Instructions
+
+#### Task 1. Create Batch Context
+The batch container is the top-level container for your batch workloads. It consists of the networking, fleets, entitlements, job priorities, and logging configuration.
+
+To create a batch context, go to the batch service and click **Batch Contexts**, then click **Create batch context**. Fill out the following details according to your environment.
+
+ 1. Name
+ 2. Compartment
+ 3. Description
+ 4. VCN
+ 5. Subnet
+ 6. Fleet
+ 7. Entitlements (Optional)
+ 8. Job Priority Configuration (Optional)
+ 9. Logging Configuration
+
+ ![Create Batch Context](./images/create_batch_context.png)
+
+#### Task 2. Create Job Pool
+A job pool is simply a logical container for jobs. When running a job, you will select a job pool to create it under. To create a job pool, you only need the following configurations.
+
+ 1. Name
+ 2. Description
+ 3. Compartment
+
+ ![Create job pool](./images/create_job_pool.png)
+
+#### Task 3. Create Task Profile 
+A task profile is a reusable configuration which defines the resource requirements for your tasks i.e. 1 OCPU 16 GB of Memory. You can create multiple profiles, each corresponding to a different resource requirement. To create a task profile, you need the following configurations:
+
+ 1. Name
+ 2. Description
+ 3. Minimum oCPUs
+ 4. Minimum memory in GBs
+
+ ![Create task profile](./images/create_task_profile.png)
+
+#### Task 4. Set up Local environment and push container images.
+  1. Create container registry in OCI
+  ![Create container registry](./images/create_container_registry.png)
+  2. Go to the directory where the Dockerfile is located.
+  3. Push container image to OCIR. The image should match the region and name of your repository i.e. `iad.ocir.io/convert_mp4_to_avi:latest`
+
+  ```
+  docker build -t <image>:<tag> .
+  docker push <image>:<tag>
+  ```
+  
+  ![Push container to OCIR](./images/push_container_image.png)
+  4. Create Object Storage buckets for input and output video
+
+  ![Create input bucket](./images/create_input_bucket.png)
+
+  ![Create output bucket](./images/create_output_bucket.png)
+
+  5. Upload video file to Object Storage.
+  
+  **NOTE:** If you are using the OCI CLI, you can use this command.
+
+```
+oci os object put --namespace <os-namespace> --file <path/to/file> --bucket-name <name_of_bucket>
+```
+
+
+For the purpose of this demo, we've included a `.mp4` that you may use. The file is located here: 
+
+```
+technology-engineering/app-dev/developer-tools-and-lowcode/batch/20190530-SPITZRf-0001-Stars of Cephus~small.mp4
+```
+
+**Disclaimer:** The video is taken from the NASA Image and Video Library, which can be found here: https://images.nasa.gov/
+
+This demonstration is not endorsed by NASA and is compliant with the NASA Images and Media Usage Guidelines: https://www.nasa.gov/nasa-brand-center/images-and-media/
+
+
+ #### Task 5. Create Task environment
+ A task environment is the runtime configuration for your tasks. To set up a task environment, you will need:
+
+  1. Name
+  2. Description
+  3. Security Context
+      a. User ID - 1
+      b. Group ID - 1
+      c. Filesystem group ID - 1
+      **NOTE:** Setting these as 1 should suffice for this example but should be changed according to your security requirements. 
+  4. Working directory
+
+  ![Create Task Environment](./images/create_task_environment.png)
+
+ #### Task 6. Submit Job
+
+There are various ways to submit a job to the Batch service. For this tutorial, we are going to use the OCI CLI.
+
+  1. Create a file called `task.json`
+  2. Copy and paste the following into `task.json`
+  ```
+  {
+  "batchJobPoolId": "JOB_POOL_OCID",
+  "compartmentId": "COMPARTMENT_ID",
+  "description": "Task to convert video from MP4 to AVI format",
+  "displayName": "convert_video",
+  "maxWaitSeconds": 0,
+  "tasks": [
+      {
+        "batchTaskEnvironmentId": "TASK_ENVIRONMENT_OCID",
+        "batchTaskProfileId": "TASK_PROFILE_OCID",
+        "description": "Task to convert video from MP4 to AVI format",
+        "environmentVariables": [
+          {
+            "name": "INPUT_BUCKET",
+            "value": "input_bucket"
+          },
+          {
+            "name": "INPUT_OBJECT",
+            "value": "input.mp4"
+          },
+        {
+            "name": "OCI_BUCKET",
+            "value": "output_bucket"
+        },
+        {
+            "name": "OUTPUT_FILENAME",
+            "value": "output.avi"
+        },
+        {
+            "name": "OCI_NAMESPACE",
+            "value": "TENANCY_NAMESPACE"
+        },
+        {
+            "name": "OCI_REGION",
+            "value": "REGION"
+        }
+        ],
+        "fleetAssignmentPolicy":
+        {
+            "type": "BEST_FIT"
+          },
+        "name": "convert_video",
+        "type": "COMPUTE"
+      }
+  ],
+  "waitForState": [
+    "ACCEPTED"
+  ],
+  "waitIntervalSeconds": 0
+}
+  ```
+  Replace the following according to your environment:
+  *JOB_POOL_OCID*
+  *COMPARTMENT_ID*
+  *TASK_ENVIRONMENT_OCID*
+  *TASK_PROFILE_OCID*
+  *TENANCY_NAMESPACE*
+  *REGION*
+
+  3. Run the following command
+  
+  ```
+  oci batch batch-job create --from-json file://video_conversion_job.json
+  ```
+
+  The job will take up to 10 minutes to complete. Observe the job in the OCI Console to see what stage it is in.
+#### Task 8. Validate results
+  1. In the OCI Console, go to Object Storage.
+  2. Find the output bucket and validate that the transcoded video is present.
+
+# Useful Links 
+
+- [OCI Batch](https://docs.oracle.com/en-us/iaas/Content/oci-batch/overview.htm)
+
+# License
+
+Copyright (c) 2026 Oracle and/or its affiliates.
+Licensed under the Universal Permissive License (UPL), Version 1.0.
+
+See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE.txt) for more details.

app-dev/developer-tools-and-lowcode/batch/video-transcoding/README.md

@@ -0,0 +1,42 @@
+#!/bin/bash
+set -e
+
+# Environment variables expected:
+# INPUT_BUCKET: 
+# INPUT_OBJECT: 
+# OUTPUT_FILENAME
+# OCI_BUCKET
+# OCI_NAMESPACE
+# OCI_REGION
+
+if [[ -z "$INPUT_BUCKET" || -z "$INPUT_OBJECT" ]]; then
+  echo "Error: INPUT_BUCKET and INPUT_OBJECT environment variables are required."
+  exit 1
+fi
+
+OUTPUT_FILENAME="${OUTPUT_FILENAME:-output.avi}"
+OCI_BUCKET="${OCI_BUCKET:-output_files}"
+
+if [[ -z "$OCI_NAMESPACE" || -z "$OCI_REGION" ]]; then
+  echo "Error: OCI_NAMESPACE and OCI_REGION environment variables are required for upload."
+  exit 2
+fi
+
+echo "Fetching $INPUT_OBJECT from bucket $INPUT_BUCKET (Namespace: $OCI_NAMESPACE, Region: $OCI_REGION) using Resource Principals"
+oci --region "$OCI_REGION" --auth resource_principal os object get \
+  -ns "$OCI_NAMESPACE" \
+  -bn "$INPUT_BUCKET" \
+  --name "$INPUT_OBJECT" \
+  --file input.mp4 \
+
+echo "Converting input.mp4 to $OUTPUT_FILENAME"
+ffmpeg -y -i input.mp4 "$OUTPUT_FILENAME"
+
+echo "Uploading $OUTPUT_FILENAME to OCI Bucket: $OCI_BUCKET (Namespace: $OCI_NAMESPACE, Region: $OCI_REGION) using Resource Principals"
+oci --region "$OCI_REGION" --auth resource_principal os object put \
+  -ns "$OCI_NAMESPACE" \
+  -bn "$OCI_BUCKET" \
+  --file "$OUTPUT_FILENAME" \
+  --name "$OUTPUT_FILENAME" \
+
+echo "Upload complete."