Readme instructions for OpenShift sample

Author: matrober-uk

.gitignore

@@ -1,2 +1,3 @@
 mq-golang-jms20.test
 vendor
+.DS_Store

openshift-app-sample/README.md

@@ -0,0 +1,91 @@
+# IBM MQ Golang application tutorial for OpenShift
+This sample provides a working template that you can use to build your own Golang
+application container image that runs in Red Hat OpenShift under the most secure
+"Restricted SCC" and uses the
+[IBM MQ Golang](https://github.com/ibm-messaging/mq-golang) or
+[IBM MQ Golang JMS](https://github.com/ibm-messaging/mq-golang-jms20) libraries to connect
+to an IBM MQ queue manager.
+
+You can build and run your application using the following simple steps;
+1. Modify the application file to add your code
+2. Build the application into a Docker container image locally
+3. Push the container image to your OpenShift cluster
+4. Configure the variables and run the application!
+
+
+Let's get started!
+
+
+## Step 1: Modify the application file to add your code
+Add your application logic into the [main.go](./src/main.go) file using either the
+[IBM MQ Golang](https://github.com/ibm-messaging/mq-golang) or
+[IBM MQ Golang JMS](https://github.com/ibm-messaging/mq-golang-jms20) interfaces depending
+on your preference.
+
+The file contains all the basic details necessary to create a
+connection to a queue manager, so you can simply add your logic to send and/or receive
+messages at the bottom of the function.
+
+
+## Step 2: Build the application into a Docker container image locally
+Open a command shell to the same directory as this readme file and execute the following command;
+```bash
+# Run the dockerfile build to create the container image
+docker build -t golang-app -f Dockerfile .
+```
+
+
+## Step 3: Push the container image to your OpenShift cluster
+This step will vary depending on what sort of OpenShift cluster you are going to deploy to - 
+for example a registry that is part of the cluster or an external registry that can be
+accessed by the cluster.
+
+In this example we are using the IBM Cloud Container Registry (in London) that is hosted
+at `uk.icr.io`.
+
+```bash
+# Tag the new image against the target registry
+docker tag golang-app uk.icr.io/golang-sample/golang-app:1.0
+
+# Push the updated image to your registry
+docker push uk.icr.io/golang-sample/golang-app:1.0
+```
+
+**Note:** If you are iterating over this step multiple times while testing your application then
+don't forget to increase the tag version each time as image caching on cluster may mean
+that your updates don't actually get used when you expect them to!
+
+
+## Step 4: Configure the variables and run the application!
+Next we will do a one-time set up of some basic objects on the cluster in order to
+supply configuration settings to the application. 
+
+```bash
+# Create a service account that we can use to deploy using the Restricted SCC
+oc apply -f ./yaml/sa-pod-deployer.yaml
+
+# Create a config map containing the details of your queue manager.
+#
+# If your queue manager is in the same OpenShift cluster then the hostname will be the
+# name of the "service".
+oc create configmap qmgr-details \
+    --from-literal=HOSTNAME=mydynamichostname \
+    --from-literal=PORT=34567 \
+    --from-literal=QMNAME=QM100 \
+    --from-literal=CHANNELNAME=SYSTEM.DEF.SVRCONN
+
+# If necessary, create a secret to hold the username and password your application should
+# use to authenticate to the queue manager.
+oc create secret generic qmgr-credentials \
+    --from-literal=USERNAME=appuser100 \
+    --from-literal=PASSWORD='password100'
+```
+
+Now run the application!
+```bash
+# Before you run this command, be sure to update the "image" attribute on
+# line 8 of pod-sample.yaml so that it matches your image tag version from step 3.
+oc apply -f ./yaml/pod-sample.yaml --as=my-service-account
+```
+
+Congratulations - and happy messaging!

openshift-app-sample/src/main.go

@@ -21,14 +21,6 @@ import (
 func main() {
 	fmt.Println("Beginning world!!!")
 
-	fmt.Println("host: ", os.Getenv("HOSTNAME"))
-	fmt.Println("port: ", os.Getenv("PORT"))
-	fmt.Println("qm: ", os.Getenv("QMNAME"))
-	fmt.Println("channel: ", os.Getenv("CHANNELNAME"))
-
-	fmt.Println("user: ", os.Getenv("USERNAME"))
-	fmt.Println("pw: ", os.Getenv("PASSWORD"))
-
 	portNum, _ := strconv.Atoi(os.Getenv("PORT"))
 
 	// Initialise the attributes of the CF in whatever way you like