Versions Compared

Old Version 22

changes.mady.by.user Bradley Andersen

Saved on

compared with

New Version Current

changes.mady.by.user Bradley Andersen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The best way is actually to follow the advice here.

Running Magnolia on OpenShift

Two ways: as a standalone WAR file, or using Docker.

as a standalone WAR

...

Creating an App

There are many ways to create an OpenShift application, including:

  • from source code
    • oc new-app /path/to/someUser/someProject
    • oc new-app

...

    • https://

...

    • github.

...

    • com/

...

    • someUser/someProject
  • from docker images
    • oc new-app someImageOnDockerHub
    • oc new-app localhost:5000/someImage
  • from templates
    • oc new-app someOpenShiftTemplate
    • oc new-app -f /path/to/someTemplate.json
  • using the web console

Deploying an App

When we deploy an app, we deploy three things:

  • configuration
    • this describes the desired state of your application
  • replication controller(s)
    • this is basically a snapshot of some state of your application (the system will create this for you)
  • pod(s)
    • this is basically an instance of the app you created

If you create an app, as per above, you can inspect the configuration file for your app thusly:

Expand
Code Block
[bandersen@li1397-60 docker]$ oc get route magnoliax -o yaml
apiVersion: route.openshift.io/v1
kind: Route
metadata:
  annotations:
    openshift.io/host.generated: "true"
  creationTimestamp: 2018-04-19T07:05:27Z
  labels:
    app: magnoliax
  name: magnoliax
  namespace: default
  resourceVersion: "100481"
  selfLink: /apis/route.openshift.io/v1/namespaces/default/routes/magnoliax
  uid: 09f3ab6f-43a0-11e8-ba2b-6ee30226f73c
spec:
  host: magnoliax-default.139.162.131.60.nip.io
  port:
    targetPort: 8080-tcp
  to:
    kind: Service
    name: magnoliax
    weight: 100
  wildcardPolicy: None
status:
  ingress:
  - conditions:
    - lastTransitionTime: 2018-04-19T07:05:27Z
      status: "True"
      type: Admitted
    host: magnoliax-default.139.162.131.60.nip.io
    routerName: router
    wildcardPolicy: None
[bandersen@li1397-60 docker]$


Running Magnolia on OpenShift

Two ways: as a standalone WAR file, or using Docker.

as a standalone WAR

Code Block
wget https://files.magnolia-cms.com/5.6/magnolia-enterprise-pro-demo-webapp-5.6.war -O magnoliaauthor.war
Note

The name is important here.  The name we use in the next command has to follow these rules:

Must be an a lower case alphanumeric (a-z, and 0-9) string with a maximum length of 58 characters, where the first character is a letter (a-z), and the '-' character is allowed anywhere except the first or last character.

Code Block
oc new-app wildfly:latest~. --name magnoliaauthor

You should get some output like:

Code Block
[bandersen@li1397-60 ~]$ oc new-app wildfly:latest~. --name magnoliaauthor
--> Found image fdd5894 (4 weeks old) in image stream "openshift/wildfly" under tag "latest" for "wildfly:latest"

    WildFly 10.1.0.Final
    --------------------
    Platform for building and running JEE applications on WildFly 10.1.0.Final

    Tags: builder, wildfly, wildfly10

    * A source build using binary input will be created
      * The resulting image will be pushed to image stream "magnoliaauthor:latest"
      * A binary build was created, use 'start-build --from-dir' to trigger a new build
    * This image will be deployed in deployment config "magnoliaauthor"
    * Port 8080/tcp will be load balanced by service "magnoliaauthor"
      * Other containers can access this service through the hostname "magnoliaauthor"

--> Creating resources ...
    imagestream "magnoliaauthor" created
    buildconfig "magnoliaauthor" created
    deploymentconfig "magnoliaauthor" created
    service "magnoliaauthor" created
--> Success
    Build scheduled, use 'oc logs -f bc/magnoliaauthor' to track its progress.
    Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
     'oc expose svc/magnoliaauthor'
    Run 'oc status' to view your app.
[bandersen@li1397-60 ~]$

Now we build it and then we can go see it:

Code Block
[bandersen@li1397-60 ~]$ oc start-build magnoliaauthor --from-file=magnoliaauthor.war
Uploading file "magnoliaauthor.war" as binary input for the build ...
build "magnoliaauthor-2" started

[bandersen@li1397-60 ~]$ oc get routes
NAME             HOST/PORT                                      PATH      SERVICES         PORT       TERMINATION   WILDCARD
magnoliaauthor   magnoliaauthor-default.139.162.131.60.nip.io             magnoliaauthor   8080-tcp                 None

So if we go to http://magnoliaauthor-default.139.162.131.60.nip.io/magnoliaauthor, we should see Magnolia 5.6 running on WildFly.

using Docker

You could use something from Docker Hub, or from a local Docker image, like so:

Expand
Code Block
[root@localhost ~]# oc new-app magnolia-1 --name magnoliax
W0419 07:05:16.233491   28843 newapp.go:480] Could not find an image stream match for "magnolia-1:latest". Make sure that a Docker image with that tag is available on the node for the deployment to succeed.
--> Found Docker image bdd1731 (18 hours old) from  for "magnolia-1:latest"
Note

The name is important here.  The name we use in the next command has to follow these rules:

Must be an a lower case alphanumeric (a-z, and 0-9) string with a maximum length of 58 characters, where the first character is a letter (a-z), and the '-' character is allowed anywhere except the first or last character.

Code Block
oc new-app wildfly:latest~. --name magnoliaauthor

You should get some output like:

Code Block
[bandersen@li1397-60 ~]$ oc new-app wildfly:latest~. --name magnoliaauthor --> Found image fdd5894 (4 weeks old) in image stream "openshift/wildfly" under tag "latest" for "wildfly:latest" WildFly 10.1.0.Final -------------------- Platform for building and running JEE applications on WildFly 10.1.0.Final Tags: builder, wildfly, wildfly10 * A source build using binary input will be created * The resulting image will be pushed to image stream "magnoliaauthor:latest" * A binary build was created, use 'start-build --from-dir' to trigger a new build

    * This image will be deployed in deployment config "
magnoliaauthor
magnoliax"
    * Port 8080/tcp will be load balanced by service "
magnoliaauthor
magnoliax"
      * Other containers can access
this service through the hostname "magnoliaauthor"
 this service through the hostname "magnoliax"
    * WARNING: Image "magnolia-1:latest" runs as the 'root' user which may not be permitted by your cluster administrator

--> Creating resources ...
imagestream "magnoliaauthor" created buildconfig "magnoliaauthor" created

    deploymentconfig "
magnoliaauthor
magnoliax" created
    service "
magnoliaauthor
magnoliax" created
--> Success
Build scheduled, use 'oc logs -f bc/magnoliaauthor' to track its progress.
--> Success
    Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
'oc expose svc/magnoliaauthor'
Run 'oc status' to view
your app. [bandersen@li1397-60
~]$

Now we build it and then we can go see it:

Code Block
[bandersen@li1397-60 ~]$ oc start-build magnoliaauthor --from-file=magnoliaauthor.war Uploading file "magnoliaauthor.war" as binary input for the build ... build "magnoliaauthor-2" started [bandersen@li1397-60 ~]$
   'oc expose svc/magnoliax'
    Run 'oc status' to view your app.
[root@localhost ~]# oc expose svc/magnoliax
route "magnoliax" exposed
[root@localhost ~]# oc get routes
NAME             HOST/PORT                                      PATH      SERVICES         PORT       TERMINATION   WILDCARD
magnoliaauthor   magnoliaauthor-default.139.162.131.60.nip.io             magnoliaauthor   8080-tcp                 None

So if we go to http://magnoliaauthor-default.139.162.131.60.nip.io/magnoliaauthor, we should see Magnolia 5.6 running on WildFly.

using Docker

You could use something from Docker Hub, or from a local Docker image, like so:


magnoliax        magnoliax-default.139.162.131.60.nip.io                  magnoliax        8080-tcp                 None
[root@localhost ~]#

Troubleshooting

If for some reason your app is not running, you can check the logs, by pod name:

Expand
Code Block
[bandersen@li1397-60 docker]$ oc get pod --all-namespaces -o wide
NAMESPACE               NAME                            READY     STATUS      RESTARTS   AGE       IP               NODE
default                 docker-registry-1-p9fc8         1/1       Running     0          20h       172.17.0.5       localhost
default
Expand
Code Block
[root@localhost ~]# oc new-app magnolia-1 --name magnoliax
W0419 07:05:16.233491   28843 newapp.go:480] Could not find an image stream match for "magnolia-1:latest". Make sure that a Docker image with that tag is available on the node for the deployment to succeed.
--> Found Docker image bdd1731 (18 hours old) from  for "magnolia-1:latest"

    * This image will be deployed in deployment config "magnoliax"
    * Port 8080/tcp will be load balanced by service "magnoliax"
      * Other containers can access this service through the hostname "magnoliax"
    * WARNING: Image "magnolia-1:latest" runs as the 'root' user which may not be permitted by your cluster administrator

--> Creating resources ...
    deploymentconfig "magnoliax" created
    service "magnoliax" created
--> Success
    Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
     'oc expose svc/magnoliax'
    Run 'oc status' to view your app.
[root@localhost ~]# oc expose svc/magnoliax
route "magnoliax" exposed
[root@localhost ~]# oc get routes
NAME             HOST/PORT    magnoliaauthor-1-build          0/1       Completed   0          19h    PATH   172.17.0.2   SERVICES     localhost
default    PORT       TERMINATION   WILDCARD
magnoliaauthor   magnoliaauthor-default.139.162.131.60.nip.io2-build             magnoliaauthor0/1   8080-tcp    Completed   0          None
magnoliax19h        magnoliax-default.139.162.131.60.nip.io172.17.0.2       localhost
default           magnoliax      magnoliaauthor-2-djlpt  8080-tcp        1/1       Running  None
[root@localhost ~]#

Troubleshooting

If for some reason your app is not running, you can check the logs, by pod name:

Expand
Code Block
[bandersen@li1397-60 docker]$ oc get pod --all-namespaces -o wide
NAMESPACE      0          19h       172.17.0.2       localhost
default     NAME            magnoliax-1-deploy              0/1  READY     STATUSError      RESTARTS 0  AGE       IP 35m       172.17.0.3       NODElocalhost
default                 dockerpersistent-registryvolume-1setup-p9fc868t4w         10/1       RunningCompleted     0          20h       172.17.0.53       localhost
default                 magnoliaauthorrouter-1-buildhpvfq          0/1       Completed 1/1  0      Running    19h       172.17.0.2       localhost
default   20h       139.162.131.60       magnoliaauthor-2-buildlocalhost
openshift-web-console   webconsole-7dfbffd44d-mfzt8     1/1  0/1     Running  Completed   0          19h20h       172.17.0.24       localhost
default                 magnoliaauthor-2-djlpt          1/1       Running     0          19h       172.17.0.2       localhost
default                 magnoliax-1-deploy              0/1       Error       0          35m       172.17.0.3       localhost
default                 persistent-volume-setup-68t4w   0/1       Completed   0          20h       172.17.0.3       localhost
default                 router-1-hpvfq  [bandersen@li1397-60 docker]$ oc logs magnoliax-1-deploy
--> Scaling magnoliax-1 to 1
error: update acceptor rejected magnoliax-1: pods for rc 'default/magnoliax-1' took longer than 600 seconds to become available
[bandersen@li1397-60 docker]$

https://developers.redhat.com/blog/2017/08/16/troubleshooting-java-applications-on-openshift/

Expand
Code Block
[bandersen@li1397-60 docker]$ oc get route magnoliax -o yaml
apiVersion: route.openshift.io/v1
kind: Route
metadata:
  annotations:
    openshift.io/host.generated: "true"
  creationTimestamp: 2018-04-19T07:05:27Z
  labels:
    app: magnoliax
  name: magnoliax
  namespace: default
  resourceVersion: "100481"
  selfLink: /apis/route.openshift.io/v1/namespaces/default/routes/magnoliax
  uid: 09f3ab6f-43a0-11e8-ba2b-6ee30226f73c
spec:
  host: magnoliax-default.139.162.131.60.nip.io
  port:
    targetPort: 8080-tcp
  to:
    kind: Service
    name: magnoliax
    weight: 100
  wildcardPolicy: None
status:
  ingress:
  - conditions:
    - lastTransitionTime: 2018-04-19T07:05:27Z
      status: "True"
      type: Admitted
    host: magnoliax-default.139.162.131.60.nip.io
    routerName: router
    wildcardPolicy: None
[bandersen@li1397-60 docker]$

or

Code Block
[bandersen@li1397-60 docker]$ oc describe dc magnoliax
Name:        magnoliax
Namespace:    default
Created:    1/17 hours ago
Labels:     Running   app=magnoliax
Annotations:  0    openshift.io/generated-by=OpenShiftNewApp
Latest Version:    1
Selector:  20h  app=magnoliax,deploymentconfig=magnoliax
Replicas:     139.162.131.601
Triggers:    localhost
openshift-web-consoleConfig
Strategy:   webconsole-7dfbffd44d-mfzt8     1/1       Running     0 Rolling
Template:
Pod Template:
  Labels:    app=magnoliax
        deploymentconfig=magnoliax
  Annotations:  20h  openshift.io/generated-by=OpenShiftNewApp
  Containers:
   172.17.0.4magnoliax:
     Image:  localhost
[bandersen@li1397-60 docker]$ oc logs magnoliax-1-deploy
--> Scaling magnoliaxmagnolia-1 to 1
error: update acceptor rejected magnoliax-1: pods for rc 'default/magnoliax-1' took longer than 600 seconds to become available
[bandersen@li1397-60 docker]$

https://developers.redhat.com/blog/2017/08/16/troubleshooting-java-applications-on-openshift/

Expand
Code Block
[bandersen@li1397-60 docker]$ oc get route magnoliax -o yaml
apiVersion: route.openshift.io/v1
kind: Route
metadata:
  annotations:
    openshift.io/host.generated: "true"
  creationTimestamp: 2018-04-19T07:05:27Z
  labels:
    app: magnoliax
  name: magnoliax
  namespace: default
  resourceVersion: "100481"
  selfLink: /apis/route.openshift.io/v1/namespaces/default/routes/magnoliax
  uid: 09f3ab6f-43a0-11e8-ba2b-6ee30226f73c
spec:
  host: magnoliax-default.139.162.131.60.nip.io
  port:
    targetPort: 8080-tcp
  to:
    kind: Service
    name: magnoliax
    weight: 100
  wildcardPolicy: None
status:
  ingress:
  - conditions:
    - lastTransitionTime: 2018-04-19T07:05:27Z
      status: "True"
      type: Admitted
    host: magnoliax-default.139.162.131.60.nip.io
    routerName: router
    wildcardPolicy: None:latest
    Port:        8080/TCP
    Environment:    <none>
    Mounts:        <none>
  Volumes:        <none>

Deployment #1 (latest):
    Name:        magnoliax-1
    Created:    7 hours ago
    Status:        Failed
    Replicas:    0 current / 0 desired
    Selector:    app=magnoliax,deployment=magnoliax-1,deploymentconfig=magnoliax
    Labels:        app=magnoliax,openshift.io/deployment-config.name=magnoliax
    Pods Status:    0 Running / 0 Waiting / 0 Succeeded / 0 Failed

Events:    <none>
[bandersen@li1397-60 docker]$

...