c. Using Design Console with Voyager(non-SSL)

Configure a Voyager ingress (non-SSL) to allow Design Console to connect to your Kubernetes cluster.

Add the Voyager ingress using helm

Note: If already using Voyager with non-SSL for OIG you can skip this section:

  1. Add the Helm chart repository for Voyager using the following command:

    $ helm repo add appscode https://charts.appscode.com/stable

    The output will look similar to the following:

    "appscode" has been added to your repositories

  2. Update the repository using the following command:

    $ helm repo update

    The output will look similar to the following:

    Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "appscode" chart repository
Update Complete. Happy Helming!

  3. Create a namespace for Voyager:

    $ kubectl create namespace voyager

    The output will look similar to the following:

    namespace/voyager created

Install Voyager ingress using helm

   $ helm install voyager-designconsole-operator appscode/voyager --version v12.0.0-rc.1 --namespace voyager --set cloudProvider=baremetal --set apiserver.enableValidatingWebhook=false

Note: For bare metal Kubernetes use --set cloudProvider=baremetal. If using a managed Kubernetes service then the value should be set for your specific service as per the Voyager install guide.

The output will look similar to the following:

NAME: voyager-designconsole-operator
LAST DEPLOYED: Wed Oct 21 08:31:32 2020
NAMESPACE: voyager
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Set cloudProvider for installing Voyager

To verify that Voyager has started, run:

  kubectl --namespace=voyager get deployments -l "release=voyager-designconsole-operator, app=voyager"

Setup Routing Rules for the Design Console ingress

  1. Setup routing rules by running the following commands:

    $ cd <work directory>/weblogic-kubernetes-operator/kubernetes/samples/charts/design-console-ingress
$ cp values.yaml values.yaml.orig
$ vi values.yaml

    Edit values.yaml and ensure that type=VOYAGER, tls=NONSSL and domainUID: governancedomain are set, and that webPortandstatsPort` are set to free ports, for example:

    $ cat values.yaml
# Copyright 2020 Oracle Corporation and/or its affiliates.
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.

# Default values for design-console-ingress.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

# Load balancer type.  Supported values are: VOYAGER, NGINX
type: VOYAGER
# Type of Configuration Supported Values are : NONSSL,SSL
# tls: NONSSL
tls: NONSSL
# TLS secret name if the mode is SSL
secretName: dc-tls-cert


# WLS domain as backend to the load balancer
wlsDomain:
  domainUID: governancedomain
  oimClusterName: oim_cluster
  oimServerT3Port: 14001

# Voyager specific values
voyager:
  # web port
  webPort: 30325
  # stats port
  statsPort: 30326

Create the ingress

  1. Run the following command to create the ingress:

    $ cd <work directory>/weblogic-kubernetes-operator
$ helm install governancedomain-voyager-designconsole kubernetes/samples/charts/design-console-ingress  --namespace oigns  --values kubernetes/samples/charts/design-console-ingress/values.yaml

    For example:

    $ cd /scratch/OIGDockerK8S/weblogic-kubernetes-operator
$ helm install governancedomain-voyager-designconsole kubernetes/samples/charts/design-console-ingress  --namespace oigns  --values kubernetes/samples/charts/design-console-ingress/values.yaml

    The output will look similar to the following:

    NAME: governancedomain-voyager-designconsole
LAST DEPLOYED: Wed Oct 21 08:36:03 2020
NAMESPACE: oigns
STATUS: deployed
REVISION: 1
TEST SUITE: None

  2. Run the following command to show the ingress is created successfully:

    $ kubectl get ingress.voyager.appscode.com -n <domain_namespace>

    For example:

    $ kubectl get ingress.voyager.appscode.com -n oigns

    The output will look similar to the following:

    NAME                                     HOSTS   LOAD_BALANCER_IP   AGE
governancedomain-voyager-designconsole   *                          10s

  3. Return details of the ingress using the following command:

    $ kubectl describe ingress.voyager.appscode.com governancedomain-voyager-designconsole -n oigns

    The output will look similar to the following:

    Name:         governancedomain-voyager-designconsole
Namespace:    oigns
Labels:       app.kubernetes.io/managed-by=Helm
              weblogic.resourceVersion=domain-v2
Annotations:  ingress.appscode.com/affinity: cookie
              ingress.appscode.com/stats: true
              ingress.appscode.com/type: NodePort
              meta.helm.sh/release-name: governancedomain-voyager-designconsole
              meta.helm.sh/release-namespace: oigns
API Version:  voyager.appscode.com/v1beta1
Kind:         Ingress
Metadata:
  Creation Timestamp:  2020-10-21T15:46:29Z
  Generation:          1
  Managed Fields:
    API Version:  voyager.appscode.com/v1beta1
    Fields Type:  FieldsV1
    fieldsV1:
      f:metadata:
        f:annotations:
          .:
          f:ingress.appscode.com/affinity:
          f:ingress.appscode.com/stats:
          f:ingress.appscode.com/type:
          f:meta.helm.sh/release-name:
          f:meta.helm.sh/release-namespace:
        f:labels:
          .:
          f:app.kubernetes.io/managed-by:
          f:weblogic.resourceVersion:
      f:spec:
        .:
        f:frontendRules:
        f:rules:
        f:tls:
    Manager:         Go-http-client
    Operation:       Update
    Time:            2020-10-21T15:46:29Z
  Resource Version:  6082128
  Self Link:         /apis/voyager.appscode.com/v1beta1/namespaces/oigns/ingresses/governancedomain-voyager-designconsole
  UID:               a4968c01-28eb-4e4a-ac31-d60cfcd8705f
Spec:
  Frontend Rules:
    Port:  443
    Rules:
      http-request set-header WL-Proxy-SSL true
   Rules:
    Host:  *
    Http:
      Node Port:  30325
      Paths:
        Backend:
          Service Name:  governancedomain-cluster-oim-cluster
          Service Port:  14001
        Path:            /
  Tls:
    Hosts:
      *
    Secret Name:  governancedomain-tls-cert
Events:
  Type     Reason                           Age   From              Message
  ----     ------                           ----  ----              -------
  Normal  DeploymentReconcileSuccessful  55m   voyager-operator  Successfully patched HAProxy Deployment voyager-governancedomain-voyager-designconsole
  Normal  DeploymentReconcileSuccessful  45m   voyager-operator  Successfully patched HAProxy Deployment voyager-governancedomain-voyager-designconsole

Design Console Client

It is possible to use Design Console from an on-premises install, or from a container image.

Using an on-premises installed Design Console

  1. Install Design Console on an on-premises machine

  2. Follow Login to the Design Console.

Using a container image for Design Console

The Design Console can be run from a container using X windows emulation.

  1. On the parent machine where the Design Console is to be displayed, run xhost+.

  2. Execute the following command to start a container to run Design Console:

    $ docker run -u root --name oigdcbase -it <image> bash

    For example:

    $ docker run -u root -it --name oigdcbase oracle/oig:12.2.1.4.0 bash

    This will take you into a bash shell inside the container:

    bash-4.2#

  3. Inside the container set the proxy, for example:

    bash-4.2# export https_proxy=http://proxy.example.com:80

  4. Install the relevant X windows packages in the container:

    bash-4.2# yum install libXext libXrender libXtst

  5. Execute the following outside the container to create a new Design Console image from the container:

    $ docker commit <container_name> <design_console_image_name>

    For example:

    $ docker commit oigdcbase oigdc

  6. Exit the container bash session:

    bash-4.2# exit

  7. Start a new container using the Design Console image:

    $ docker run --name oigdc -it oigdc /bin/bash

    This will take you into a bash shell for the container:

    bash-4.2#

  8. In the container run the following to export the DISPLAY:

    $ export DISPLAY=<parent_machine_hostname:1>

  9. Start the Design Console from the container:

    bash-4.2# cd idm/designconsole
bash-4.2# sh xlclient.sh

    The Design Console login should be displayed. Now follow Login to the Design Console.

Login to the Design Console

  1. Launch the Design Console and in the Oracle Identity Manager Design Console login page enter the following details:

    Enter the following details and click Login:

    • Server URL: <url>
    • User ID: xelsysadm
    • Password: <password>.

    where <url> is http://<masternode.example.com>:<NodePort>

    <NodePort> is the value passed for webPort in the `values.yaml earlier, for example: 30325

  2. If successful the Design Console will be displayed. If the VNC session disappears then the connection failed so double check the connection details and try again.