-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'odh/v2.9.x' into stable
- Loading branch information
Showing
22 changed files
with
335 additions
and
164 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| # Setup the local environment | ||
|
|
||
| All the following commands must be executed in a single terminal instance. | ||
|
|
||
| ## Increase inotify Limits | ||
| To prevent file monitoring issues in development environments (e.g., IDEs or file sync tools), increase inotify limits: | ||
| ```bash | ||
| sudo sysctl fs.inotify.max_user_instances=2280 | ||
| sudo sysctl fs.inotify.max_user_watches=1255360 | ||
| ``` | ||
| ## Prerequisites | ||
| * Kind https://kind.sigs.k8s.io/ | ||
|
|
||
| ## Create kind cluster | ||
| ```bash | ||
| cat <<EOF | kind create cluster --name=kubeflow --config=- | ||
| kind: Cluster | ||
| apiVersion: kind.x-k8s.io/v1alpha4 | ||
| nodes: | ||
| - role: control-plane | ||
| image: kindest/node:v1.30.6@sha256:b6d08db72079ba5ae1f4a88a09025c0a904af3b52387643c285442afb05ab994 | ||
| kubeadmConfigPatches: | ||
| - | | ||
| kind: ClusterConfiguration | ||
| apiServer: | ||
| extraArgs: | ||
| "service-account-issuer": "kubernetes.default.svc" | ||
| "service-account-signing-key-file": "/etc/kubernetes/pki/sa.key" | ||
| EOF | ||
| ``` | ||
|
|
||
| ## kubeconfig | ||
| Instead of replacing your kubeconfig, we are going to set to a diff file | ||
| ```bash | ||
| kind get kubeconfig --name kubeflow > /tmp/kubeflow-config | ||
| export KUBECONFIG=/tmp/kubeflow-config | ||
| ``` | ||
| ## docker | ||
| In order to by pass the docker limit issue while downloading the images. Let's use your credentials | ||
| ```bash | ||
| docker login -u='...' -p='...' quay.io | ||
| ``` | ||
|
|
||
| Upload the secret. The following command will return an error. You need to replace `to` with user `username` | ||
| ```bash | ||
| kubectl create secret generic regcred \ | ||
| --from-file=.dockerconfigjson=$HOME/.docker/config.json \ | ||
| --type=kubernetes.io/dockerconfigjson | ||
| ``` | ||
|
|
||
| ## Test environment variables | ||
| Replace the `/path/to` in order to match the `data-science-pipelines-operator` folder | ||
| ```bash | ||
| export GIT_WORKSPACE=/path/to/data-science-pipelines-operator | ||
| ``` | ||
| The image registry is required because you are running the test locally. | ||
| It will build and upload the image to your repository. | ||
|
|
||
| Replace `username` with your quay user | ||
| ```bash | ||
| export REGISTRY_ADDRESS=quay.io/username | ||
| ``` | ||
|
|
||
| ## Run the test | ||
| ```bash | ||
| sh .github/scripts/tests/tests.sh --kind | ||
| ``` | ||
|
|
||
| # Debug a test using GoLand | ||
| Let's say you wish to debug the `Should create a Pipeline Run` test. | ||
| The first step is right click inside the method content and select the menu | ||
| `Run 'TestIntegrationTestSuite'`. It will fail because you need to fill some parameters. | ||
| Edit the configuration for `TestIntegrationTestSuite/TestPipelineSuccessfulRun/Should_create_a_Pipeline_Run in github.com/opendatahub-io/data-science-pipelines-operator/tests` | ||
| ```` | ||
| -k8sApiServerHost=https://127.0.0.1:39873 | ||
| -kubeconfig=/tmp/kubeflow-config | ||
| -DSPANamespace=test-dspa | ||
| -DSPAPath=/path/to/data-science-pipelines-operator/tests/resources/dspa-lite.yaml | ||
| ```` | ||
| ## How to retrieve the parameters above | ||
| * `k8sApiServerHost`: inspect the kubeconfig and retrieve the server URL from there | ||
| * `kubeconfig`: the path where you stored the output of `kind get kubeconfig` | ||
| * `DSPANamespace`: namespace | ||
| * `DSPAPath`: full path for the dspa.yaml | ||
|
|
||
| `Should create a Pipeline Run`, `DSPANamespace` and `DSPAPath` depends on the test scenario. | ||
|
|
||
| If you wish to keep the resources, add `-skipCleanup=True` in the config above. | ||
|
|
||
| ## If you wish to rerun the test you need to delete the dspa | ||
| ```bash | ||
| $ kubectl delete datasciencepipelinesapplications test-dspa -n test-dspa | ||
| datasciencepipelinesapplication.datasciencepipelinesapplications.opendatahub.io "test-dspa" deleted | ||
| ``` | ||
|
|
||
| # `tests.sh` details | ||
| This Bash script is designed to set up and test environments for Data Science Pipelines Operator (DSPO) | ||
| using Kubernetes (K8s) or *OpenShift with RHOAI deployed*. It includes functionalities to deploy dependencies, | ||
| configure namespaces, build and deploy images, and execute integration tests. | ||
|
|
||
| ## **Features** | ||
| 1. **Environment Variables Declaration**: | ||
| The script requires and verifies environment variables such as `GIT_WORKSPACE`, `REGISTRY_ADDRESS`, and `K8SAPISERVERHOST`. These variables define the workspace, registry for container images, and K8s API server address. | ||
|
|
||
| 2. **Deployment Functions**: | ||
| Functions like `deploy_dspo`, `deploy_minio`, and `deploy_mariadb` handle deploying necessary components (e.g., MinIO, MariaDB, PyPI server) to the cluster. | ||
|
|
||
| 3. **Namespace Configuration**: | ||
| Functions like `create_opendatahub_namespace` and `create_dspa_namespace` create and configure Kubernetes namespaces required for DSPO and other dependencies. | ||
|
|
||
| 4. **Integration Testing**: | ||
| The script provides commands to run integration tests for DSPO and its external connections using `run_tests` and `run_tests_dspa_external_connections`. | ||
|
|
||
| 5. **Cleanup and Resource Removal**: | ||
| Includes options like `--clean-infra` to remove namespaces and resources before running tests. | ||
|
|
||
| 6. **Conditional Execution**: | ||
| Supports setting up and testing environments for different targets: | ||
| - `kind` (local Kubernetes clusters) | ||
| - `rhoai` (Red Hat OpenShift AI) | ||
|
|
||
| 7. **Customizable Parameters**: | ||
| Allows passing values for paths, namespaces, and K8s API server via command-line arguments. | ||
|
|
||
| ## **Usage** | ||
| ```bash | ||
| ./tests.sh [OPTIONS] | ||
| ``` | ||
|
|
||
| ### **Options** | ||
| - `--kind` | ||
| Targets local `kind` cluster. | ||
| - `--rhoai` | ||
| Targets RHOAI | ||
| - `--clean-infra` | ||
| Cleans existing resources before running tests. | ||
| - `--k8s-api-server-host <HOST>` | ||
| Specifies the Kubernetes API server host. | ||
| - `--dspa-namespace <NAMESPACE>` | ||
| Custom namespace for DSPA deployment. | ||
| - `--dspa-path <PATH>` | ||
| Path to DSPA resource YAML. | ||
| - `--endpoint-type <TYPE>` | ||
| Specifies endpoint type (`service` or `route`). | ||
|
|
||
| ### **Example** | ||
| To deploy and test DSPA on a local `kind` cluster: | ||
| ```bash | ||
| ./tests.sh --kind --clean-infra --k8s-api-server-host "https://localhost:6443" | ||
| ``` | ||
|
|
||
| To deploy DSPA on RHOAI: | ||
| ```bash | ||
| ./tests.sh --rhoai --dspa-namespace "custom-namespace" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| DSPA_NS="" | ||
| DSPO_NS="" | ||
|
|
||
| while [[ "$#" -gt 0 ]]; do | ||
| case $1 in | ||
| --dspa-ns) DSPA_NS="$2"; shift ;; | ||
| --dspo-ns) DSPO_NS="$2"; shift ;; | ||
| *) echo "Unknown parameter passed: $1"; exit 1 ;; | ||
| esac | ||
| shift | ||
| done | ||
|
|
||
| if [[ -z "$DSPA_NS" || -z "$DSPO_NS" ]]; then | ||
| echo "Both --dspa-ns and --dspo-ns parameters are required." | ||
| exit 1 | ||
| fi | ||
|
|
||
| function check_namespace { | ||
| if ! kubectl get namespace "$1" &>/dev/null; then | ||
| echo "Namespace '$1' does not exist." | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| function display_pod_info { | ||
| local NAMESPACE=$1 | ||
| local POD_NAMES | ||
|
|
||
| POD_NAMES=$(kubectl -n "${DSPA_NS}" get pods -o custom-columns=":metadata.name") | ||
|
|
||
| if [[ -z "${POD_NAMES}" ]]; then | ||
| echo "No pods found in namespace '${NAMESPACE}'." | ||
| return | ||
| fi | ||
|
|
||
| for POD_NAME in ${POD_NAMES}; do | ||
| echo "===== Pod: ${POD_NAME} in ${NAMESPACE} =====" | ||
|
|
||
| echo "----- EVENTS -----" | ||
| kubectl describe pod "${POD_NAME}" -n "${NAMESPACE}" | grep -A 100 Events || echo "No events found for pod ${POD_NAME}." | ||
|
|
||
| echo "----- LOGS -----" | ||
| kubectl logs "${POD_NAME}" -n "${NAMESPACE}" || echo "No logs found for pod ${POD_NAME}." | ||
|
|
||
| echo "===========================" | ||
| echo "" | ||
| done | ||
| } | ||
|
|
||
| check_namespace "$DSPA_NS" | ||
| check_namespace "$DSPO_NS" | ||
|
|
||
| display_pod_info "$DSPA_NS" | ||
| display_pod_info "$DSPO_NS" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| releases: | ||
| - name: Kubeflow Pipelines | ||
| version: 2.2.0 | ||
| repoUrl: https://github.com/kubeflow/pipelines |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.