sag-spm-boot-ssh

Bootstrapping Platform Manager on remote machines

With this template you can install Platform Manager (SPM) on remote UNIX or Windows hosts using the SSH protocol.

Requirements

Supported Software AG releases when bootstrapping on UNIX

• Command Central 10.3 or higher
• Platform Manager 9.8 or higher

Supported Software AG releases when bootstrapping on Windows

• Command Central 10.5 or higher
• Platform Manager 10.3 or higher

NOTE: For older versions of Command Central and Platform Manager you can use the sag-spm-boot-winrm template which uses the native Windows remoting protocol.

System requirements for the target UNIX machines

• SSH daemon with enabled SHA1 support
• A user account with remote SSH login privileges and write access to the target installation directory, for example sagadmin
• Credentials for the remote connection user account, e.g. sagadmin, are configured. For more information, see sag-cc-creds-dev.

System requirements for the target Windows machines

• Use Cygwin to Configure OpenSSH. For information about how to install Cygwin, follow the instructions located in the TECHcommunity article: Using Cygwin to Configure OpenSSH When Installing Platform Manager on a Remote Windows Machine

System requirements for the Command Central machine

• All supported UNIX or Windows operating systems
• Must have Command Central bootstrap installer for the target UNIX platform (*.sh file) or for the target Windows platform (*.bat or *.exe) saved in the CC_HOME\profiles\CCE\data\installers folder. Verify by running:

sagcc list provisioning bootstrap installers

Running as a standalone Composite Template

• Bootstraps Platform Manager 10.3 into the /home/vmtest/sag102 installation directory, listening on port 8292 on the bgcctbp11 and bgcctbp12 Linux hosts, where the remote SSH connection is authenticated with the pre-configured VMTEST username/password credentials:

sagcc exec templates composite apply sag-spm-boot-ssh nodes=[bgcctbp11,bgcctbp12] \
  cc.installer=cc-def-10.3-fix1-lnxamd64.sh \
  install.dir=/home/vmtest/sag102 \
  spm.port=8292 \
  os.credentials.key=VMTEST \
  --sync-job --wait 360

• Authenticates the SSH connection using the pre-configured SSH-PRIVATE-KEY credentials pointing to the ~/.ssh/id_rsa private key on the Command Central host for the user account that runs Command Central, for example sagadmin:

sagcc exec templates composite apply sag-spm-boot-ssh nodes=[bgcctbp11,bgcctbp12] \
  cc.installer=cc-def-10.3-fix1-lnxamd64.sh \
  install.dir=/home/vmtest/sag103 \
  spm.port=8392 \
  os.credentials.key=SSH-PRIVATE-KEY \
  --sync-job --wait 360

• Bootstraps SPM 10.3 into the C:\home\vmtest\sag103 installation directory, listening on port 8392 on the ccwin01 Windows host, where the remote SSH connection is authenticated with the pre-configured VMTEST username/password credentials:

sagcc exec templates composite apply sag-spm-boot-ssh nodes=[bgcctbp11,bgcctbp12] \
  cc.installer=cc-def-10.3-fix8-w64.exe \
  install.dir=C:\home\vmtest\sag103 \
  spm.port=8392 \
  os.credentials.key=VMTEST \
  --sync-job --wait 360

Adding infrastructure layer to a stack using CLI

• Creates a new stack for version 10.1 with alias Dev01 and provision the LinuxInfra infrastructure layer on host1 and host2, where the SSH connection from Command Central to host1 and host2 is authenticated through the sagadmin user account private key:

sagcc create stacks alias=Dev01 release=10.1
sagcc create stacks Dev01 layers alias=LinuxInfra layerType=INFRA-REMOTE nodes=[host1,host2] \
  cc.installer=cc-def-10.1-fix8-lnxadm64.sh \
  install.dir=/opt/softwareag \
  os.credentials.key=SSH-PRIVATE-KEY \
  --sync-job --wait 360

• Creates a new stack for version 10.3 with alias Dev03 and provision the Infra infrastructure layer on host1 and host2, where the SSH connection from Command Central to host1 and host2 is authenticated through the sagadmin user account private key:

sagcc create stacks alias=Dev03 release=10.3
sagcc create stacks Dev03 layers alias=WindowsInfra layerType=INFRA-REMOTE nodes=[host1,host2] \
  cc.installer=cc-def-10.3-fix8-w64.exe \
  install.dir=C:\home\vmtest\sag103 \
  os.credentials.key=SSH-PRIVATE-KEY \
  --sync-job --wait 360

For information about the INFRA-REMOTE layer type definition, see sag-cc-layer-defs.

Creating a new stack containing a UNIX infrastructure layer using the Command Central web user interface

• Open the Stacks UI
• Add a new stack
• Add layer > New nodes
  • Select INFRA-REMOTE layer definition
  • Choose the operating system, and a corresponding bootstrap installer
  • Provide required parameters, such as
    • os.credentials.key - SSH credentials
    • nodes - one or more host names
    • install.dir - remote installation directory
  • Finish the wizard
• Wait until the provisioning jobs complete. Monitor the jobs from the Jobs view.

Local testing

You can test the template against localhost on a Linux or Mac OS machine if it has SSHD running. For example:

sagcc exec templates composite apply sag-spm-boot-ssh nodes=`hostname` \
  cc.installer=cc-def-10.3-fix1-osx.sh \
  install.dir=$HOME/test4 \
  spm.port=8492 \
  os.credentials.key=SSH-PRIVATE-KEY \
  --sync-job --wait 600