diff --git a/.travis.yml b/.travis.yml index 3e1f46747..85cd2004c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,12 @@ language: python python: - "3.7" +addons: + apt: + packages: + - nodejs + - npm + cache: directories: - $HOME/.cache/pip @@ -23,8 +29,12 @@ install: #- pip install "ansible-lint<4.0" yamllint flake8 molecule docker "pytest<3.10" "testinfra==3.0.4" # Configure OpenShift Binary - sudo wget -qO- ${OC_BINARY_URL} | sudo tar -xvz -C /bin + # Install hyperlink checker + - npm install -g markdown-link-check before_script: + # Check for dead-links in the docs + - find . -type f -name "*.md" -exec markdown-link-check --quiet --config linkcheck-config.json {} \; # Configure Docker - sudo service docker stop - sudo mkdir -p /etc/docker diff --git a/README.md b/README.md index 0041d94bb..046a6b9b1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![Build Status](https://travis-ci.org/redhat-cop/containers-quickstarts.svg?branch=master)](https://travis-ci.org/redhat-cop/containers-quickstarts) +[![License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)]() + # Container Quickstarts by Red Hat's Community of Practice This repository is meant to help bootstrap users of the OpenShift Container Platform to get started in building and using Source-to-Image to build applications to run in OpenShift. diff --git a/TESTING.md b/TESTING.md index 7b2fa93df..7945cffeb 100644 --- a/TESTING.md +++ b/TESTING.md @@ -4,7 +4,7 @@ Containers-quickstarts is outfitted with a set of automated tests. This document ## Tesing Architecture -We use Travis-CI to test this repo. You can start to examine how we set up and invoke tests by examining the [.travis.yml](/.travis.yml) file. +We use Travis-CI to test this repo. You can start to examine how we set up and invoke tests by examining the [.travis.yml](.travis.yml) file. We have split the architect of the tests up into 4 phases: @@ -13,11 +13,11 @@ We have split the architect of the tests up into 4 phases: 3. Running [openshift-applier](https://github.com/redhat-cop/openshift-applier) to deploy a set of builds 4. Checking `.status.phase` in each build to validate all builds end with in a `Completed` state. -The 3 phases of testing are captured in a [script](/_test/setup.sh) that is executed by travis, but can also be run locally in order to validate your changes before committing code. +The 3 phases of testing are captured in a [script](_test/setup.sh) that is executed by travis, but can also be run locally in order to validate your changes before committing code. ## Writing Tests -Adding a new test to our CI is as simple as adding one or more `BuildConfig`s to the [global Applier inventory](/.applier). Currently we deploy all assets into a single namespace to make all builds "discoverable" by our test scripts. +Adding a new test to our CI is as simple as adding one or more `BuildConfig`s to the [global Applier inventory](.applier). Currently we deploy all assets into a single namespace to make all builds "discoverable" by our test scripts. Every build that gets created will then be executed, and the test script will wait until all builds complete, and ensure that none of them fail. diff --git a/build-s2i-executable/README.md b/build-s2i-executable/README.md index 7aa48334a..3eeb0effe 100644 --- a/build-s2i-executable/README.md +++ b/build-s2i-executable/README.md @@ -30,8 +30,8 @@ The requirements of this image are simple. All you need are: The openshift-applier will create the following OpenShift objects: * A Project named `build-s2i-executable` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Two ImageStreams named `rhel7`, `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/template/build-s2i-executable.yml)). -* One BuildConfig named `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/template/build-s2i-executable.yml)). +* Two ImageStreams named `rhel7`, `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/templates/build-s2i-executable.yml)). +* One BuildConfig named `build-s2i-executable` (see [.openshift/template/build-s2i-executable.yml](.openshift/templates/build-s2i-executable.yml)). ## Environment Variables diff --git a/build-s2i-gows/README.md b/build-s2i-gows/README.md index d6e084e59..a70c5e3c9 100644 --- a/build-s2i-gows/README.md +++ b/build-s2i-gows/README.md @@ -18,7 +18,7 @@ By default our simple [demo site](demo/index.html) will be deployed. GoWS is a webserver built to do nothing more than to serve static content web sites on the smallest possible footprint. This S2I-enabled image makes this one step easier by being able to stream that content straight into the image from source. -This repo contains both a `Dockerfile` for building the image and a directory of [sample content](/build-s2i-gows/demo). +This repo contains both a `Dockerfile` for building the image and a directory of [sample content](demo). ## Bill of Materials @@ -32,10 +32,10 @@ The requirements of this image are simple. All you need are: The openshift-applier will create the following OpenShift objects: * A Project named `s2i-gows` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Three ImageStreams named `golang`, `busybox` and `gows` (see [files/imagestreams/template.yml](files/imagestreams/template.yml) and [files/builds/gows.yml](files/builds/gows.yml)). -* Four BuildConfigs named `gows-build`, `gows-busybox`, `gows-s2i` and `gows` (see [files/builds/template.yml](files/builds/template.yml)) -* A Service named `gows` (see [files/deployments/template.yml](files/deployments/template.yml)) -* A Route named `gows` (see [files/deployments/template.yml](files/deployments/template.yml)) +* Three ImageStreams named `golang`, `busybox` and `gows` (see [.openshift/templates/imagestreams/template.yml](.openshift/templates/imagestreams/template.yml) and [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml)). +* Four BuildConfigs named `gows-build`, `gows-busybox`, `gows-s2i` and `gows` (see [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml)) +* A Service named `gows` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) +* A Route named `gows` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) ## Environment Variables diff --git a/build-s2i-jekyll/README.md b/build-s2i-jekyll/README.md index 6ed9bace7..bb6a50a84 100644 --- a/build-s2i-jekyll/README.md +++ b/build-s2i-jekyll/README.md @@ -8,11 +8,11 @@ This example is using the [OpenShift Applier](https://github.com/redhat-cop/open ## OpenShift objects The openshift-applier will create the following OpenShift objects: * A Project named `s2i-jekyll` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Three ImageStreams named `ruby`, `jekyll-builder` and `openshift-playbooks` (see [files/imagestreams/template.yml](files/imagestreams/template.yml). -* Two BuildConfigs named `jekyll-builder` and `openshift-playbooks` (see [files/builds/docker-template.yml](files/builds/docker-template.yml) and [files/builds/source-template.yml](files/builds/source-template.yml)) -* A Service named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml)) -* A Route named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml)) -* A DeploymentConfig named `openshift-playbooks` (see [files/deployments/template.yml](files/deployments/template.yml)) +* Three ImageStreams named `ruby`, `jekyll-builder` and `openshift-playbooks` (see [.openshift/templates/imagestreams/template.yml](.openshift/templates/imagestreams/template.yml). +* Two BuildConfigs named `jekyll-builder` and `openshift-playbooks` (see [.openshift/templates/builds/docker-template.yml](.openshift/templates/builds/docker-template.yml) and [.openshift/templates/builds/source-template.yml](.openshift/templates/builds/source-template.yml)) +* A Service named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) +* A Route named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) +* A DeploymentConfig named `openshift-playbooks` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) ## Quickstart @@ -25,4 +25,4 @@ The openshift-applier will create the following OpenShift objects: Now we can `oc get routes` to get the hostname of the route that was just created, or click the link in the OpenShift Web Console, and test our newly published jekyll site. ->**_NOTE_**: This image is not intended to be used to serve the content provided by jekyll. It can do so, but is meant for testing purposes only. For hosting the html site produced by this image, consider using the [s2i-httpd image](/s2i-httpd/), or for someting even more light weight, check out our [Go Web Server](https://github.com/redhat-cop/gows). +>**_NOTE_**: This image is not intended to be used to serve the content provided by jekyll. It can do so, but is meant for testing purposes only. For hosting the html site produced by this image, consider using the [s2i-httpd image](../deprecated/s2i-httpd/), or for someting even more light weight, check out our [Go Web Server](https://github.com/redhat-cop/gows). diff --git a/build-s2i-liberty/README.md b/build-s2i-liberty/README.md index cbffbc9b2..2d7f44fb0 100644 --- a/build-s2i-liberty/README.md +++ b/build-s2i-liberty/README.md @@ -41,11 +41,11 @@ This demo should be run on an installation of OpenShift Enterprise V3.7 The openshift-applier will create the following OpenShift objects: * A project named `liberty-demo` (see [applier/projects/projects.yml](.openshift/templates/projects/projects.yml)) -* Five ImageStreams named `websphere-liberty`, `s2i-liberty`, `hello-world-artifacts`, `eap70-openshift` and `hello-world` (see [applier/templates/build.yml](.applier/templates/build.yml)) -* Three BuildConfigs named `websphere-liberty`, `hello-world-artifacts` and `hello-world` (see [applier/templates/build.yml](.applier/templates/build.yml)) -* A DeploymentConfig named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml)) -* A Service named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml)) -* A Route named `hello-world` (see [applier/templates/deployment.ym](.applier/templates/deployment.yml)) +* Five ImageStreams named `websphere-liberty`, `s2i-liberty`, `hello-world-artifacts`, `eap70-openshift` and `hello-world` (see [.openshift/templates/build.yml](.openshift/templates/build.yml)) +* Three BuildConfigs named `websphere-liberty`, `hello-world-artifacts` and `hello-world` (see [.openshift/templates/build.yml](.openshift/templates/build.yml)) +* A DeploymentConfig named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml)) +* A Service named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml)) +* A Route named `hello-world` (see [.openshift/templates/deployment.ym](.openshift/templates/deployment.yml)) >**NOTE:** This requires permission to create new projects and that the `liberty-demo` project doesn't already exist diff --git a/build-s2i-play/README.md b/build-s2i-play/README.md index 4463cc93c..e3183c439 100644 --- a/build-s2i-play/README.md +++ b/build-s2i-play/README.md @@ -49,11 +49,11 @@ This demo should be run on an installation of OpenShift Enterprise V3 The openshift-applier will create the following OpenShift objects: * A project named `play-demo` (see [applier/projects/projects.yml](.applier/projects/projects.yml)) -* Three ImageStreams named `rhel7`, `s2i-play` and `play-app` (see [applier/templates/build.yml](.applier/templates/build.yml)) -* Two BuildConfigs named `s2i-play` and `play-app` (see [applier/templates/build.yml](.applier/templates/build.yml)) -* A DeploymentConfig named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml)) -* A Service named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml)) -* A Route named `play-app` (see [applier/templates/deployment.yml](.applier/templates/deployment.yml)) +* Three ImageStreams named `rhel7`, `s2i-play` and `play-app` (see [.openshift/templates/build.yml](.openshift/templates/build.yml)) +* Two BuildConfigs named `s2i-play` and `play-app` (see [.openshift/templates/build.yml](.openshift/templates/build.yml)) +* A DeploymentConfig named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml)) +* A Service named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml)) +* A Route named `play-app` (see [.openshift/templates/deployment.yml](.openshift/templates/deployment.yml)) >**NOTE:** This requires permission to create new projects and that the `play-demo` project doesn't already exist @@ -106,7 +106,7 @@ oc new-project play-demo ### Produce Builder Image -The Play Framework builder image can be created using the [Git](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html#source-code) or [Binary](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html#binary-source) build source +The Play Framework builder image can be created using the [Git](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/build_inputs.html#source-code) or [Binary](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/build_inputs.html#binary-source) build source #### Git Source @@ -245,6 +245,6 @@ oc delete project play-demo ## Resources * [Play Framework](https://www.playframework.com/) -* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build) -* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html) -* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html) +* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build) +* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html) +* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html) diff --git a/deprecated/kafka/README.md b/deprecated/kafka/README.md index 9152b2605..e97c2007c 100644 --- a/deprecated/kafka/README.md +++ b/deprecated/kafka/README.md @@ -30,7 +30,7 @@ The openshift-applier will create the following OpenShift objects: The following prerequisites must be met prior to beginning to build and deploy Kafka -* 6 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html). 3 for Kafka and 3 for Zookeeper ([see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html) +* 6 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html). 3 for Kafka and 3 for Zookeeper ([see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html) * OpenShift Command Line Tool * Zookeeper ([see below](#zookeeper)) * [Openshift Applier](https://github.com/redhat-cop/openshift-applier) to build and deploy Kafka. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html) diff --git a/deprecated/s2i-httpd/README.md b/deprecated/s2i-httpd/README.md index d726d42c4..284c350e4 100644 --- a/deprecated/s2i-httpd/README.md +++ b/deprecated/s2i-httpd/README.md @@ -113,6 +113,6 @@ The application can be successfully validated if the webpage can be accessed ## Resources * [Apache HTTPD Web Server](https://httpd.apache.org/) -* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build) -* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html) -* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html) \ No newline at end of file +* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build) +* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html) +* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html) \ No newline at end of file diff --git a/deprecated/s2i-java/README.md b/deprecated/s2i-java/README.md index 03617ae05..9d33919bb 100644 --- a/deprecated/s2i-java/README.md +++ b/deprecated/s2i-java/README.md @@ -203,6 +203,6 @@ The application can be successfully validated if the webpage can be accessed ## Resources * [Upstream Java S2I Builder](https://github.com/fabric8io-images/s2i/tree/master/java/images/rhel) -* [Source to Image](https://docs.openshift.com/enterprise/latest/architecture/core_concepts/builds_and_image_streams.html#source-build) -* [Builds](https://docs.openshift.com/enterprise/latest/dev_guide/builds.html) -* [Developer CLI Reference](https://docs.openshift.com/enterprise/latest/cli_reference/basic_cli_operations.html) +* [Source to Image](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/builds_and_image_streams.html#source-build) +* [Builds](https://docs.openshift.com/container-platform/3.11/dev_guide/builds/index.html) +* [Developer CLI Reference](https://docs.openshift.com/container-platform/3.11/cli_reference/basic_cli_operations.html) diff --git a/deprecated/zookeeper/README.md b/deprecated/zookeeper/README.md index 95ce9116a..649f983cd 100644 --- a/deprecated/zookeeper/README.md +++ b/deprecated/zookeeper/README.md @@ -36,8 +36,8 @@ The above steps will create the `zookeeper` project and build a Zookeeper image The openshift-applier will create the following OpenShift objects: * A project named `zookeeper` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Two ImageStreams named `rhel` and `zookeeper` (see [files/imagestreams/images.yml](files/imagestreams/image.yml) and [files/builds/template.yml](files/builds/template.yml)) -* A BuildConfig named `zookeeper` (see [files/builds/template.yml](/files/builds/template.yml)) +* Two ImageStreams named `rhel` and `zookeeper` (see [files/imagestreams/images.yml](files/imagestreams/images.yml) and [files/builds/template.yml](files/builds/template.yml)) +* A BuildConfig named `zookeeper` (see [files/builds/template.yml](files/builds/template.yml)) * Two Services `zookeeper` and `zookeeper-headless` (see [files/deployments/template.yml](files/deployments/template.yml)) * A StatefulSet named `zookeeper` (see [files/deployments/template.yml](files/deployments/template.yml)) * A ConfigMap named `zookeeper-config` (see [files/deployments/template.yml](files/deployments/template.yml)) diff --git a/gitlab-ce/README.md b/gitlab-ce/README.md index e92bd1a00..41c42c5fe 100644 --- a/gitlab-ce/README.md +++ b/gitlab-ce/README.md @@ -2,7 +2,7 @@ The following prerequisites must be met prior to beginning to deploy GitLab CE -* 4 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html) +* 4 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html) * OpenShift Command Line Tool * Custom SSL certificates must be generated in advance in order to provide those to the deployment process * [Openshift Applier](https://github.com/redhat-cop/openshift-applier/) to deploy GitLab CE. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html) diff --git a/gogs/README.md b/gogs/README.md index 5d20975c3..a3a91c506 100644 --- a/gogs/README.md +++ b/gogs/README.md @@ -27,7 +27,7 @@ Registration is enabled until the following [issue](https://github.com/gogits/go The following prerequisites must be met prior to beginning to deploy Gogs -* 2 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html). 1 for Gogs repositories data (pvc named `gogs-data`) and 1 for PostgreSQL data (pvc named `gogs-postgres-data`) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html) +* 2 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html). 1 for Gogs repositories data (pvc named `gogs-data`) and 1 for PostgreSQL data (pvc named `gogs-postgres-data`) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html) * OpenShift Command Line Tool * [Openshift Applier](https://github.com/redhat-cop/openshift-applier/) to deploy Gogs. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html) diff --git a/jenkins-slaves/jenkins-slave-image-mgmt/README.md b/jenkins-slaves/jenkins-slave-image-mgmt/README.md index 593c57743..d6f160403 100644 --- a/jenkins-slaves/jenkins-slave-image-mgmt/README.md +++ b/jenkins-slaves/jenkins-slave-image-mgmt/README.md @@ -10,7 +10,7 @@ Jenkins [Slave](https://wiki.jenkins-ci.org/display/JENKINS/Distributed+builds) ## Instantiate Template -A [template](../.openshift/templates/jenkins-slave-image-mgmt-template.yml) is available providing the necessary OpenShift components to build and make the slave image available to be referenced by Jenkins. +A [template]../../.openshift/templates/jenkins-slave-image-mgmt-template.yml) is available providing the necessary OpenShift components to build and make the slave image available to be referenced by Jenkins. Execute the following command to instantiate the template: diff --git a/jenkins-slaves/jenkins-slave-mongodb/README.md b/jenkins-slaves/jenkins-slave-mongodb/README.md index c6a809b4c..4733cb26e 100644 --- a/jenkins-slaves/jenkins-slave-mongodb/README.md +++ b/jenkins-slaves/jenkins-slave-mongodb/README.md @@ -17,7 +17,7 @@ oc process -f ../templates/jenkins-slave-generic-template.yml \ For all params see the list in the `../templates/jenkins-slave-generic-template.yml` or run `oc process --parameters -f ../templates/jenkins-slave-generic-template.yml`. ## Jenkins Running -Add a new Kubernetes Container template called `jenkins-slave-mongodb` and specify this as the node when running builds. Eg below for adding a new collection to a mongodb in OCP. NOTE: you may have to [connect the networks](https://docs.openshift.com/container-platform/latest/admin_guide/managing_networking.html#joining-project-networks) if deploying to a namespace outside where the Slave container is running. +Add a new Kubernetes Container template called `jenkins-slave-mongodb` and specify this as the node when running builds. Eg below for adding a new collection to a mongodb in OCP. NOTE: you may have to [connect the networks](https://docs.openshift.com/container-platform/3.11/admin_guide/managing_networking.html#joining-project-networks) if deploying to a namespace outside where the Slave container is running. ``` mongoimport --db ${PROJECT_NAMESPACE} --collection ${COLLECTION_NAME} --drop --file ${COLLECTION_NAME}.json --jsonArray --username=${MONGODB_USERNAME} --password=${MONGODB_PASSWORD} --host=mongodb.${PROJECT_NAMESPACE}.svc.cluster.local:27017 ``` diff --git a/jenkins-slaves/jenkins-slave-ruby/README.md b/jenkins-slaves/jenkins-slave-ruby/README.md index 4b0ba0d9c..1ea3b8b4b 100644 --- a/jenkins-slaves/jenkins-slave-ruby/README.md +++ b/jenkins-slaves/jenkins-slave-ruby/README.md @@ -11,7 +11,7 @@ Jenkins [Slave](https://wiki.jenkins-ci.org/display/JENKINS/Distributed+builds) ## Instantiate Template -A [template](../.openshift/templates/jenkins-slave-ruby-template.yml) is available providing the necessary OpenShift components to build and make the slave image available to be referenced by Jenkins. +A [template](../../.openshift/templates/jenkins-slave-ruby-template.yml) is available providing the necessary OpenShift components to build and make the slave image available to be referenced by Jenkins. Execute the following command to instantiate the template: diff --git a/linkcheck-config.json b/linkcheck-config.json new file mode 100644 index 000000000..0d17874e9 --- /dev/null +++ b/linkcheck-config.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": ".*.apps.example.com\/.*" + } + ] +} diff --git a/mongodb/README.md b/mongodb/README.md index 9faa71ac6..a885917e6 100644 --- a/mongodb/README.md +++ b/mongodb/README.md @@ -38,9 +38,9 @@ It makes use of the following technologies: ### OpenShift objects The openshift-applier will create the following OpenShift objects: * A Project named `mongodb` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Four Services named `mongodb-configsvr-internal`, `mongodb-replset-internal-abc`, `mongodb-replset-internal-def` and `mongodb-mongos-ext` (see [applier/templates/configsvr.yml](applier/templates/configsvr.yml), [applier/templates/replset.yml](applier/templates/replset.yml) and [applier/templates/mongos.yml](applier/templates/mongos.yml)) -* Three StatefulSets named `mongodbconfigsvr`, `mongodbreplset-abc`, `mongodbreplset-def` (see [applier/templates/configsvr.yml](applier/templates/configsvr.yml) and [applier/templates/replset.yml](applier/templates/replset.yml)) -* A DeploymentConfig named `mongodb-mongos` (see [applier/templates/mongos.yml](applier/templates/mongos.yml)) +* Four Services named `mongodb-configsvr-internal`, `mongodb-replset-internal-abc`, `mongodb-replset-internal-def` and `mongodb-mongos-ext` (see [.openshift/templates/configsvr.yml](.openshift/templates/configsvr.yml), [.openshift/templates/replset.yml](.openshift/templates/replset.yml) and [.openshift/templates/mongos.yml](.openshift/templates/mongos.yml)) +* Three StatefulSets named `mongodbconfigsvr`, `mongodbreplset-abc`, `mongodbreplset-def` (see [.openshift/templates/configsvr.yml](.openshift/templates/configsvr.yml) and [.openshift/templates/replset.yml](.openshift/templates/replset.yml)) +* A DeploymentConfig named `mongodb-mongos` (see [.openshift/templates/mongos.yml](.openshift/templates/mongos.yml)) >**NOTE:** This requires permission to create new projects and that the `mongodb` project doesn't already exist @@ -48,7 +48,7 @@ The openshift-applier will create the following OpenShift objects: The following prerequisites must be met prior to beginning to deploy MongoDB -* 11 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html). 3 for the config servers and 4 for each of the sharding replica sets [see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html) +* 11 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html). 3 for the config servers and 4 for each of the sharding replica sets [see below](#verify-storage)) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html) * OpenShift Command Line Tool * [Openshift Applier](https://github.com/redhat-cop/openshift-applier) to deploy MongoDB. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html) @@ -56,17 +56,17 @@ The following prerequisites must be met prior to beginning to deploy MongoDB ### Environment Specifications -This demo should be run on an installation of OpenShift Container Platform V3.5. A persistent volume must be statically predefined per replica set member pod, or configuration server member pod - this example will require 11 persistent volumes. Another option is have these persistent volumes allocated dynamically using a [StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html). An EBS storage class is provided as an example. +This demo should be run on an installation of OpenShift Container Platform V3.5. A persistent volume must be statically predefined per replica set member pod, or configuration server member pod - this example will require 11 persistent volumes. Another option is have these persistent volumes allocated dynamically using a [StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html). An EBS storage class is provided as an example. ### Template Files Three template files are available: -[configsvr.yml](applier/templates/configsvr.yml)- Contains a template for deploying a replica set of shard configuration servers. At least one member is required for setting up a fully sharded cluster. +[configsvr.yml](.openshift/templates/configsvr.yml)- Contains a template for deploying a replica set of shard configuration servers. At least one member is required for setting up a fully sharded cluster. -[mongos.yml](applier/templates/mongos.yml)- Contains a template for deploying a MongoDB shard router +[mongos.yml](.openshift/templates/mongos.yml)- Contains a template for deploying a MongoDB shard router -[replset.yml](applier/templates/replset.yml) - Contains a template for deploying a replica set. +[replset.yml](.openshift/templates/replset.yml) - Contains a template for deploying a replica set. ### Config Files diff --git a/rabbitmq/README.md b/rabbitmq/README.md index 650959175..3be176ac0 100644 --- a/rabbitmq/README.md +++ b/rabbitmq/README.md @@ -6,18 +6,18 @@ This demonstration describes how to create a RabbitMQ cluster in Openshift. ## Requirements 1. OpenShift Container Platform v3.6 or newer (we're using [this feature](https://docs.openshift.com/container-platform/3.6/dev_guide/managing_images.html#using-is-with-k8s)). -2. This example is configured to use a `PersistentVolume` for storing cluster and message data. Thus it is a requirement that Openshift is configured to support [Persistent Volumes](https://docs.openshift.com/container-platform/latest/dev_guide/persistent_volumes.html) and that there are PVs with at least `ReadWriteOnce` (RWO) access available. +2. This example is configured to use a `PersistentVolume` for storing cluster and message data. Thus it is a requirement that Openshift is configured to support [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/dev_guide/persistent_volumes.html) and that there are PVs with at least `ReadWriteOnce` (RWO) access available. 3. This example is also using the [OpenShift Applier](https://github.com/redhat-cop/openshift-applier) to build and deploy RabbitMQ. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html). ## OpenShift objects The openshift-applier will create the following OpenShift objects: * A Project named `rabbitmq` (see [files/projects/projects.yml](files/projects/projects.yml)) -* Two ImageStreams `rabbitmq` and `rhel` (see [files/builds/template.yml](files/builds/template.yml) and [files/imagestreams/images.yml](files/imagestreams/images.yml)) -* A BuildConfig named `rabbitmq` (see [files/builds/template.yml](files/builds/template.yml)) -* A RoleBinding named `rabbitmq` (see [files/deployments/template.yml](files/deployments/template.yml)) -* A Service named `rabbitmq` (see [files/deployments/template.yml](files/deployments/template.yml)) -* A StatefulSet named `rabbitmq` (see [files/deployments/template.yml](files/deployments/template.yml)) +* Two ImageStreams `rabbitmq` and `rhel` (see [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml) and [.openshift/templates/imagestreams/images.yml](.openshift/templates/imagestreams/images.yml)) +* A BuildConfig named `rabbitmq` (see [.openshift/templates/builds/template.yml](.openshift/templates/builds/template.yml)) +* A RoleBinding named `rabbitmq` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) +* A Service named `rabbitmq` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) +* A StatefulSet named `rabbitmq` (see [.openshift/templates/deployments/template.yml](.openshift/templates/deployments/template.yml)) ## Parameters | NAME | DESCRIPTION | VALUE diff --git a/sonarqube/README.md b/sonarqube/README.md index 021f96fdf..c05e11972 100644 --- a/sonarqube/README.md +++ b/sonarqube/README.md @@ -64,7 +64,7 @@ variable like `SONARQUBE_WEB_JVM_OPTS="-Dsonar.auth.google.allowUsersToSignUp=fa * Variable: SONAR_PLUGINS_LIST * displayName: SonarQube Plugins List - * Description: "Space separated list of plugins (See: https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix)" + * Description: "Space separated list of plugins See: [here](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix)" * Default Value: findbugs pmd ldap buildbreaker github gitlab * Variable: SONARQUBE_WEB_JVM_OPTS * displayName: Extra SonarQube startup properties @@ -100,7 +100,7 @@ variable like `SONARQUBE_WEB_JVM_OPTS="-Dsonar.auth.google.allowUsersToSignUp=fa * Default Value: * Variable: LDAP_REALM * displayName: LDAP realm - * Description: "A realm defines the namespace from which the authentication entity (the value of the Context.SECURITY_PRINCIPAL property) is selected. (See: http://docs.oracle.com/javase/jndi/tutorial/ldap/security/digest.html)" + * Description: "A realm defines the namespace from which the authentication entity (the value of the Context.SECURITY_PRINCIPAL property) is selected. See: [here](http://docs.oracle.com/javase/jndi/tutorial/ldap/security/digest.html)" * Default Value: * Variable: LDAP_CONTEXTFACTORY * displayName: JNDI ContextFactory to be used diff --git a/tool-box/README.md b/tool-box/README.md index a05d134ee..f99b3d9fe 100644 --- a/tool-box/README.md +++ b/tool-box/README.md @@ -19,7 +19,7 @@ If you need something not here, let us know in an issue or submit a PR. ### OpenShift -Assuming you have the [CLI installed](https://docs.openshift.com/container-platform/latest/cli_reference/get_started_cli.html) +Assuming you have the [CLI installed](https://docs.openshift.com/container-platform/3.11/cli_reference/get_started_cli.html) Build the container and deploy it in OpenShift: diff --git a/zalenium/README.md b/zalenium/README.md index cd67caa87..499e2c11a 100644 --- a/zalenium/README.md +++ b/zalenium/README.md @@ -2,7 +2,7 @@ The following prerequisites must be met prior to beginning to deploy [Zalenium](https://opensource.zalando.com/zalenium/) (A container based Selenium Grid) -* 1 [Persistent Volumes](https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/latest/install_config/storage_examples/storage_classes_dynamic_provisioning.html) +* 1 [Persistent Volumes](https://docs.openshift.com/container-platform/3.11/architecture/additional_concepts/storage.html) or a cluster that supports [dynamic provisioning with a default StorageClass](https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/storage_classes_dynamic_provisioning.html) * OpenShift Command Line Tool * [Openshift Applier](https://github.com/redhat-cop/openshift-applier/) to deploy GitLab CE. As a result you'll need to have [ansible installed](http://docs.ansible.com/ansible/latest/intro_installation.html)