| Name | rhoshift JSON |
| Version |
0.1.5.1
JSON |
| download |
| home_page | None |
| Summary | RHOAI tool kit for managing and upgrading RHOAI |
| upload_time | 2025-07-25 12:22:28 |
| maintainer | None |
| docs_url | None |
| author | Milind Waykole |
| requires_python | >=3.8 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
rhoai
openshift
upgrade
toolkit
red hat
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
boto3
botocore
kubernetes
openshift-client
python-dotenv
requests
urllib3
colorlog
pyfiglet
setuptools
typing-extensions
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RHOAI Tool Kit
A comprehensive toolkit for managing and upgrading Red Hat OpenShift AI (RHOAI) installations with parallel installation support.
## 📋 Table of Contents
- [Features](#-features)
- [Project Structure](#-project-structure)
- [Installation](#-installation)
- [Usage](#-usage)
- [Logging](#-logging)
- [Configuration](#-configuration)
- [Development](#-development)
- [Troubleshooting](#-troubleshooting)
- [Contributing](#-contributing)
## ✨ Features
- Install single or multiple OpenShift operators
- Parallel installation for faster deployments
- Configurable timeouts and retries
- Comprehensive logging system
- Supports:
- Serverless Operator
- Service Mesh Operator
- Authorino Operator
- cert-manager Operator (Kueue dependency)
- RHOAI Operator
- Kueue Operator
- KEDA (Custom Metrics Autoscaler) Operator
- **Automatic Dependency Resolution**: Installs required operators in correct order
- **Smart Validation**: Pre-installation compatibility and conflict detection
## 📁 Project Structure
```
rhoshift/
├── rhoshift/ # Main package directory
│ ├── __init__.py
│ ├── main.py # CLI entry point
│ ├── cli/ # Command-line interface
│ │ ├── __init__.py
│ │ ├── args.py # Argument parsing
│ │ └── commands.py # Command implementations
│ ├── logger/ # Logging utilities
│ │ ├── __init__.py
│ │ └── logger.py # Logging configuration
│ └── utils/ # Core utilities
│ ├── __init__.py
│ ├── constants.py # Constants and configurations
│ ├── operator.py # Operator management
│ └── utils.py # Utility functions
├── run_upgrade_matrix.sh # Upgrade matrix execution script
├── upgrade_matrix_usage.md # Upgrade matrix documentation
├── pyproject.toml # Project dependencies and configuration
└── README.md # This document
```
## 📋 Components
### Core Components
- **CLI**: Command-line interface for operator management
- **Logger**: Logging configuration and utilities (logs to `/tmp/rhoshift.log`)
- **Utils**: Core utilities and operator management logic
### RHOAI Components
- **RHOAI Upgrade Matrix**: Utilities for testing RHOAI upgrades
- **Upgrade Matrix Scripts**: Execution and documentation for upgrade testing
### Maintenance Scripts
- **Cleanup Scripts**: Utilities for cleaning up operator installations
- **Worker Node Scripts**: Utilities for managing worker node configurations
## 🚀 Installation
1. Clone the repository:
```bash
git clone https://github.com/mwaykole/O.git
cd O
```
2. Install dependencies:
```bash
pip install -e .
```
3. Verify installation:
```bash
rhoshift --help
```
### 🔧 New CLI Options
```bash
rhoshift --help
usage: rhoshift [-h] [--serverless] [--servicemesh] [--authorino] [--cert-manager]
[--rhoai] [--kueue] [--keda] [--all] [--cleanup] [--deploy-rhoai-resources]
[--oc-binary OC_BINARY] [--retries RETRIES] [--retry-delay RETRY_DELAY]
[--timeout TIMEOUT] [--rhoai-channel RHOAI_CHANNEL] [--raw RAW]
[--rhoai-image RHOAI_IMAGE] [-v]
Operator Selection:
--cert-manager Install cert-manager Operator
--kueue Install Kueue Operator (auto-installs cert-manager)
--keda Install KEDA (Custom Metrics Autoscaler) Operator
[... other options ...]
```
## 💻 Usage
### Basic Commands
```bash
# Install single operator
rhoshift --serverless
# Install multiple operators
rhoshift --serverless --servicemesh
# Install cert-manager operator
rhoshift --cert-manager
# Install Kueue operator (automatically installs cert-manager dependency)
rhoshift --kueue
# Install KEDA (Custom Metrics Autoscaler) operator
rhoshift --keda
# Install RHOAI with raw configuration
rhoshift --rhoai --rhoai-channel=<channel> --rhoai-image=<image> --raw=True
# Install RHOAI with Serverless configuration
rhoshift --rhoai --rhoai-channel=<channel> --rhoai-image=<image> --raw=False --all
# Install all operators (including Kueue and KEDA)
rhoshift --all
# Create DSC and DSCI with RHOAI operator installation
rhoshift --rhoai --deploy-rhoai-resources
# Clean up all operators
rhoshift --cleanup
```
### 🔗 Operator Dependencies & Validation
The tool automatically handles operator dependencies and provides smart validation:
#### **Automatic Dependency Resolution**
- **Kueue** requires **cert-manager**: Installing Kueue automatically includes cert-manager
- Dependencies are installed in the correct order to prevent failures
- Missing dependencies are automatically detected and added
```bash
# This command will install BOTH cert-manager AND Kueue (in correct order)
rhoshift --kueue
# You'll see output like:
# 📦 Auto-adding dependency: cert-manager
# Installing 2 operators in order: cert-manager → kueue
```
#### **Smart Validation**
- **Compatibility Checking**: Warns about potential operator conflicts
- **Namespace Validation**: Detects if operators conflict in shared namespaces
- **Pre-Installation Validation**: Catches issues before installation starts
```bash
# Example validation warnings:
# ⚠️ Note: Kueue and KEDA may have resource conflicts. Monitor for admission webhook issues.
# ⚠️ Installation order will be adjusted for dependencies: cert-manager → kueue
```
#### **Supported Dependencies**
| Primary Operator | Required Dependencies |
|-----------------|----------------------|
| Kueue | cert-manager |
> **Note**: When installing Kueue individually (`--kueue`), you will see dependency warnings. For automatic dependency installation, use batch mode (`--cert-manager --kueue`) or install dependencies manually first.
### Advanced Options
```bash
# Custom oc binary path
rhoshift --serverless --oc-binary /path/to/oc
# Custom timeout (seconds)
rhoshift --all --timeout 900
# Install queue management and auto-scaling operators together
# (cert-manager will be automatically installed as Kueue dependency)
rhoshift --kueue --keda
# Install complete ML/AI stack with queue management
rhoshift --rhoai --kueue --keda --rhoai-channel=stable --rhoai-image=<image>
# Install only cert-manager for other uses
rhoshift --cert-manager
# Verbose output
rhoshift --all --verbose
```
### Upgrade Matrix Testing
To run the upgrade matrix tests, you can use either method:
1. Using the shell script:
```bash
./run_upgrade_matrix.sh [options] <current_version> <current_channel> <new_version> <new_channel>
```
2. Using the Python command:
```bash
run-upgrade-matrix [options] <current_version> <current_channel> <new_version> <new_channel>
```
Options:
- `-s, --scenario`: Run specific scenario(s) (serverless, rawdeployment, serverless,rawdeployment)
- `--skip-cleanup`: Skip cleanup before each scenario
- `--from-image`: Custom source image path
- `--to-image`: Custom target image path
Example:
```bash
# Using shell script
./run_upgrade_matrix.sh -s serverless -s rawdeployment 2.10 stable 2.12 stable
# Using Python command
run-upgrade-matrix -s serverless -s rawdeployment 2.10 stable 2.12 stable
```
## 📝 Logging
The toolkit uses a comprehensive logging system:
- Logs are stored in `/tmp/rhoshift.log`
- Console output shows INFO level and above
- File logging captures DEBUG level and above
- Automatic log rotation (10MB max size, 5 backup files)
- Colored output in supported terminals
To view logs:
```bash
tail -f /tmp/rhoshift.log
```
## 🔧 Configuration
### Environment Variables
- `LOG_FILE_LEVEL`: Set file logging level (default: DEBUG)
- `LOG_CONSOLE_LEVEL`: Set console logging level (default: INFO)
### Command Options
- `--oc-binary`: Path to oc CLI (default: oc)
- `--retries`: Max retry attempts (default: 3)
- `--retry-delay`: Delay between retries in seconds (default: 10)
- `--timeout`: Command timeout in seconds (default: 300)
## 🛠️ Development
### Prerequisites
- Python 3.8 or higher
- OpenShift CLI (oc)
- Access to an OpenShift cluster
### Running Tests
```bash
pytest tests/
```
## 🔍 Troubleshooting
### Common Issues
1. **Operator Installation Fails**
- Check cluster access: `oc whoami`
- Verify operator catalog: `oc get catalogsource`
- Check logs: `tail -f /tmp/rhoshift.log`
2. **Permission Issues**
- Ensure you have cluster-admin privileges
- Check namespace permissions
3. **Timeout Errors**
- Increase timeout: `--timeout 900`
- Check cluster resources
## 🤝 Contributing
1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request
## 📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "rhoshift",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "rhoai, openshift, upgrade, toolkit, red hat",
"author": "Milind Waykole",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e0/ef/0409bc577126705bc56781051b73e0705fe95e3b15de06a58655f3381c26/rhoshift-0.1.5.1.tar.gz",
"platform": null,
"description": "# RHOAI Tool Kit\n\n\n\n\nA comprehensive toolkit for managing and upgrading Red Hat OpenShift AI (RHOAI) installations with parallel installation support.\n\n## \ud83d\udccb Table of Contents\n- [Features](#-features)\n- [Project Structure](#-project-structure)\n- [Installation](#-installation)\n- [Usage](#-usage)\n- [Logging](#-logging)\n- [Configuration](#-configuration)\n- [Development](#-development)\n- [Troubleshooting](#-troubleshooting)\n- [Contributing](#-contributing)\n\n## \u2728 Features\n- Install single or multiple OpenShift operators\n- Parallel installation for faster deployments\n- Configurable timeouts and retries\n- Comprehensive logging system\n- Supports:\n - Serverless Operator\n - Service Mesh Operator\n - Authorino Operator\n - cert-manager Operator (Kueue dependency)\n - RHOAI Operator\n - Kueue Operator\n - KEDA (Custom Metrics Autoscaler) Operator\n- **Automatic Dependency Resolution**: Installs required operators in correct order\n- **Smart Validation**: Pre-installation compatibility and conflict detection\n\n## \ud83d\udcc1 Project Structure\n\n```\nrhoshift/\n\u251c\u2500\u2500 rhoshift/ # Main package directory\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 main.py # CLI entry point\n\u2502 \u251c\u2500\u2500 cli/ # Command-line interface\n\u2502 \u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2502 \u251c\u2500\u2500 args.py # Argument parsing\n\u2502 \u2502 \u2514\u2500\u2500 commands.py # Command implementations\n\u2502 \u251c\u2500\u2500 logger/ # Logging utilities\n\u2502 \u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2502 \u2514\u2500\u2500 logger.py # Logging configuration\n\u2502 \u2514\u2500\u2500 utils/ # Core utilities\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 constants.py # Constants and configurations\n\u2502 \u251c\u2500\u2500 operator.py # Operator management\n\u2502 \u2514\u2500\u2500 utils.py # Utility functions\n\u251c\u2500\u2500 run_upgrade_matrix.sh # Upgrade matrix execution script\n\u251c\u2500\u2500 upgrade_matrix_usage.md # Upgrade matrix documentation\n\u251c\u2500\u2500 pyproject.toml # Project dependencies and configuration\n\u2514\u2500\u2500 README.md # This document\n```\n\n## \ud83d\udccb Components\n\n### Core Components\n- **CLI**: Command-line interface for operator management\n- **Logger**: Logging configuration and utilities (logs to `/tmp/rhoshift.log`)\n- **Utils**: Core utilities and operator management logic\n\n### RHOAI Components\n- **RHOAI Upgrade Matrix**: Utilities for testing RHOAI upgrades\n- **Upgrade Matrix Scripts**: Execution and documentation for upgrade testing\n\n### Maintenance Scripts\n- **Cleanup Scripts**: Utilities for cleaning up operator installations\n- **Worker Node Scripts**: Utilities for managing worker node configurations\n\n## \ud83d\ude80 Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/mwaykole/O.git\ncd O\n```\n\n2. Install dependencies:\n```bash\npip install -e .\n```\n\n3. Verify installation:\n```bash\nrhoshift --help\n```\n\n### \ud83d\udd27 New CLI Options\n\n```bash\nrhoshift --help\nusage: rhoshift [-h] [--serverless] [--servicemesh] [--authorino] [--cert-manager] \n [--rhoai] [--kueue] [--keda] [--all] [--cleanup] [--deploy-rhoai-resources]\n [--oc-binary OC_BINARY] [--retries RETRIES] [--retry-delay RETRY_DELAY]\n [--timeout TIMEOUT] [--rhoai-channel RHOAI_CHANNEL] [--raw RAW]\n [--rhoai-image RHOAI_IMAGE] [-v]\n\nOperator Selection:\n --cert-manager Install cert-manager Operator\n --kueue Install Kueue Operator (auto-installs cert-manager)\n --keda Install KEDA (Custom Metrics Autoscaler) Operator\n [... other options ...]\n```\n\n## \ud83d\udcbb Usage\n\n### Basic Commands\n\n```bash\n# Install single operator\nrhoshift --serverless\n\n# Install multiple operators\nrhoshift --serverless --servicemesh\n\n# Install cert-manager operator\nrhoshift --cert-manager\n\n# Install Kueue operator (automatically installs cert-manager dependency)\nrhoshift --kueue\n\n# Install KEDA (Custom Metrics Autoscaler) operator\nrhoshift --keda\n\n# Install RHOAI with raw configuration\nrhoshift --rhoai --rhoai-channel=<channel> --rhoai-image=<image> --raw=True\n\n# Install RHOAI with Serverless configuration\nrhoshift --rhoai --rhoai-channel=<channel> --rhoai-image=<image> --raw=False --all\n\n# Install all operators (including Kueue and KEDA)\nrhoshift --all\n\n# Create DSC and DSCI with RHOAI operator installation\nrhoshift --rhoai --deploy-rhoai-resources\n\n# Clean up all operators\nrhoshift --cleanup\n```\n\n### \ud83d\udd17 Operator Dependencies & Validation\n\nThe tool automatically handles operator dependencies and provides smart validation:\n\n#### **Automatic Dependency Resolution**\n- **Kueue** requires **cert-manager**: Installing Kueue automatically includes cert-manager\n- Dependencies are installed in the correct order to prevent failures\n- Missing dependencies are automatically detected and added\n\n```bash\n# This command will install BOTH cert-manager AND Kueue (in correct order)\nrhoshift --kueue\n\n# You'll see output like:\n# \ud83d\udce6 Auto-adding dependency: cert-manager\n# Installing 2 operators in order: cert-manager \u2192 kueue\n```\n\n#### **Smart Validation**\n- **Compatibility Checking**: Warns about potential operator conflicts\n- **Namespace Validation**: Detects if operators conflict in shared namespaces\n- **Pre-Installation Validation**: Catches issues before installation starts\n\n```bash\n# Example validation warnings:\n# \u26a0\ufe0f Note: Kueue and KEDA may have resource conflicts. Monitor for admission webhook issues.\n# \u26a0\ufe0f Installation order will be adjusted for dependencies: cert-manager \u2192 kueue\n```\n\n#### **Supported Dependencies**\n| Primary Operator | Required Dependencies |\n|-----------------|----------------------|\n| Kueue | cert-manager |\n\n> **Note**: When installing Kueue individually (`--kueue`), you will see dependency warnings. For automatic dependency installation, use batch mode (`--cert-manager --kueue`) or install dependencies manually first.\n\n### Advanced Options\n\n```bash\n# Custom oc binary path\nrhoshift --serverless --oc-binary /path/to/oc\n\n# Custom timeout (seconds)\nrhoshift --all --timeout 900\n\n# Install queue management and auto-scaling operators together\n# (cert-manager will be automatically installed as Kueue dependency)\nrhoshift --kueue --keda\n\n# Install complete ML/AI stack with queue management\nrhoshift --rhoai --kueue --keda --rhoai-channel=stable --rhoai-image=<image>\n\n# Install only cert-manager for other uses\nrhoshift --cert-manager\n\n# Verbose output\nrhoshift --all --verbose\n```\n\n### Upgrade Matrix Testing\n\nTo run the upgrade matrix tests, you can use either method:\n\n1. Using the shell script:\n```bash\n./run_upgrade_matrix.sh [options] <current_version> <current_channel> <new_version> <new_channel>\n```\n\n2. Using the Python command:\n```bash\nrun-upgrade-matrix [options] <current_version> <current_channel> <new_version> <new_channel>\n```\n\nOptions:\n- `-s, --scenario`: Run specific scenario(s) (serverless, rawdeployment, serverless,rawdeployment)\n- `--skip-cleanup`: Skip cleanup before each scenario\n- `--from-image`: Custom source image path\n- `--to-image`: Custom target image path\n\nExample:\n```bash\n# Using shell script\n./run_upgrade_matrix.sh -s serverless -s rawdeployment 2.10 stable 2.12 stable\n\n# Using Python command\nrun-upgrade-matrix -s serverless -s rawdeployment 2.10 stable 2.12 stable\n```\n\n## \ud83d\udcdd Logging\n\nThe toolkit uses a comprehensive logging system:\n- Logs are stored in `/tmp/rhoshift.log`\n- Console output shows INFO level and above\n- File logging captures DEBUG level and above\n- Automatic log rotation (10MB max size, 5 backup files)\n- Colored output in supported terminals\n\nTo view logs:\n```bash\ntail -f /tmp/rhoshift.log\n```\n\n## \ud83d\udd27 Configuration\n\n### Environment Variables\n- `LOG_FILE_LEVEL`: Set file logging level (default: DEBUG)\n- `LOG_CONSOLE_LEVEL`: Set console logging level (default: INFO)\n\n### Command Options\n- `--oc-binary`: Path to oc CLI (default: oc)\n- `--retries`: Max retry attempts (default: 3)\n- `--retry-delay`: Delay between retries in seconds (default: 10)\n- `--timeout`: Command timeout in seconds (default: 300)\n\n## \ud83d\udee0\ufe0f Development\n\n### Prerequisites\n- Python 3.8 or higher\n- OpenShift CLI (oc)\n- Access to an OpenShift cluster\n\n### Running Tests\n```bash\npytest tests/\n```\n\n## \ud83d\udd0d Troubleshooting\n\n### Common Issues\n1. **Operator Installation Fails**\n - Check cluster access: `oc whoami`\n - Verify operator catalog: `oc get catalogsource`\n - Check logs: `tail -f /tmp/rhoshift.log`\n\n2. **Permission Issues**\n - Ensure you have cluster-admin privileges\n - Check namespace permissions\n\n3. **Timeout Errors**\n - Increase timeout: `--timeout 900`\n - Check cluster resources\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the LICENSE file for details. \n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "RHOAI tool kit for managing and upgrading RHOAI",
"version": "0.1.5.1",
"project_urls": {
"Bug Tracker": "https://github.com/mwaykole/O/issues",
"Homepage": "https://github.com/mwaykole/O"
},
"split_keywords": [
"rhoai",
" openshift",
" upgrade",
" toolkit",
" red hat"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3027b9a9bf0663cc159b4eb0e470d0cceb5fb844a6f1501261d3812f14396063",
"md5": "0ae8d1068626580f7cd8547c018807d2",
"sha256": "5b20daa4f442f2aad8f62b0fdb3fadb926892f9aa597d749754bc559d3de4644"
},
"downloads": -1,
"filename": "rhoshift-0.1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ae8d1068626580f7cd8547c018807d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 47316,
"upload_time": "2025-07-25T12:22:26",
"upload_time_iso_8601": "2025-07-25T12:22:26.650308Z",
"url": "https://files.pythonhosted.org/packages/30/27/b9a9bf0663cc159b4eb0e470d0cceb5fb844a6f1501261d3812f14396063/rhoshift-0.1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e0ef0409bc577126705bc56781051b73e0705fe95e3b15de06a58655f3381c26",
"md5": "d1786011d29a687254c84f7dea483f6e",
"sha256": "0b76cd89377d490f541693f311ea4257b4224f8948fe813f2e949f8a5c5c6508"
},
"downloads": -1,
"filename": "rhoshift-0.1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "d1786011d29a687254c84f7dea483f6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 49935,
"upload_time": "2025-07-25T12:22:28",
"upload_time_iso_8601": "2025-07-25T12:22:28.551848Z",
"url": "https://files.pythonhosted.org/packages/e0/ef/0409bc577126705bc56781051b73e0705fe95e3b15de06a58655f3381c26/rhoshift-0.1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 12:22:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mwaykole",
"github_project": "O",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "boto3",
"specs": [
[
"<",
"1.39.0"
],
[
">=",
"1.26.0"
]
]
},
{
"name": "botocore",
"specs": [
[
">=",
"1.29.0"
],
[
"<",
"1.39.0"
]
]
},
{
"name": "kubernetes",
"specs": [
[
">=",
"26.1.0"
],
[
"<",
"34.0.0"
]
]
},
{
"name": "openshift-client",
"specs": [
[
">=",
"1.0.2"
],
[
"<",
"3.0.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"1.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.31.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"1.26.0"
]
]
},
{
"name": "colorlog",
"specs": [
[
"<",
"7.0.0"
],
[
">=",
"6.7.0"
]
]
},
{
"name": "pyfiglet",
"specs": [
[
">=",
"0.8.post1"
],
[
"<",
"2.0.0"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"61.0"
],
[
"<",
"76.0.0"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"<",
"5.0.0"
],
[
">=",
"4.7.0"
]
]
}
],
"lcname": "rhoshift"
}
