Skip to content

SDCICD-1715: updated osde2e README, created CONTRIBUTING.md and consolidated documents #3097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
minlei98 wants to merge 1 commit into from
Closed

SDCICD-1715: updated osde2e README, created CONTRIBUTING.md and consolidated documents #3097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
508 changes: 508 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop

Large diffs are not rendered by default.

55 changes: 38 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,8 @@ When osde2e is invoked, the standard workflow is followed:

Prior to running osde2e, make sure you meet the minimal prerequisites defined below:

* Navigate to [OpenShift Cluster Manager (OCM)][OpenShift Offline Token] to obtain
an OpenShift offline token.
* Save your token into the environment variable `OCM_TOKEN` for later usage
* Obtain OCM service account credentials (client ID and client secret)
* Save your credentials into environment variables `OCM_CLIENT_ID` and `OCM_CLIENT_SECRET`
* Verify (submit a request if required to [ocm resources]) your Red Hat account
has adequate quota for deploying clusters based on your preferred deployment type
* A go workspace running the minimal version defined in the [go.mod](go.mod)
Expand Down Expand Up @@ -102,7 +101,7 @@ you wish to validate. It provides four ways for you to provide input
* Environment variables
* Command line options

*It is highly recommended to leave sensitive settings as environment variables (e.g. `OCM_TOKEN`).
*It is highly recommended to leave sensitive settings as environment variables (e.g. `OCM_CLIENT_ID`, `OCM_CLIENT_SECRET`).
This way the chance of these settings defined in a custom config file are not checked into
source control.*

Expand Down Expand Up @@ -170,7 +169,8 @@ Please refer to the [config package] for exact environment variable names.
Below is an example to spin up a OSD cluster and test it:

```shell
OCM_TOKEN=<ocm-token> \
OCM_CLIENT_ID=<ocm-client-id> \
OCM_CLIENT_SECRET=<ocm-client-secret> \
OSD_ENV=prod \
CLUSTER_NAME=my-cluster \
CLUSTER_VERSION=4.12.0 \
Expand All @@ -180,13 +180,8 @@ osde2e test
These also can be combined with pre-canned default configs and custom configs:

```shell
OCM_TOKEN=<ocm-token> \
CLUSTER_VERSION=4.12.0 \
osde2e test --configs prod,e2e-suite
```

```shell
OCM_TOKEN=<ocm-token> \
OCM_CLIENT_ID=<ocm-client-id> \
OCM_CLIENT_SECRET=<ocm-client-secret> \
CLUSTER_VERSION=4.12.0 \
osde2e test --configs prod,e2e-suite
```
Expand Down Expand Up @@ -228,6 +223,8 @@ To see more examples of configuring input for osde2e, refer to the
owned by the team. These will be always up to date with the latest changes
osde2e has to offer.

For detailed testing instructions, see the [Testing with OSDe2e](/docs/testing-with-osde2e.md) guide.

## Cluster Deployments

OSDe2e provides native support for deploying the following cluster types:
Expand Down Expand Up @@ -327,20 +324,44 @@ that ran and statistics about them (e.g. pass/fail, duration). These XML files w
used by external applications to present metrics and data for others to see into. An example of
this is they are used to present data in [TestGrid Dashboards][TestGrid Dashboard].

### Log Analysis System

OSDe2e includes an intelligent log analysis system that automatically analyzes test failures
using LLM-powered insights and sends notifications to configured channels. The system consists
of three main components:

- **Data Sanitizer**: Removes sensitive information before analysis
- **Analysis Engine**: Uses LLM (Gemini) for intelligent failure analysis
- **Reporter System**: Sends notifications to Slack and other channels

For detailed information, see the [Log Analysis System](/docs/Log-Analysis-System.md) documentation.

## CI Jobs

Periodic jobs are run daily validating Managed OpenShift clusters, using
`osde2e`. Check out the [CI Jobs] page to learn more.

[Config variables]:/docs/Config.md
[configs]:/configs/
[config package]:/pkg/common/config/config.go
## Contributing

We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) for guidelines
on how to submit changes, write tests, and follow our development workflow.

Key points for contributors:
- Always format code with `gofumpt`, not `gofmt`
- Check [osde2e-common](https://github.com/openshift/osde2e-common) for existing functionality
- Write unit tests for all new features
- Follow the commit message format: `[JIRA-ID] type: description`

See [CONTRIBUTING.md](CONTRIBUTING.md) for complete details.

[Config variables]: /docs/Config.md
[configs]: /configs/
[config package]: /pkg/common/config/config.go
[ocm resources]: https://gitlab.cee.redhat.com/service/ocm-resources/
[OSDE2E Quay Image]: quay.io/redhat-services-prod/osde2e-cicada-tenant/osde2e
[OpenShift Dedicated]: https://docs.openshift.com/dedicated/welcome/index.html
[OSDE2E Test Harness]: https://github.com/openshift/osde2e-example-test-harness
[OpenShift Offline Token]:https://cloud.redhat.com/openshift/token
[OSDE2E ProwGen Job Config]: https://github.com/openshift/release/blob/master/ci-operator/config/openshift/osde2e/openshift-osde2e-main.yaml
[TestGrid Dashboard]: https://testgrid.k8s.io/redhat-openshift-osd
[Writing Tests]:/docs/Writing-Tests.md
[Writing Tests]: /docs/Writing-Tests.md
[CI Jobs]: /docs/CI-Jobs.md
17 changes: 16 additions & 1 deletion docs/Config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,18 @@ Some environment variables commonly used for pipelines under osde2e are indicate
| TEST_HTTPS_PROXY | Address of the HTTPS Proxy to be added to a cluster. |
| USER_CA_BUNDLE | A file contains a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store. |

### Log Analysis and LLM related:-

| Environment variable | Usage |
| ----------------------------- | ------------------------------------------------------------------------------------------------------- |
| GEMINI_API_KEY | API key for Google Gemini LLM service used for intelligent failure analysis. |
| LLM_MODEL | LLM model to use for analysis. Default: gemini-2.5-pro. |
| LOG_ANALYSIS_SLACK_WEBHOOK | Slack webhook URL for sending log analysis notifications. |
| LOG_ANALYSIS_SLACK_CHANNEL | Slack channel ID for log analysis notifications. Default: C06HQR8HN0L (#hcm-cicd-notifications). |
| SLACK_NOTIFY | Enable/disable Slack notifications for test results and cleanup reports. Default: false. |
| SLACK_WEBHOOK | Slack webhook URL for general osde2e notifications and cleanup reports. |
| SLACK_CHANNEL | Slack channel name for test suite notifications. Default: hcm-cicd-alerts. |

## Command Line Flags for osde2e

CLI flags that are commonly used include:
Expand All @@ -145,8 +157,11 @@ CLI flags that are commonly used include:
--kube-config: Path to local Kube config for running tests against.
--skip-destroy-cluster: Skip cluster deletion after test completion.
--skip-health-check: Skip cluster health checks.
--skip-must-gather: Skip must-gather collection after test completion.
--skip-tests: Skip any Ginkgo tests whose names match the regular expression.
--only-health-check-nodes: Only validate the nodes are ready
--focus-tests: Only run tests whose names match the regular expression.
--label-filter: Ginkgo label filter expression (e.g., "Operators && !Upgrade").
--only-health-check-nodes: Only validate the nodes are ready.
```

### For the query sub-command:
Expand Down
Loading