Skip to content

Commit

Permalink
Update CI docs
Browse files Browse the repository at this point in the history
Signed-off-by: Romain Arnaud <[email protected]>
  • Loading branch information
Roming22 committed Oct 2, 2023
1 parent a678f03 commit 32e8378
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 18 deletions.
8 changes: 0 additions & 8 deletions ci/docs/access_to_the_ci_cluster.md

This file was deleted.

19 changes: 9 additions & 10 deletions ci/docs/continuous_integation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Continuous integration tests

Pipelines as Code triggers the PipelineRuns in [.tekton](../../.tekton) which execute the test tasks for each PR, before merging it.
After installing the GitHub Application, Pipelines as Code triggers the PipelineRuns in [.tekton](../../.tekton) which execute the test tasks for each PR on the `prd-rh01` cluster, in the `tekton-ci` namespace, before merging it.

All the functional tests run on a ROSA HCP cluster.
All the functional tests run on a ROSA HCP cluster that is automatically provisionned during the pipeline execution.

## Setup GitHub app

- The repository needs to install the [Red Hat Trusted App Pipeline](https://github.com/apps/red-hat-trusted-app-pipeline) GitHub Application, so that Pipelines as Code is triggered on repository events.

## How to configure ROSA HCP

Expand All @@ -27,26 +31,21 @@ To create a ROSA with HCP cluster, you can create the following items by running

After that, you need to add a Secret for storing the Bitwarden credentials(BW_CLIENTID,BW_CLIENTSECRET and BW_PASSWORD).

## Setup GitHub app

- Need to configure GitHub app for Pipelines as Code configuration into Pipeline Service repository.

## Debugging an issue during the CI execution
The CI will destroy the test cluster at the end of the pipeline by default.
This is an issue when troubleshooting is required.

To bypass deletion of the test cluster, delete the `destroy-cluster.txt` file in created in the root of the cloned repository.
There is a 15 minutes window to log onto the container running the `destroy-cluster` step and delete the file.


### Login to the ROSA with HCP cluster
When the test cluster is remained, to access the test cluster, you can go to the task named `deploy-cluster` to find the content of kubeconfig and login username/password.

### Debugging the plnsvc-setup task
When the CI failed during the plnsvc-setup task, you can ssh to the ci-runner pod in the test cluster to manually execute `dev_setup.sh` to debug the task. For example
### Debugging the run-plnsvc-setup task
When the CI failed during the run-plnsvc-setup task, you can ssh to the ci-runner container in the test cluster to manually execute `dev_setup.sh` to debug the task. For example

```
$ oc -n default rsh pod/ci-runner
$ export KUBECONFIG=/kubeconfig
$ /source/developer/openshift/dev_setup.sh --debug --use-current-branch --force --work-dir /source/developer/openshift/work
```
```

0 comments on commit 32e8378

Please sign in to comment.