Hello world container

Author: Pogrebnyak, Sergei

CONTRIBUTING.md

@@ -0,0 +1 @@
+Please see [Contributing section on wiki](https://github.com/SoftwareAG/sagdevops-templates/wiki/Contributing)

containers/docker-compose.yml

@@ -41,6 +41,23 @@ services:
     #   - ./scripts/provision.sh:/opt/sagtools/provision.sh
     #   - ./environments/:/src/environments/
 
+  hello-world:
+    image: ${REG:-softwareag}/hello-world:${TAG:-10.3}
+    build:
+      context: hello-world/
+      args:
+        - BUILDER_IMAGE=${REG:-softwareag}/commandcentral-builder:${TAG:-10.3}
+        - BASE_IMAGE=${REG:-softwareag}/java:${TAG:-10.3}
+        - __hello_world=Container       # container specific build ARG
+    ports:
+      - 8092                            # container specific ports
+      - 8093
+    environment:
+      - CC_AUTO_REGISTER=0              # No auto register
+      - HELLO_NAME=CONTAINER_INSTANCE   # container specific ENV var
+    # volumes:
+    #   - ./entrypoint.sh:/opt/softwareag/entrypoint.sh # for dev only to avoid image rebuild
+
   universal-messaging:
     image: ${REG:-softwareag}/universal-messaging:${TAG:-10.3}
     build:

containers/generic/Dockerfile

@@ -1,5 +1,5 @@
 ###############################################################################
-#  Copyright © 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
+#  Copyright 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
 #
 #   SPDX-License-Identifier: Apache-2.0
 #
@@ -16,27 +16,33 @@
 #     limitations under the License.                                                            
 #
 ###############################################################################
-ARG TAG=10.3
-ARG BUILDER_IMAGE=daerepository03.eur.ad.sag:4443/ccdevops/commandcentral-builder:$TAG
-ARG BASE_IMAGE=daerepository03.eur.ad.sag:4443/ibit/java:jdk-8-centos
+
+ARG BUILDER_IMAGE
+ARG BASE_IMAGE
 
 FROM $BUILDER_IMAGE as builder
 
-# build arg for hello.name template parameter
+# template alias to apply
+ARG TEMPLATE=sag-spm-config
+
+# build-time template parameter: hello.world
 ARG __hello_world=default
-# runtime container init parameter
+
+# run-time container init parameter
 ENV HELLO_NAME=default
 
-# Apply template.yaml with env.properties and run smoke tests
-RUN $CC_HOME/provision.sh && ./test.sh && $CC_HOME/cleanup.sh
+# Apply template.yaml, run smoke tests, cleanup
+RUN $CC_HOME/provision.sh $TEMPLATE && \
+    $CC_HOME/profiles/CCE/data/templates/composite/$TEMPLATE/test.sh && \
+    $CC_HOME/cleanup.sh
 
-# Target image
+# target image
 FROM $BASE_IMAGE
 
 # expose any ports from runtimes defined in the template.yaml
 EXPOSE 8092 8093
 
-COPY --from=builder $SAG_HOME $SAG_HOME
+COPY --from=builder --chown=1724:1724 $SAG_HOME $SAG_HOME
 
 # entrypoint scripts
 ADD entrypoint.sh $SAG_HOME

templates/sag-spm-config/Dockerfile renamed to containers/hello-world/Dockerfile

@@ -0,0 +1,74 @@
+<!-- Copyright 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
+
+   SPDX-License-Identifier: Apache-2.0
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+
+     limitations under the License.                                                  
+
+-->
+
+# Building Hello World container image
+
+Use this template to build a simple hello-world container image.
+
+## Requirements and limitations
+
+### Supported Software AG releases
+
+* Platform Manager 10.1 or higher
+* Command Central 10.3 or higher
+
+### Supported platforms
+
+* Docker 18.06-ce or higher
+
+### Supported use cases
+
+* Building a Docker image with configured Platform Manager
+
+## Building Docker image
+
+### Building using docker-compose
+
+Build the container image:
+
+```bash
+cd sagdevops-template/containers
+docker-compose build hello-world
+```
+
+Run the container:
+
+```bash
+docker-compose up -d hello-world
+docker-compose port hello-world 8092
+```
+
+Open Platform Manager in the browser using the address printed above:
+
+```bash
+open http://localhost:PORT/spm
+```
+
+Login as `Administrator/manage`
+
+Examine the configuration.
+
+### Parameterizing configuration
+
+You can provide the configuration values by:
+
+* Hardcoding them in the template.
+* Defining them as parameters in an [env.properties](env.properties) file.
+* Defining them as build arguments in [Dockerfile](Dockerfile) and [docker-compose.yml](../docker-compose.xml) file. See `__hello_world`.
+* Defining them in the template as ENV variables resolved at container startup. See `%HELLO_NAME%`

containers/hello-world/README.md

@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #*******************************************************************************
-#  Copyright © 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
+#  Copyright � 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
 #
 #   SPDX-License-Identifier: Apache-2.0
 #
@@ -17,5 +17,6 @@
 #     limitations under the License.                                                            
 #
 #*******************************************************************************
+
 echo "Hello $HELLO_NAME !"
 $SAG_HOME/profiles/SPM/bin/console.sh

templates/sag-spm-config/entrypoint.sh renamed to containers/hello-world/entrypoint.sh

@@ -1,5 +1,5 @@
 ###############################################################################
-#  Copyright 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
+#  Copyright � 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
 #
 #   SPDX-License-Identifier: Apache-2.0
 #
@@ -16,23 +16,6 @@
 #     limitations under the License.                                                            
 #
 ###############################################################################
-version: "3.2"
 
-services:
-  spm:
-    image: daerepository03.eur.ad.sag:4443/ccdevops/commandcentral-node:$TAG # target image
-    build:
-      context: .
-      dockerfile: Dockerfile            # instructions to build image
-      args:
-        - TAG
-        - __hello_world=Container       # container specific build ARG
-    ports:
-      - 8092                            # container specific ports
-      - 8093
-    environment:
-      - CC_AUTO_REGISTER=0              # No auto register as we don't have a server
-      - HELLO_NAME=CONTAINER_INSTANCE   # container specific ENV var
-    # volumes:
-    #   - ./entrypoint.sh:/opt/softwareag/entrypoint.sh # for dev only to avoid image rebuild
-    #   - ./test.sh:/test.sh # for dev only to avoid image rebuild
+# parameters to bake into the Docker image build
+hello.world=CommandCentral

templates/sag-spm-config/docker-compose.yml renamed to containers/hello-world/env.properties

@@ -0,0 +1,105 @@
+<!-- Copyright 2013 - 2018 Software AG, Darmstadt, Germany and/or its licensors
+
+   SPDX-License-Identifier: Apache-2.0
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+
+     limitations under the License.                                                  
+
+-->
+
+# Building Universal Messaging container image
+
+Use this template to build a Universal Messaging container image.
+
+## Requirements and limitations
+
+### Supported Software AG releases
+
+* Universal Messaging 10.3 or higher
+* Command Central 10.3 or higher
+
+### Supported platforms
+
+* Docker 18.06-ce or higher
+
+## Building Docker image
+
+### Building using docker-compose
+
+Build the container image:
+
+```bash
+cd sagdevops-template/containers
+docker-compose build universal-messaging
+```
+
+Run the container:
+
+```bash
+docker-compose up -d hello-world
+docker-compose port hello-world 8092
+```
+
+Open Platform Manager in the browser using the address printed above:
+
+```bash
+open http://localhost:PORT/spm
+```
+
+Login as `Administrator/manage`
+
+Examine the configuration.
+
+## Running containers
+
+### Using Docker
+
+Use the following content for the `docker-compose.yml` file, then run `docker-compose up`.
+
+```yaml
+version: '3'
+services:
+  um:
+    image: universal-messaging
+    ports:
+      - '9000:9000'
+```
+
+Or you can use `docker run` directly:
+
+```shell
+docker run \
+  --name um \
+  -p 9000:9000 \
+  -d \
+  universal-messaging
+```
+
+Universal Messaing Realm Server is accessible on port 9000.
+
+### Using Kubernetes
+
+Copy the following content to `pod.yaml` file, and run `kubectl create -f pod.yaml`.
+
+```yaml
+apiVersion: v1
+kind: Pod
+metadata:
+  name: um
+  labels:
+    name: um
+spec:
+  containers:
+    - image: universal-messaging
+      name: um
+```

containers/universal-messaging/README.md

@@ -16,6 +16,7 @@
      limitations under the License.                                                  
 
 -->
+
 # Platform Manager Configurations
 
 Use this template to configure Platform Manager.
@@ -37,43 +38,13 @@ All supported Windows and UNIX platforms.
   * Tanuki Java Service wrapper
   * Java System properties
   * Monitoring interval
-* Building a Docker image with configured Platform Manager
 
 ## Running as a composite template
 
-To apply custom configurations to two Platform Managers, registered as node1 and node2:
+Apply custom configurations to Platform Managers, registered as `node1` and `node2`:
 
 ```bash
 sagcc exec templates composite apply sag-spm-config nodes=node1,node2 \
-  hello.world=spm \
-  --sync-job --wait 360
+    hello.world=spm \
+    --sync-job --wait 360
 ```
-
-## Building Docker image
-
-You can build a Docker image with a custom Platform Manager configuration, where you can provide the configuration values by:
-
-* Hardcoding them in the template.
-* Defining them as parameters in an [env.properties](env.properties) file.
-* Defining them as build arguments in Dockerfile and docker-compose.yml file. See `__hello_world`.
-* Defineing them in the template as ENV variables resolved at container startup. See `%HELLO_NAME%`.
-
-To build a Docker image with custom Platform Manager configuration:
-
-```bash
-docker-compose build
-```
-
-To run the container:
-
-```bash
-docker-compose up -d node
-```
-
-To open Platform Manager in the browser:
-
-```bash
-open http://`docker-compose port node 8092`/spm
-```
-
-Login as `Administrator/manage`.