From cce803aa514aa944901a3cd2730c7359bf566433 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Mass=C3=A9?= Date: Fri, 19 May 2017 12:21:27 +0100 Subject: [PATCH] improve doc --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7676e69..7d2cae6 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ a packaged and polished version of the Kubernetes Incubator's Hostpath Provision The original license is Apache 2.0. This project remains under the same license. -_Main differences from the original project :_ +__Main differences from the original project :__ - OpenShift Template that works Out-of-the-Box - Naming convention (namespace/pvc-name instead of GUID) - Configurable root directory (HOSTPATH_TO_USE parameter) - Docker Image available on DockerHub (https://hub.docker.com/r/nmasse/openshift-hostpath-provisioner/) -_Current limitations :_ +__Current limitations :__ - **DO NOT USE IT IN PRODUCTION** - Only works on OpenShift clusters that have a single node @@ -79,7 +79,7 @@ oc process -f setup/hostpath-provisioner-template.yaml -p TARGET_NAMESPACE=my-pr oc create -f objects.json ``` -_Note about the file 'objects.json' :_ +__Note about the file 'objects.json' :__ It's a good idea to keep that file safe since it will be use to clean up your OpenShift instance in case you change your mind. See the cleanup section below.