doc: Update/remove broken links

Updates few broken links, removes a non existent link and some nit-picks.

Signed-off-by: karthik-us <ksubrahm@redhat.com>
This commit is contained in:
karthik-us
2023-07-04 19:43:57 +05:30
committed by mergify[bot]
parent ab521dba96
commit d14bba7c12
2 changed files with 16 additions and 18 deletions

View File

@ -2,9 +2,9 @@
- [dedicated Jenkins instance][ceph_csi_ci] for Ceph-CSI
- Jenkins is hosted on [OpenShift in the CentOS CI][app_ci_centos_org]
- scripts and Jenkins jobs are hosted in the Ceph-CSI repository (ci/centos
- Scripts and Jenkins jobs are hosted in the Ceph-CSI repository (ci/centos
branch)
- a Jenkins Pipeline is used to reserve bare metal system(s), and run jobs on
- A Jenkins Pipeline is used to reserve bare metal system(s), and run jobs on
those systems
## Repository/Branch Structure
@ -20,20 +20,19 @@ following files:
that describes the events when the job should get run and fetches the
`.groovy` file from the git repository/branch
- `containerized-tests.groovy` is the [Jenkins Pipeline][pipeline] that
contains the stages for the Jenkins Job itself. In order to work with [the
bare-metal machines from the CentOS CI][centos_ci_hw], it executes the
following stages:
contains the stages for the Jenkins Job itself. In order to work with the
bare-metal machines from the CentOS CI, it executes the following stages:
1. dynamically allocate a Jenkins Slave (`node('cico-workspace')`) with tools
1. Dynamically allocate a Jenkins Slave (`node('cico-workspace')`) with tools
and configuration to request a bare-metal machine
1. checkout the `centos/ci` branch of the repository, which contains scripts
1. Checkout the `centos/ci` branch of the repository, which contains scripts
for provisioning and preparing the environment for running tests
1. reserve a bare-metal machine with `duffy` (configured on the Jenkins
1. Reserve a bare-metal machine with `duffy` (configured on the Jenkins
Slave)
1. provision the reserved bare-metal machine with additional tools and
1. Provision the reserved bare-metal machine with additional tools and
dependencies to run the test (see `prepare.sh` below)
1. run `make containerized-tests` and `make containerized-build` in parallel
1. as final step, return the bare-metal machine to the CentOS CI for other
1. Run `make containerized-tests` and `make containerized-build` in parallel
1. As final step, return the bare-metal machine to the CentOS CI for other
users (it will be re-installed with a minimal CentOS environment again)
- `prepare.sh` installs dependencies for the test, and checks out the git
@ -49,8 +48,7 @@ in a `jjb` container. To build the container, and provide the configuration for
Jenkins Job Builder, see the [documentation in the `deploy/`
directory](deploy/README.md).
[ceph_csi_ci]: https://jenkins-ceph-csi.apps.ocp.ci.centos.org
[app_ci_centos_org]: https://console-openshift-console.apps.ocp.ci.centos.org/k8s/cluster/projects/ceph-csi
[ceph_csi_ci]: https://jenkins-ceph-csi.apps.ocp.cloud.ci.centos.org
[app_ci_centos_org]: https://console-openshift-console.apps.ocp.cloud.ci.centos.org/k8s/cluster/projects/ceph-csi
[jjb]: https://jenkins-job-builder.readthedocs.io/en/latest/index.html
[pipeline]: https://docs.openstack.org/infra/jenkins-job-builder/project_pipeline.html
[centos_ci_hw]: https://wiki.centos.org/QaWiki/PubHardware
[pipeline]: https://jenkins-job-builder.readthedocs.io/en/latest/project_pipeline.html