IBM Pattern Lab quick start guide for script package deployment in PureApplication System: Getting started with the Windows OS Preparation Script Package V1

This guide helps you get started with a typical run of the Windows® OS Preparation V1 Script Package and defines the requirements of this automation in IBM® PureApplication™ System.

Octavian G. Teodorescu (octavian.teodorescu@ro.ibm.com), IBM Pattern Lab Team Lead, IBM

Photo of Octavian TeodorescuOctavian Teodorescu is a member of Rapid Deployment Services Team, which delivers automation services across the globe. In this automation business, he is technically responsible for delivering automated content that is consumed in IBM PureApplication System.



November 2013 (First published 24 June 2013)

Also available in Chinese Japanese

Introduction

The IBM Pattern Lab uses an asset-based approach to create reusable and customizable components that collectively make an automation package for a given software product or solution deployment. Rapid time-to-value using automated middleware assets decreases the time and costs associated with solution deployment. In addition, the quality of the product and user satisfaction increases.


Step 1: Introducing the Windows OS Preparation Script Package capabilities

This script package will prepare the Windows operating system parts for deployment of other script packages that require specific operating system configurations and which rely on an operating system restart.

The underlying operating system part, which this script package has been tested on, is Windows Server 2008 R2 64-bit.

For Version 1 of the Windows OS Preparation Script Package, you need to join a Windows operating system to an Active Directory Domain Server, wait 2 minutes for all the actions to take place, including the reboot of the operating system.


Step 2: Identifying the script package parameters

All the parameters found in the following two tables are exposed through the script package parameters in the IBM Workload Deployer Interface. Table 1 identifies these operating system preparation parameters.

Table 1. OS preparation parameters
Parameter nameParameter descriptionExample
adIpAddress The IP address of the Active Directory Server you want the operating system to be joined in. 9.9.9.1
domainUser The domain user that has the right to create computer accounts on the domain controller. The format should be: [domain]\[username] ibm.com\ADUsr
domainUserPwd Password for the domain user given as a value of the domainUser parameter. Zaq12wsx

Step 3: Acquiring the script package prerequisites

The following list presents the prerequisites before running this script package:

  • An Active Directory domain must be available.
  • Make sure the computer name length does not exceed a maximum number of characters allowed (which is 15), or does not contain characters that are not allowed. For more information, see Naming conventions in Active Directory.
  • In addition to using a computer name that adheres to Microsoft® conventions, the computer name must be unique. If the computer name already exists in the Active Directory, the script package will fail.
  • After joining the domain, the computer is rebooted after 2 minutes due to a delay some servers experience when they are added to a domain. Wait while the computer is rebooted before running any other script packages.

Step 4: Deploying the script package in a virtual system pattern

This section describes the steps to create a virtual system pattern and deploy it in your PureApplication System environment. Additionally, you will find details on how to check the status of your deployment.

Preparing a virtual system pattern for deployment

The script package comes in a form of a zip archive using the following naming convention:

RDS_{ProductName}_{ProductVersion}_{OneWordDescriptionOfPurpose}.zip

In some cases, when the product (that the script package installs and configures) is installed on multiple platforms, the platform is specified in the name to avoid confusion.

In PureApplication System terminology, this is called a script package. This script package has to be part of a virtual system pattern, which in the end, is deployed and managed under the form of a virtual system instance.

To create and deploy the script package, follow these steps:

  1. Login to your environment's IBM Workload Deployer interface.
  2. To add the script package you have received, click (on the upper bar) on Catalog > Script Packages and press the green plus icon in the menu bar. Enter the name for the script package to be created and press OK, as shown in Figure 1 and Figure 2.
    Figure 1. Open the script packages section
    Open the script packages section
    Figure 2. Name the script package
    Name the script package
  3. Now import the script package archive you have been provided by clicking on the grayed out Browse from the right side of the Script package file field. Select the archive from your local file system and then click the Upload button, as shown in Figure 3.
    Figure 3. Import a script package archive
    Import a script package archive
  4. Prior to using the script package, you need to accept the license. To do this, follow the highlighted areas shown in Figures 4 through 7.
    Figure 4. Bring up the license window
    Bring up the license window
    Figure 5. List the license contents
    List the license contents
    Figure 6. Accept the license
    Accept the license
    Figure 7. Finish the license acceptance process
    Finish the license acceptance process
  5. Immediately after you have imported your script package (while still in the Script Package view), you have the option to select when this script package will be executed (see Figure 8). The Execute field needs to be set to one of the two values shown in Table 2.
Table 2. Script Package Execution settings
ValueWhen to select
at virtual system creation Select this when your OS Part (operating system image) on which this script package will be run has satisfied all the prerequisites described in Step 2: Identifying the script package parameters and Step 3: Acquiring the script package prerequisites in this article, as well as any external dependencies you might have in your desired topologies (for example, an external database).
when I initiate it Select this when the prerequisites are not met or external dependencies require an action first.
  1. If you have selected when I initiate it as shown in Figure 8 after you have built your virtual system pattern and you click Deploy (see Figure 13), this will create your virtual host and install the operating system. However, hold off on executing the script package until this is manually invoked. Figure 8 shows the script package option discussed in this section.
    Figure 8. Execute options for a script package
    Execute options for a script package
  2. Against each of the script packages, you will see the Execute now button, which you will have to click and follow the on screen instructions to execute your script package. Figure 15 outlines the script package section of a virtual system instance, where the Execute now button is found (in the referenced figure, the script package has not executed yet).
  3. To create a virtual system pattern, click (on the upper bar) on Patterns > Virtual Systems. Then click on the green plus icon in the menu bar, provide a name and a description for the virtual system pattern, and press OK, as shown in Figure 9 and Figure 10.
    Figure 9. Select a virtual system pattern
    Select a virtual system pattern
    Figure 10. Create a virtual system pattern
    Create a virtual system pattern
  4. To compose or orchestrate the newly created virtual system pattern, click on the Edit button on the upper right side of the bar, as shown in Figure 11.
    Figure 11. Edit mode of your virtual system pattern
    Edit mode of your virtual system pattern
  5. In the new screen, drag and drop the parts from the palette on the left to the editing area. You will need to add a Windows Server 2008 R2 64-bit image and the script package created in the previous steps. When finished, click on Done Editing as shown in Figure 12.
    Figure 12. Edit your virtual system pattern
    Edit your virtual system pattern

    You have created a virtual system pattern, which you can deploy as many times as you need in your environment.

  6. Next, deploy the new virtual system pattern. In your IBM Workload Deployer console, go to Patterns > Virtual Systems. Click on the previously created system pattern. On the right side of the upper bar, click on the Deploy button as shown in Figure 13.
    Figure 13. Deploy your virtual system pattern
    Deploy your virtual system pattern
  7. After clicking the Deploy button, the following information is requested:
    • Virtual System Name: This is the name of the virtual system pattern instance.
    • Environment: Your IBM Workload Deployer administrator should provide the necessary information.
    • OS Part parameters: This is where you complete the values for the required operating system level parameters.
    • Script Package parameters (found under the OS Part sub page): You will find details in this article.

    Note that the only mandatory fields are those starred (*) and the Instance Name.

After completing the field values as they are documented in Step 2: Identifying the script package parameters, click on the OK button.

Your virtual system pattern is now deploying. The deployment will finish when either the first, or both of the following actions are completed:

  • The operating system of the deployed virtual machine has been installed and the virtual machine is now started.
  • The script packages within the virtual system pattern you are deploying have been successfully executed.

The execution of the script packages in the later action above is conditioned by the value set for the "Execute Now" option of each of the script packages added to the specific virtual system pattern, which is described earlier in this guide.


Step 5: Checking the status of your deployment

  1. To check the status of your virtual system pattern deployment, click on Instances > Virtual System as shown in Figure 14.
    Figure 14. Check the status of the virtual system pattern deployment
    Check the status of the virtual system pattern deployment
  2. In the newly opened window you will find, on the left frame, the virtual system pattern instance you have created. Click on it. If there are too many instances, you can use the search filter (which you can find at the top of the left frame) and type in some characters that are part of the virtual system pattern instance name you had created earlier.
  3. At this point, in the frame on the right side of the page, there are details about your deployment. However, at this stage, the following two are the most important:
    • Current status: This shows what the current deployment is doing. For example, starting virtual image, deploying pattern, registering virtual image, and so on.
    • Virtual machines: This provides information about the current status of the virtual machine, its hardware and network details, as well as status of the script packages that have been deployed, currently in deployment process, or that can be deployed. The network details provide the virtual machine's IP address and hostname. Figure 16 provides an example and includes the areas of most interest in the deployment of a script package.

      For the script package run, Figure 16 describes a situation where the script packages have been executed at virtual system deployment, while Figure 15 shows an example of a Script Package set to execute only "when I initiate it". That fact is confirmed by the (none) attribute, which signifies the absence of logs for the specific script package (since it has not been executed yet).

    Figure 15. Script package status with "when I initiate it" execute option
    Information about the IP and script package status
    Figure 16. Information about the IP and script package status
    Information about the IP and script package status
  4. To connect to the deployed virtual machine, a connection can be made to the IP outlined in Figure 16, using either the Remote Desktop for Windows or the ssh client for Linux/Unix.
  5. In Figure 16, the log files are displayed against each script. The remote_std_out.log outlines what the script package has done during deployment and contains both errors and details of a normal script package run. In a successful deployment, you see the following lines at the end:
    SPiN ended: successfully :-)
    ===========================End of SPIN LOG =========================
    INFO:Java(TM) 6 Update 34 (64-bit) is installed
    INFO:Uninstalling: Java(TM) 6 Update 34 (64-bit) Version: 6.0.340
    INFO:Successfull uninstall

Checking the remote_std_out.log file at the end of each deployment will provide the latest level of assurance for a successful execution.


Conclusion

This article described how to deploy the Windows OS Preparation automation package and to automatically add a provisioned Windows host in the IBM PureApplication System environment to an existing Microsoft Active Directory™ domain server. This eliminated the need to manually access and modify the provisioned host.

Resources

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Cloud computing on developerWorks


  • Bluemix Developers Community

    Get samples, articles, product docs, and community resources to help build, deploy, and manage your cloud apps.

  • Cloud digest

    Complete cloud software, infrastructure, and platform knowledge.

  • DevOps Services

    Software development in the cloud. Register today to create a project.

  • Try SoftLayer Cloud

    Deploy public cloud instances in as few as 5 minutes. Try the SoftLayer public cloud instance for one month.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Cloud computing
ArticleID=934717
ArticleTitle=IBM Pattern Lab quick start guide for script package deployment in PureApplication System: Getting started with the Windows OS Preparation Script Package V1
publish-date=11242013