ZZ00172: DOCUMENT THE VIRTUAL SYSTEM NAMING AND THE VIRTUAL MACHINE NAMING ALGORITHM IN CONTEXT OF THE OFFERED DEPLOY SERVICES.

IBM SmartCloud Orchestrator Fix Pack 1 (2.3.0.1) for 2.3

APAR status

• Closed as documentation error.

Error description

• Out of the box provided self-service offerings will throw an
  error when trying to deploy a pattern using the "Deploy Virtual
  System Instance Offering" if the deployment has a generated
  name  longer than 80 characters.
  
  VMware cannot clone the template because the name is too long.
  Error message is:
  
  Cannot deploy template: 'abc.vm.SC-112-118-10-110-OS
  Node-SingleVM-10f1e260-80c9-4869-81e1-c1ff0c-ffc9a0-21' is
  invalid or exceeds the maximum number of characters permitted.
  
  Error message displayed in SCO UI is as follows:
  
    CTJCO0003E: Business process instance 3 of process Deploy
  Single Pattern did not complete successfully. Status: Failed.
  Reason: CTJCA1405: Runtime error in script ("null"
  -1:-1).Internal Script error:
  com.lombardisoftware.server.core.NullJavaScriptException:
  Javascript should be set in "Deploy Single Pattern" item
  "Raise Error" location "Pre-Assignments".
  

Local fix

• A shorter pattern name should be used so that the generated VM
  name fits within the 80 character limit.  The standard name is
  skc.<hostname>-<Pattern-name>-<random-uuid>
  You can change this default behavior from Process Designer.
  
  Max len - UUID - vm prefix IP v4 - running counter = available
  80 - 37 - 27 - 4 (-999) = 12 chars for pattern naming
  

Problem summary

• ****************************************************************
  * USERS AFFECTED:
  All users of SmartCloud Orchestrator 2.3 using VMware regions
  
  ****************************************************************
  * PROBLEM DESCRIPTION:
  "Deploy Virtual System Instance" offering using the unchanged
  virtual instance name might fail with - virtual machine name too
  long.
  Missing detailed constrains description.
  ****************************************************************
  * RECOMMENDATION:
  The environment profile allows to configure naming rules for the
  virtual machine name which is different to the internal instance
  name and results in a much shorter and more customizable virtual
  machine name. Refer to SCO 2.3 infocenter documentation, chapter
  "Creating an environment profile", paragraph "Virtual machine
  name format"
  

Problem conclusion

• During processing the human service where all configuration data
   are collected a virtual instance name gets generated using the
  selected pattern name and a generated UUID. The UUID make sure
  that the virtual instance name is unique. This is required for
  internal processing reason, otherwise it might result in an
  error "The name or identifier you entered is already in use".
  Since a UUID is a long string the resulting virtual machine name
   created with the IP address prefix might exceed the maximum
  virtual machine name length possible for VMware. VMware allows a
   virtual machine name up to 80 character.
  
  There are two possible solutions for this problem:
  1) The name might be edited while executing the deploy service,
  where you take the risk of virtual instance name duplication
  2) The environment profile allows to configure naming rules for
  the virtual machine name which is different to the internal
  instance name. This results in a much shorter and more
  customizable virtual machine name. Refer to SCO 2.3 infocenter
  documentation, chapter "Creating an environment profile",
  paragraph "Virtual machine name format".
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels