EnvironmentVersionRecord_RHOAI.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "7b30096b-bd86-4a57-96dd-2c39f618af29",
   "metadata": {},
   "source": [
    "# Environment and Version Capture in JupyterHub on Red Hat OpenShift AI\n",
    "\n",
    "This notebook cell captures essential information about the current environment, including:\n",
    "- **OpenShift related environment variables**\n",
    "- **OpenShift cluster version**\n",
    "- **Python dependencies**\n",
    "\n",
    "**Usage**:\n",
    "\n",
    "1. Execute this cell to capture and save the environment details.\n",
    "2. The output will be saved to a file named 'environment_record.txt' in your notebook's directory.\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e0994c0d-b205-4b5b-bcc8-ba3bdf0fabca",
   "metadata": {},
   "outputs": [],
   "source": [
    "\n",
    "import os\n",
    "import subprocess\n",
    "import time\n",
    "import sys\n",
    "\n",
    "def capture_environment():\n",
    "    \"\"\"\n",
    "    This function captures various details about the current environment:\n",
    "    - OpenShift related environment variables\n",
    "    - The OpenShift cluster version\n",
    "    - Installed Python dependencies\n",
    "\n",
    "    It writes all this information into a single text file for easy reference.\n",
    "    \"\"\"\n",
    "    # Initialize the output list with a header and creation date\n",
    "    output = [\n",
    "        \"Environment and Version Record for JupyterHub on Red Hat OpenShift AI\\n\",\n",
    "        f\"Created On: {time.strftime('%Y-%m-%d', time.localtime())}\\n\\n\"\n",
    "    ]\n",
    "\n",
    "    # Capture OpenShift related environment variables\n",
    "    output.append(\"--- Environment Variables ---\\n\\n\")\n",
    "    for var, value in os.environ.items():\n",
    "        if 'OPENSHIFT' in var or 'RHODS' in var:\n",
    "            output.append(f\"{var}: {value}\\n\")\n",
    "\n",
    "    # Capture OpenShift cluster version\n",
    "    output.append(\"\\n--- OpenShift Cluster Version ---\\n\")\n",
    "    try:\n",
    "        # Run the 'oc version' command to get OpenShift version details\n",
    "        result = subprocess.run(['oc', 'version'], capture_output=True, text=True, check=True)\n",
    "        output.append(result.stdout.strip() + \"\\n\")\n",
    "    except FileNotFoundError:\n",
    "        output.append(\"The 'oc' command is not found. Ensure it's installed and in your PATH.\\n\")\n",
    "    except subprocess.CalledProcessError as e:\n",
    "        output.append(f\"Error while running 'oc version': {e.stderr.strip()}\\n\")\n",
    "\n",
    "    # Capture Python dependencies using pip-chill\n",
    "    output.append(\"\\n--- Python Dependencies ---\\n\")\n",
    "    try:\n",
    "        # Install pip-chill if not already present\n",
    "        subprocess.run([sys.executable, \"-m\", \"pip\", \"install\", \"pip-chill\"], check=True, capture_output=True, text=True)\n",
    "        # Use pip-chill to list dependencies\n",
    "        dependencies = subprocess.run([\"pip-chill\"], capture_output=True, text=True, check=True).stdout\n",
    "        output.append(dependencies + \"\\n\")\n",
    "    except Exception as e:\n",
    "        output.append(f\"Failed to capture dependencies: {e}\\n\")\n",
    "\n",
    "    # Write all collected information to a text file\n",
    "    with open(\"environment_record.txt\", \"w\") as file:\n",
    "        file.writelines(output)\n",
    "\n",
    "    print(\"Environment details have been recorded to 'environment_record.txt'.\")\n",
    "\n",
    "# Execute the environment capture\n",
    "capture_environment()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f290d0b2-0754-48fa-aa6a-8834d5d2743f",
   "metadata": {},
   "source": [
    "## Best Practice: Clearing Outputs Before Committing\n",
    "\n",
    "Before committing the notebook to a version control system like Git, it's advisable to clear all outputs. This practice:\n",
    "\n",
    "- **Reduces File Size:** Makes the repository smaller and faster to clone.\n",
    "- **Maintains Privacy:** Prevents accidental sharing of output data that might contain sensitive information.\n",
    "- **Improves Clarity:** Keeps the repository focused on the code rather than transient results.\n",
    "\n",
    "**Steps to Clear Outputs in JupyterLab:**\n",
    "\n",
    "1. **Open the Notebook:** Navigate to and open the notebook `EnvironmentVersionRecord_RHOAI.ipynb`.\n",
    "   \n",
    "2. **Clear Outputs:** From the menu, select **Edit** > **Clear Outputs All Cells**. This command will remove all cell outputs in the notebook.\n",
    "\n",
    "3. **Save Notebook:** After clearing the outputs, save the notebook. You can do this by:\n",
    "   - Selecting **File** > **Save Notebook**\n",
    "   - Or by using the keyboard shortcut `Ctrl + S` (or `Cmd + S` on macOS).\n",
    "   \n",
    "   This ensures that when you commit the notebook, it will save without any executed outputs, preserving a clean state for future users or for yourself when you check out this version later."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e883dc38-288a-4a41-a10d-6a66f7936b27",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.11",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}