Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 1.95 KB

docs_production_deployment.adoc

File metadata and controls

51 lines (41 loc) · 1.95 KB
Raw

Production deployment of the OpenShift documentation

Source-to-image pipeline

OpenShift documentation is built and deployed on an OpenShift Dedicated cluster using a source-to-image build pipeline.

The source-to-image builder image is built from a community project in GitHub and published to https://quay.io/repository/openshift-cs/docs-builder.

Documentation deployment

Deploying the OpenShift documentation is simplified by using a pre-built OpenShift template YAML.

You can use the following command to deploy the OpenShift Container Platform (commercial) documentation:

oc new-app https://raw.githubusercontent.com/openshift-cs/docs-builder/main/template.yaml \
    -p NAME=docs-openshift-com \
    -p PACKAGE=commercial \
    -p APPLICATION_DOMAIN=docs.openshift.com \
    -p BUILD_REPO=https://github.com/openshift/openshift-docs.git \
    -p BUILD_BRANCH=main

You can use the following command to deploy the OKD (community) documentation

oc new-app https://raw.githubusercontent.com/openshift-cs/docs-builder/main/template.yaml \
    -p NAME=docs-openshift-com \
    -p PACKAGE=community \
    -p APPLICATION_DOMAIN=docs.openshift.com \
    -p BUILD_REPO=https://github.com/openshift/openshift-docs.git \
    -p BUILD_BRANCH=main

Deployment customization

It’s possible to change the documentation source repository to another repository for development by changing the BUILD_REPO parameter in the oc new-app command.

To change the builder image, provide the BUILDER_IMAGE parameter in the oc new-app command.