### Windows Install Command Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=files-deploymentxml Example of a Windows startCmd for installing a service package, including handling .bat scripts. ```XML ``` -------------------------------- ### Install Core RPM File Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=environment-installing-linux-management-host Example of installing the egocore RPM file. Replace 'version' and 'architecture' with your specific details. ```bash rpm -ivh egocore-version.architecture.rpm ``` -------------------------------- ### Installing RPM Files on Linux with Custom Paths Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=edition-installing-spectrum-symphony-developer-one-host Example of installing an RPM file with specified --prefix and --dbpath locations. Replace placeholders with your actual file and path names. ```bash ./rpm -ivh symde-7.3.2.x86_64.rpm --prefix /opt/symphonyde --dbpath /opt/db/ABCdb ``` -------------------------------- ### Example Output for Non-Blocking Deployment Initiation Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=cli-service-package-deployment-without-using-workload-slots Shows the initial output when starting a non-blocking service package deployment, confirming the connection and the start of the package installation. ```text Logging on to RS server with user Admin and consumer /SampleApplications/SOASamples. Successfully logged on to RS server. Starting to install package MyPackage Successfully started package install ``` -------------------------------- ### Linux Start Command Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=deployment-deploying-service-package-without-tool Specify the path to your service binary on Linux. This example shows a local binary path. ```text /share/myservice/service1 ``` -------------------------------- ### Example RPM Installation Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=environment-installing-linux-compute-host An example of installing the egocore RPM package to a specific directory and using a custom RPM database path. ```bash rpm -ivh --prefix /opt/mydir --dbpath /opt/mydir/mydb egocore-version.architecture.rpm ``` -------------------------------- ### Windows Start Command Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=deployment-deploying-service-package-without-tool Specify the path to your service binary on Windows. This example shows a local binary path. ```text C:\myservice\service1.exe ``` -------------------------------- ### Example Custom Location Installation Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=linux-installing-shared-environment Example of installing IBM Spectrum Symphony to custom paths for installation directory and database. ```bash ./sym-version_architecture.bin --prefix /gpfs/test/platform4 --dbpath /gpfs/test/platform4/db ``` -------------------------------- ### Example: Install File Package with Default Settings Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=server-deploying-file-package-from-repository Installs the specified file package using default consumer and resource group settings. The installation user is typically the user associated with the consumer. ```bash rsdeploy install mypkg.v1 ``` -------------------------------- ### Example: View Status of All File Package Installations Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=server-deploying-file-package-from-repository Retrieves the status of the file package installation on all hosts in the cluster. ```bash rsdeploy status mypkg.v1 ``` -------------------------------- ### Example Start Datetime Format Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-submit-requests-cloud-hosts This example shows the required format for specifying the start date and time for a scheduled request, including the UTC indicator 'Z'. ```json { "dateTime": "20210617T065959Z", } ``` -------------------------------- ### Example: Switch to IBM Spectrum Symphony Cluster Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=edition-setting-your-global-environment An example of switching the global environment to a standard IBM Spectrum Symphony cluster, specifying the installation directory. ```bash soamswitch sym "C:\IBM\Platform SymphonyDE\DEversion" ``` -------------------------------- ### Run IBM Spectrum Symphony Installer (Default) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=environment-installing-linux-compute-host Execute the IBM Spectrum Symphony installer binary to start the installation with default settings. Use 'sym-version_architecture.bin' for the full version or 'symeval-version_architecture.bin' for the evaluation version. ```bash sym-version_architecture.bin ``` ```bash symeval-version_architecture.bin ``` -------------------------------- ### Run parallelupgrade Tool on Linux (Specific Path Example) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=aypunc-migrating-ego-consumer-user-accounts-roles-resource-group-definitions-new-cluster An example of running the parallelupgrade tool on Linux with a specific path for the utility. Ensure the path reflects your installation directory. ```bash $EGO_TOP/4.0/linux-x86_64/bin/utils/parallelupgrade.sh -i input_directory -o output_directory ``` -------------------------------- ### Example cURL Command to Get Provider Plug-in Configuration Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-get-list-provider-plug-ins This example demonstrates how to use curl to fetch a provider plug-in configuration, including authentication and SSL certificate handling. ```shell curl --header -b /tmp/cookie --cacert /opt/ibm/spectrumcomputing/wlp/usr/shared/resources/security/cacert.pem --tlsv1.2 -X GET https://myprimaryhost.example.com:9443/platform/rest/hostfactory/providerplugins/$pluginname?hfcsrftoken=915ee7644f431e630dac68b9ab3e40bc ``` -------------------------------- ### Example: Switch to IBM Spectrum Symphony Developer Edition Cluster Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=edition-setting-your-global-environment An example of switching the global environment to the IBM Spectrum Symphony Developer Edition cluster, specifying the installation directory. ```bash soamswitch symde "C:\IBM\Platform SymphonyDE\DEversion" ``` -------------------------------- ### Example: Deploy Application Package with Credentials Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=features-application-files-deployment An example of deploying an application package using `soamdeploy`, including username and password for authentication. ```bash soamdeploy add SamplePackage -p SamplePackage.tar.gz -c /MapReduceConsumer/MapReduceversion -u Admin -x Admin ``` -------------------------------- ### Start NameNode as hdfs User Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=mapreduce-hadoop-security-configuration Example command to start the NameNode as the 'hdfs' user. ```bash $ `sudo -u hdfs hadoop namenode ` ``` -------------------------------- ### Start Cluster Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=products-scenario-3 Start the IBM Spectrum Symphony cluster after all installation and configuration steps are completed. ```bash egostartup.sh ``` -------------------------------- ### Run Sample Client and Service on Windows Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=jt-sharingdata-developing-java-client-service-share-data-among-tasks Execute the sample client application from the command line to run the client and its corresponding service on Windows. ```batch %SOAM_HOME%\version\samples\Java\SharingData\RunSharingDataClient.bat ``` -------------------------------- ### Run Sample Client and Service on Linux Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=jt-sharingdata-developing-java-client-service-share-data-among-tasks Execute the sample client application from the command line to run the client and its corresponding service on Linux. ```shell $SOAM_HOME/version/samples/Java/SharingData/RunSharingDataClient.sh ``` -------------------------------- ### Retrieve Service Packages by Package Name and Status Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-methods This GET method retrieves service packages by their specific name and optionally filters by host and deployment status. Valid statuses include NOT STARTED, ALLOCATING, ALLOCATED, WAITING, DOWNLOADING, RUNNING, INSTALLED, UNINSTALLED, ERROR, and CANCELLED. ```json [ { "name" : "name", "status" : "status" }, { "name" : "name", "status" : "status" } ] ``` -------------------------------- ### Run Sample Client (Windows) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=nct-sampleapp-your-first-spectrum-symphony-net-client-service Execute the client application on a Windows system. ```bash Client.exe ``` -------------------------------- ### Start DataNode with HADOOP_DATANODE_USER Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=mapreduce-hadoop-security-configuration Example command to start a DataNode as root, setting the HADOOP_DATANODE_USER environment variable. ```bash $ `HADOOP_DATANODE_USER=hdfs sudo -E hadoop datanode ` ``` -------------------------------- ### Navigate to Sample Directory Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=nft-sharingdata-developing-c-client-service-share-data-among-tasks Change the current directory to the location of the sample client and service files. This is a prerequisite for packaging the service. ```bash cd %SOAM_HOME%\version\samples\DotNet\CS\SharingData\output ``` -------------------------------- ### Run Sample Client (Linux) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=nct-sampleapp-your-first-spectrum-symphony-net-client-service Execute the client application on a Linux system. ```bash ./Client ``` -------------------------------- ### Install a File Package Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=server-deploying-file-package-from-repository Use this command to install a file package to multiple hosts in the cluster. It remotely starts the rsdeploy agent on each host to download and install the package. ```bash rsdeploy install package_name [-c consumer_name -r resource_group] [-r resource_group] [-t host_name] [-f] [-u user_name] [-x password] ``` -------------------------------- ### Example deployment.xml Structure Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=files-deploymentxml This snippet shows the complete structure of a deployment.xml file, including install, uninstall, packageEnv, and packageDependencies sections with OS-specific configurations. ```xml ${SOAM_DEPLOY_DIR}/bin val1 val2 ``` -------------------------------- ### Get Cluster Packages Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-methods Retrieves a list of packages for all hosts in the cluster. Use this to get an overview of installed software versions. ```json { "hostsInfo" : [ { "hostName" : "hostName", "collectTime" : "collectTime", "moduleList" : [ { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" }, { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" } ], "activeList" : [ { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" }, { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" } ], "patchList" : [ { "patchName" : "patchName", "linkto" : "linkto", "buildno" : "buildno", "version" : "version" }, { "patchName" : "patchName", "linkto" : "linkto", "buildno" : "buildno", "version" : "version" } ], "cStatus" : "cStatus" }, { "hostName" : "hostName", "collectTime" : "collectTime", "moduleList" : [ { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" }, { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" } ], "activeList" : [ { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" }, { "linkto" : "linkto", "moduleName" : "moduleName", "version" : "version" } ], "patchList" : [ { "patchName" : "patchName", "linkto" : "linkto", "buildno" : "buildno", "version" : "version" }, { "patchName" : "patchName", "linkto" : "linkto", "buildno" : "buildno", "version" : "version" } ], "cStatus" : "cStatus" } ] } ``` -------------------------------- ### Get MapReduce Application Status Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=jobs-current-version Example JSON data structure for retrieving the status of an existing MapReduce application. ```json { "name" : "name", "ssmpid" : "ssmpid", "state" : "state", "ssmhost" : "ssmhost" } ``` -------------------------------- ### Build Sample Client and Service on Windows Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=jt-sharingdata-developing-java-client-service-share-data-among-tasks Use this batch file to compile the sample client and service applications on a Windows environment. ```batch build.bat ``` -------------------------------- ### Create and Deploy Service Package Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=tutorials-sampleapp-developing-asynchronous-spectrum-symphony-python-client Execute the script to package and deploy the sample service. ```bash ./makepackage.sh ``` -------------------------------- ### Example: View Hosts with Canceled File Package Installation Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=server-deploying-file-package-from-repository Filters and displays the status of file package installations that have been canceled. ```bash rsdeploy status mypkg.v1 -s cancelled ``` -------------------------------- ### Package Sample Service on Windows Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=sampleapp-your-first-spectrum-symphony-c-service Navigate to the output directory and use gzip to compress the compiled service executable on Windows. ```bash cd %SOAM_HOME%\version\samples\CPP\SampleApp\Output\ gzip SampleServiceCPP.exe ``` -------------------------------- ### Example Hadoop 1.1.1 Configuration Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=tuning-reduce-tasks-started-based-map-tasks-finished Example configuration for Hadoop 1.1.1, setting 100 reduce slots and scheduling reducer starts when 50% of 300 maps are complete. This demonstrates setting the number of reduce tasks and the slow start completion percentage. ```bash -Dmapred.reduce.tasks=100 -Dmapred.reduce.slowstart.completed.maps=0.5 ``` -------------------------------- ### Navigate to .NET Sample Service Output Directory Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=tutorial-crosslanguage-developing-cross-language-clients-services Change to the directory containing the files for your service package. This is a prerequisite for packaging the service. ```bash cd %SOAM_HOME%\version\samples\CrossLanguage\DotNet\CS\output ``` -------------------------------- ### Starting Zookeeper Server Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=mapreduce-apache-zookeeper Command to start the Zookeeper server from its home directory. Ensure you are in the Zookeeper installation's root directory. ```bash bin/zkServer.sh start ``` -------------------------------- ### Build Sample Client and Service with Makefile on Linux Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=jt-sharingdata-developing-java-client-service-share-data-among-tasks Compile sample client and service applications using the Makefile in the specified directory on Linux systems. ```makefile make ``` -------------------------------- ### Example of specifying dbpath during uninstall (Linux) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=feature-uninstalling-individual-packages-installed-multicluster This example shows how to use the `--dbpath` option with the uninstall command if it was specified during installation. ```bash rpm -qa --dbpath /data/abc/rpmdb | grep symmcmgmt ``` -------------------------------- ### Example ego.sudoers File Configuration Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=files-egosudoers This snippet shows a sample configuration for the ego.sudoers file, defining startup paths and authorized users for EGO daemons. ```shell EGO_STARTUP_PATH=/usr/share/ego/etc EGO_STARTUP_ALTERNATIVE_PATHS=/usr/share/ego_cluster_1/ego/1.2/aix5-64/etc:/usr/share/ego_cluster_2/ego/1.2/aix5-64/etc EGO_STARTUP_USERS="user1 user10 user55" ``` -------------------------------- ### Compile Sample Application Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=nct-sampleapp-your-first-spectrum-symphony-net-client-service Use the 'dotnet publish' command to compile the solution file and generate release binaries. ```bash dotnet publish SampleAppDotNetCore.sln -c Release ``` -------------------------------- ### Example Cloud Hosts Response Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-get-cloud-hosts An example of a JSON response for the get cloud hosts command, illustrating the structure with sample host data. ```json {"page":1,"records":3,"rows":[ {"allocatedTime":69570,"hostname":"host1","lastFailureInfo":"cannot get cpu","lastFailureTime":1234,"launchTime":1507700000,"ncores":4,"ncpus":2,"nram":8192, "provName":"ibmcloud", "releaseTime":1507769570,"reqName":"symA","returnCount":5,"state":"Released","templateName":"template1"}, {"allocatedTime":1507769570,"hostname":"host2","lastFailureInfo":"cannot get mem","lastFailureTime":1234,"launchTime":4321,"ncores":4,"ncpus":2,"nram":8192, "provName":"ibmcloud", "releaseTime":1234,"reqName":"symB","returnCount":5,"state":"Provisioned","templateName":"template1"}, {"allocatedTime":3332,"hostname":"host3","lastFailureInfo":"cannot get disk","lastFailureTime":1234,"launchTime":1507700000,"ncores":4,"ncpus":2,"nram":8192, "provName":"ibmcloud", "releaseTime":0,"reqName":"symB","returnCount":5,"state":"Released","templateName":"template3"}], "total":1} ``` -------------------------------- ### Example: Set CLUSTERADMIN Environment Variable Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=cluster-installing-multicluster-feature-linux Mandatory if installing as root, this variable sets the operating user account that owns all installation files. ```shell export CLUSTERADMIN=egoadmin ``` -------------------------------- ### Resource Configuration File Example Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=files-vem-resourceconf This snippet shows a sample resource configuration file for a management host that also runs workload. It defines configurations for AGENT, SD_SDK, SD_ADMIN, and RS_DEPLOY services, specifying port numbers, hostnames, resource limits, OS type, CPU factor, and start commands. ```text # Resource configuration file # # File format: # ::::linebreak pdf:: # AGENT:8000:host1:5:5:LINUX86:1 # # SD service information # ::: SD_SDK:15051:host1:sd SD_ADMIN:15050:host1:sd # # RS service information # ::: RS_DEPLOY:15052:host1:rs ``` -------------------------------- ### Package Sample Service on Linux Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=sampleapp-your-first-spectrum-symphony-c-service Navigate to the output directory and use tar and gzip to package the compiled service executable on Linux. ```bash cd $SOAM_HOME/version/samples/CPP/SampleApp/Output/ tar -cvf SampleServiceCPP.tar SampleServiceCPP gzip SampleServiceCPP.tar ``` -------------------------------- ### Example: Deploy files from shared file system (NFS) Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=features-application-files-deployment This example demonstrates deploying a specific text file from a shared NFS directory. The compute hosts can access `/shared/test.txt` directly without copying. ```bash mrsh jar hadoop-examples-1.1.1.jar wordcount -Dpmr.ship.local.files.mode=sharedfs -files=file:///shared/test.txt hdfs://namenode1:9000/input hdfs://namenode1:9000/output ``` -------------------------------- ### Example Scheduled Requests Response Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-get-scheduled-requests An example of a JSON response for the get scheduled requests command, showing the structure with pagination and a list of scheduled requests. ```json { "page": 1, "records": 3, "rows": [ { "createTime": 1598927752, "lastSubmittedTime": 0, "nextSubmissionTime": 1601280121, "overlapAction": "close", "reqName": "admin", "requestComments": "Comments", "requestId": "SD-c812f4e9-ef8e-4a36-a765-96a7b82079d2", "requestName": "sample3", "schedule": "FREQ=DAILY;COUNT=3", "startTimeOfFirstDemand": 1601280121, "status": "Active", "templateOrUnit": "Template-VM-5", "templateOrUnitQuantity": 1 }, { "createTime": 1602729928, "lastSubmittedTime": 1602729937, "nextSubmissionTime": 0, "overlapAction": "close", "reqName": "admin", "requestComments": "Comments", "requestId": "SD-7a5f39e5-88f2-4029-a62e-9943ae55fc19", "requestName": "sample2", "schedule": "", "startTimeOfFirstDemand": 0, "status": "Closed", "templateOrUnit": "Template-VM-5", "templateOrUnitQuantity": 1 }, { "createTime": 1603161640, "lastSubmittedTime": 1603161648, "nextSubmissionTime": 0, "overlapAction": "close", "reqName": "admin", "requestComments": "Comments", "requestId": "SD-2a1f611a-4953-4f22-8d90-ed1bc0841274", "requestName": "sample1", "schedule": "", "startTimeOfFirstDemand": 0, "status": "Active", "templateOrUnit": "Template-VM-5", "templateOrUnitQuantity": 1 } ], "total": 1 } ``` -------------------------------- ### Configuring R Path with Custom Installation Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=r-configuring-spectrum-symphony Example of changing the R path in the application profile when R is installed in a custom directory like /opt/R/bin. ```xml /opt/R/bin:/bin ``` -------------------------------- ### Set Service Start Type to Manual Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=configuration-parallel-installation Modify the named.xml file to change the service start type to Manual. This is a prerequisite for certain parallel installation procedures. ```xml Manual ``` -------------------------------- ### Example Kerberos Configuration File Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=kabphrd-configuring-loader-controller-linux-kerberos-enabled-microsoft-sql-server An example of the /etc/krb5.conf file, which defines Kerberos realm, KDC, and other authentication parameters. ```ini [libdefaults] default_realm = EXAMPLE.COM dns_lookup_realm = false dns_lookup_kdc = true ticket_lifetime = 24h renew_lifetime = 7d [realms] EXAMPLE.COM = { kdc = WIN1.EXAMPLE.COM admin_server = WIN1.EXAMPLE.COM default_domain= EXAMPLE.COM } [domain_realm] .example.com = EXAMPLE.COM example.com = EXAMPLE.COM ``` -------------------------------- ### Start WEBGUI or REST Service Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=performance-what-do-i-do-if-web-server-is-not-accessible-under-heavy-load Use these commands to start the WEBGUI or REST service after modifying configuration files. ```bash egosh service start WEBGUI egosh service start REST ``` -------------------------------- ### Curl Example for HostFactory Service Configuration Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=version-get-hostfactory-service-configuration Example of how to use curl to get the HostFactory service configuration. This includes specifying the CSRF token and certificate path. ```bash curl --header -b /tmp/cookie --cacert /opt/ibm/spectrumcomputing/wlp/usr/shared/resources/security/cacert.pem --tlsv1.2 -X GET https://myprimaryhost.example.com:9443/platform/rest/hostfactory/service/configuration?hfcsrftoken=915ee7644f431e630dac68b9ab3e40bc ``` -------------------------------- ### Sample deployment.xml for Windows and Linux Source: https://www.ibm.com/docs/en/spectrum-symphony/7.3.2?topic=deployment-configuration-file This XML file defines deployment configurations for both Windows and Linux environments, specifying installation commands, environment variables, and success codes. ```xml                   c:\temp                   /tmp                             c:\temp                   /tmp           ```