mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-09-19 15:09:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update/remove broken links

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -2,9 +2,9 @@
- [dedicated Jenkins instance][ceph_csi_ci] for Ceph-CSI - [dedicated Jenkins instance][ceph_csi_ci] for Ceph-CSI
- Jenkins is hosted on [OpenShift in the CentOS CI][app_ci_centos_org] - 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) 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 those systems
## Repository/Branch Structure ## Repository/Branch Structure
@ -20,20 +20,19 @@ following files:
that describes the events when the job should get run and fetches the that describes the events when the job should get run and fetches the
`.groovy` file from the git repository/branch `.groovy` file from the git repository/branch
- `containerized-tests.groovy` is the [Jenkins Pipeline][pipeline] that - `containerized-tests.groovy` is the [Jenkins Pipeline][pipeline] that
contains the stages for the Jenkins Job itself. In order to work with [the 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 bare-metal machines from the CentOS CI, it executes the following stages:
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 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 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) 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) dependencies to run the test (see `prepare.sh` below)
1. run `make containerized-tests` and `make containerized-build` in parallel 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. 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) users (it will be re-installed with a minimal CentOS environment again)
- `prepare.sh` installs dependencies for the test, and checks out the git - `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/` Jenkins Job Builder, see the [documentation in the `deploy/`
directory](deploy/README.md). directory](deploy/README.md).
[ceph_csi_ci]: https://jenkins-ceph-csi.apps.ocp.ci.centos.org [ceph_csi_ci]: https://jenkins-ceph-csi.apps.ocp.cloud.ci.centos.org
[app_ci_centos_org]: https://console-openshift-console.apps.ocp.ci.centos.org/k8s/cluster/projects/ceph-csi [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 [jjb]: https://jenkins-job-builder.readthedocs.io/en/latest/index.html
[pipeline]: https://docs.openstack.org/infra/jenkins-job-builder/project_pipeline.html [pipeline]: https://jenkins-job-builder.readthedocs.io/en/latest/project_pipeline.html
[centos_ci_hw]: https://wiki.centos.org/QaWiki/PubHardware

6
deploy/README.md
View File

@ -5,7 +5,7 @@ Job Builder on OpenShift and update/add Jenkins Jobs in an environment hosted
in the same OpenShift project. in the same OpenShift project.
The used Jenkins environment is expected to be deployed already. This is done The used Jenkins environment is expected to be deployed already. This is done
by the CentOS CI team when a [request for CI resources](ci_request) is handled. by the CentOS CI team when a [request for CI resources][ci_request] is handled.
The deploying and configuration of Jenkins is therefor not part of this The deploying and configuration of Jenkins is therefor not part of this
document. document.
@ -18,11 +18,11 @@ update/add jobs in a Jenkins environment.
All `.yaml` files in this directory need to be pushed into OpenShift, use `oc All `.yaml` files in this directory need to be pushed into OpenShift, use `oc
create -f <file>` for that. create -f <file>` for that.
- the `Dockerfile` uses `pip` to install `jenkins-jobs`, the BuildConfig object - The `Dockerfile` uses `pip` to install `jenkins-jobs`, the BuildConfig object
in OpenShift can then be used to build the image in OpenShift can then be used to build the image
- `checkout-repo.sh` will be included in the container image, and checks out - `checkout-repo.sh` will be included in the container image, and checks out
the `ci/centos` branch of the repository the `ci/centos` branch of the repository
- together with the `Makefile` (checked out with `checkout-repo.sh`), the - Together with the `Makefile` (checked out with `checkout-repo.sh`), the
Jenkins Jobs can be validated or deployed Jenkins Jobs can be validated or deployed
- `jjb-buildconfig.yaml` creates the ImageStream and the BuildConfig objects. - `jjb-buildconfig.yaml` creates the ImageStream and the BuildConfig objects.
Once created with `oc create`, the OpenShift Console shows a `Build` button Once created with `oc create`, the OpenShift Console shows a `Build` button