A Sample Software Requirements Specification (SRS) developed according to (IEEE 830-1993)

Table of Contents

2

Document Revision History

3

1

Introduction

4

1 1

Purpose

4

1 2

Document Conventions

4

1 3

Intended Audience and Reading Suggestions

4

1 4

Product Scope

5

1 5

References

5

2

Overall Description

5

2 1

Product Perspective

5

2 2

Product Functions

6

2 3

User Classes and Characteristics

8

2 4

Operating Environment

9

2 5

Design and Implementation Constraints

10

2 6

User Documentation

10

2 7

Assumptions and Dependencies

10

3

External Interface Requirements

11

3 1

User Interfaces

11

3 2

Hardware Interfaces

11

3 3

Software Interfaces

11

3 4

Communications Interfaces

11

4 System Features

12

4 1

User interface CPP Website behavior

12

4 2

Administrator Approval Process

13

4 3

Session Management Platform Integration

13

4 4

Application server interaction with VMware Host System

14

5

Other Nonfunctional Requirements

15

5 1

Performance Requirements

15

5 2

Safety Requirements

15

5 3

Security Requirements

16

5 4

Software Quality Attributes

16

5 5

Business Rules

17

6 Other Requirements

     </td>          <td width="65">           <p><b>17</b></p>         </td>       </tr>        <tr>         <td width="658">           <p><b>Appendix A: Glossary </b></p>         </td>          <td width="65">           <p><b>17</b></p>         </td>       </tr>        <tr>         <td width="658">           <p><b>Appendix B: Analysis Models </b></p>         </td>          <td width="65">           <p><b>17</b></p>         </td>       </tr>        <tr>         <td width="658">           <p><b>Appendix C: To Be Determined List </b></p>         </td>          <td width="65">           <p><b>17</b></p>         </td>       </tr>     </tbody></table> 

=============================================================

Table Of Contents

Document Revision History:

Note:the Copy Number space on the cover of each distributed copy. If the document is not controlled, you can delete this table and the Copy Number label from the cover page.

1. Introduction

1.1 Purpose

This document explains specifications for implementing a new feature for VM based Citrix Session setups. The new feature is called “ability to clone and change the VM Citrix Sessions”. This feature is to let customers self update the base VMs used in VM based Citrix Sessions.

1.2 Document Conventions

This document is organized based on the IEEE Standard for Software Requirements Specification (SRS) (IEEE 830-1993) and contains the necessary requirement and some aspects of the analysis of the requirements.

Below are the notations used for representing various sections in the document

1. Main Sections – Represented in this format

2. Main Sub-Sections – Represented in this format

3. Sub-Section Topics – Represented in this format

1.3 Intended Audience and Reading Suggestions

This document is intended for the anyone in who understands the VM based Citrix Sessions and working on automating the tasks that are currently manual.

Product Management: The management who wants to get an idea of what all the components involved in developing this new feature so as to plan resources and development activities.

Developer: The developer who is responsible in authoring code to develop and integrate this feature with existing Session Management platform, must firstly consult this document to understand the involved technical requirements so as to find the most suitable technologies for development.

Infrastructure Administrator: The Infrastructure Administrator who is responsible for provision of infrastructure to host this feature in existing setup so as to understand what infrastructure requirements are.

1.4 Product Scope

This new feature addition to VM based Citrix Sessions, offers flexibility to customers to make changes to their base VM images at any time without any delays. This also reduces the engineering staff efforts in implementing the changes, which are manual otherwise.

1.5 References

Please refer to below documentation that explains the business requirement:

1. Overall Description

2.1 Product Perspective

This new feature is an addition to the existing Session Management platform and its infrastructure. This feature reduces the manual efforts from in making changes to the base VM image whenever customer has to push a newer version of the software or make any changes to the existing setup.

Thus new feature facilitates a workflow in which customers will be able to create VMs with required changes and can approve the requested changes for deployment in live.

2.2 Product Functions

The primary use case: customers would have a web based access to the base VM images with options to

1. list available base VM images,

A technical feasibility: test has been performed on VMware technology that uses for VM based Citrix Sessions. It’s found to be feasible to support use case requirements by cloning a VM from base image and saving the changes back to the base image via VMware PowerShell Automation APIs. The background operations mainly include

1. creating a new VM as a clone of existing VM

Front-end and back-end workflow integration services: This includes user facing UI and approval for changes deployment to live

UI: customer facing access is going to be SP (Support Portal) whose interface would re-used for this new feature provision to the customers.

As existing SP runs on IIS web site, the new feature pages and code will also be deployed to the same web site.

The respective IIS pages would provide below options:

1. list of customer specific base VM images

§ Launch RDP to the server

§ Convert to base Image

§ Discard the active VM

1. create a new Citrix Session setup

Approval: An approval process by staff is required to

1. validate the requests from customers and

A designated staff would receive a request for approval via email whenever user chooses to

1. save an Active VM as base Image – staff would verify the required resources are in-place and ensure not too many base images are created

Session Management Platform Integration: When user selects option to “create a new Citrix Session setup” a new distributed app will be created with all settings same as its existing setup except that it uses new base image with a new Dev URL. The designated staff would verify the auto created distributed app Session Management setup and then approves the request.

When user selects option to “make new Citrix Session setup live”, will ensure the proper URL setup for both customer using and Vanity URLs and then will also retire the previously existing setup.

High Level Technical Architecture Diagram of New Feature Integration

2.3 User Classes and Characteristics

VM Citrix Session Customer (ISV):

Each ISV as a customer will have a single login to SP. They can login to SP from anywhere via SP website. Upon login they will be presented with a section that will take them to the VMs Citrix Sessions. Customer will be able to operate with right click context menu to perform VM based operations. Once customer is through with test quick from new VM Citrix Session session, a request for live approval can be placed.

VM Citrix Sessions administrator:

A designated team of staff will form a VM Citrix Sessions administrators list. There will be an administrator account per ISV for staff to manage the customer requests. The group will have an email list to which all of the customers’ requests will be sent. Upon a user request, admins can login as respective ISV admin account, do the approvals as appropriate.

2.4 Operating Environment

The new feature will be available via SP web site. All of the operations that either an end user/admin performs will be translated into respective VMware PowerCLI API commands via web page code. The commands will be sent to Application server which would have VMware PowerCLI software installed and thus executes these commands.

The PowerCLI commands in turn connects to VMware vCenter server, executes the commands and returns the results.

The typical environment for this whole functionality includes

1. VM HOST: is a Physical server that runs VMware ESXi Hypervisor

2.5 Design and Implementation Constraints

The new feature primarily relies on clone functionality of the VMware software. For support of VM clone operation one needs to run a vCenter server of version respective to their VM host ESXi.

The feasibility evaluation is performed on latest version of ESXi and vCenter software that is v5.1.0, if you have ESXi hosts running older version verify that all of feature needed PowerCLI commands are working.

2.6 User Documentation

Here are the official links to the VMware Technologies and Automation resources:

VMware ® vCenter Server

VMware vSphere PowerCLI Overview

Product Support for VMware vSphere Hypervisor (ESXi)

2.7 Assumptions and Dependencies

It is assumed that SP website will be acting as user interface to present the new Feature and its options. If not, a similar web site with basic functionality to authenticate user against AD and interacts with Session Management Management & Application server to send commands, receive command results and present to user, has to be developed.

For creating cloned VMs, user would provide a name for the VM and the same name would be used as the guest Windows system name. It’s assumed that the cloned VMs would be running in the same network as of other active VMs running the TD sessions. In such a network there would be a DHCP/auto IP-address assignment configuration in place.

It’s also assumed that communication interfaces required for user facing SP website would pre-setup and there doesn’t require any specific changes for this new feature.

It’s also assumed that there would be an email communication channel that can be used for notifications to Admin
accordingly to user actions.

1. External Interface Requirements

3.1 User Interfaces

· SP Login page: used by external user and/or internal admins

· For VM based Citrix Session customers, a separate page to manage their VM images would be provided

· For the customer login, there will be list of context menu options that he can perform against list of VMs displayed

· For specific approval needed operations, an email notification would be sent to VMs admin list

· For Admin user login, there would be list of VMs along with customer requests that are pending for approval. Admin user can approve or decline the request.

· Once a dependent operation is approved, user can move on to the next operations

· In case of any failure/error messages, customer would log a request with via same SP portal under his current logon session

3.2 Hardware Interfaces

The new feature is based on VMs in which most of the hardware resource as well are found and configured at the VM Host level.

3.3 Software Interfaces

The new feature functionality connects to vCenter server via VMware PowerCLI API installed on application servers. PowerCLI API supports triggering command remotely. To let uses to work on cloned VMs, a RDP session to the VM will be used.

3.4 Communications Interfaces

SP is a web solution which would require HTTP access through firewall to the respective web server for external users to launch the website. The backend operations would need TCP/IP communication from Application servers to the vCenter server. Solution needs RDP access from Application servers to the Windows systems running in the VMs.

1. System Features

4.1 User interface CPP Website behavior

Login to SP

· ISV user login from external network

· ISV Admin login from internal network

A2

User verification: authenticate the logon credentials provided against Active Directory to validate the user

A2.1

If authentication fails, report login failed.

A3

For successful login, show below options:

A3.1

For ISV user login

· find the list of VM based applications for the ISV from Session Management console DB and present a page the list of VM applications.

· for selected VM based application, get the list of application VM base images and Active VMs from DB and present the list

· for selected VM base image, present following right click context menu options

A3.1.1

Right click context menu options on a selected VM base image

· Convert to Active VM

A3.1.2

Right click context menu options on a selected active VM

· Login to the server

· Create new Citrix Session

· Convert to Base Image

· Delete

A3.2

For ISV Admin login

· find the list of pending requests for approval and show them against the application in the list

· for selected request, provide options to Approve or Disapprove

A3.2.1

If there are no pending requests, default the view to that of ISV user login