Configuration Examples

Edit online

The following examples are configuration YAML files for the server, proxy, and seed containers.

Note: Details on the configuration entries that are supported by the containers can be found in the YAML Specification.

Verify Directory Server

The following YAML shows the minimum configuration to start a Verify Directory Server container.
general: 
  license:
    key:    "insert-license-key-here"
    accept: standard
  admin: 
    pwd: passw0rd1

server:
  suffixes:
  - dn: dc=ibm.com
The following example is a more typical and complete YAML configuration.
general: 
  ports:
    ldap:  0
    ldaps: 9636

  id: "test-server"

  license:
    key:    "insert-license-key-here"
    accept: standard

  admin: 
    dn: cn=root
    pwd: passw0rd1

  audit:
    enabled: true

server:
  suffixes:
  - dn: dc=ibm.com

  change-log:
    enabled:     true
    max-days:    56
    max-entries: 99999
    max-hours:   12

keyfile:
  keys:
  - label: "server-key"
    key:   "@/var/isvd/config/server.key"

Verify Directory Proxy

The following YAML shows the minimum configuration to start a Verify Directory Proxy container.
general: 
  license:
    key:    "insert-license-key-here"
    accept: standard

  admin: 
    pwd: passw0rd1

proxy:
  suffixes:
  - name:           "dc=ibm.com"
    base:           "dc=ibm.com"
    servers:
    - name: "server_a"

  server-groups:
  - name: "group_a"
    servers:
    - name:       "server_a"
      id:         "server_a"
      target:      "ldaps://server_a.ibm.com:636"
      user:
        dn:       "cn=root"
        password: "ldap__secret"
The following example is a more typical and complete YAML configuration.
general: 
  id: "test-proxy"

  license:
    key:    "insert-license-key-here"
    accept: standard

  ports:
    ldap:  0
    ldaps: 9636

  admin: 
    pwd: passw0rd1

  audit:
    enabled: true

proxy:
  suffixes:
  - name:           "dc=ibm.com"
    num-partitions: 1
    base:           "dc=ibm.com"
    servers:
      - name: "server_a"
        role: "primarywrite"
        index: 1

  server-groups:
  - name: "group_a"
    servers:
    - name:       "server_a"
      id:         "server_a"
      target:      "ldaps://server_a.ibm.com:636"
      bind-method: "Simple"
      user:
        dn:       "cn=root"
        password: "ldap__secret"

keyfile:
  keys:
  - label: 'proxy-key'
    key: "@/var/isvd/config/proxy.key"

Verify Directory Seed

The following YAML shows a typical configuration when you are migrating the data from an existing instance into a containerized environment. 
general: 
  license:
    key:    "insert-license-key-here"
    accept: standard

  key-stash: "insert-key-stash-here"
  admin: 
    pwd: passw0rd1

seed:
  migrate:
    suffixes:
    - "o=sample"
The following example shows a typical configuration when the seed container is used to copy the data of an existing server replica. 
general: 
  license:
    key:    "insert-license-key-here"
    accept: standard

Verify Directory Virtual Directory

The following YAML shows the minimum configuration to start a Verify Directory Virtual Directory container.
general: 
  license:
    key:    "insert-standard-license-key-here"
    accept: standard

  admin: 
    pwd: passw0rd1
    users:
    - dn: o=sample
      pwd: passw0rd1
      role: Administrator

virtual-dir:
  clusters:
  - suffix: o=sample
    endpoint-suffix: o=sample
    servers:
    - target: ldap://directory.ibm.com:9389
      role: Any
      user:
        dn: cn=root
        password: passw0rd1
    attr-mapping:
    - attr: cn
      endpoint-attr: cn
      class: Normal
The following example is a more typical and complete YAML configuration.
general: 
  id: "test-virtualdir"

  license:
    key:    "insert-standard-license-key-here"
    accept: standard

  ports:
    ldaps: 9636

  admin: 
    pwd: passw0rd1
    users:
    - dn: o=sample
      pwd: passw0rd1
      role: Administrator

  ssl:
    cert-label: my-server

  audit:
    enabled: true

virtual-dir:
  view:
    suffix: o=view
    attr: cn
  clusters:
  - suffix: o=sample
    endpoint-suffix: o=sample
    servers:
    - target: ldaps://directory.ibm.com:9636
      role: Any
      user:
        dn: cn=root
        password: passw0rd1
    attr-mapping:
    - attr: cn
      endpoint-attr: cn
      class: Normal
    - attr: sn
      endpoint-attr: sn
      class: Normal
    - attr: ou
      endpoint-attr: ou
      class: Normal
    - attr: description
      endpoint-attr: description
      class: Normal
    - attr: member
      endpoint-attr: member
      class: Normal

keyfile:
  keys:
  - label: my-server
    key: "@/var/isvd/config/liberty-server.pem"
  trusted-certificates:
    - "@/var/isvd/config/ca.crt"