On-Premises Administration Guide
Your CA Agile Central subscription for Agile Software Lifecycle Management can be deployed on your company's own premises. In this case, CA Agile Central is installed on your own server within your company’s IT infrastructure.
CA Agile Central uses VMware® software to create a self-contained environment that includes its own virtual hardware, operating system, application servers, application software, and database management system. Once installed, CA Agile Central is accessible through your local intranet or virtual private network (VPN).
On-Premises base requirements:
- VMWare platform with 64-bit support, including ESX 3.5.x and ESX 4.0 (vSphere)
- 64-bit capable processors with hardware virtualization (Intel® VT-d, AMD AMD-V)
- See the complete checklist for 64-bit guest support
- At least 6.0 GB of RAM for CA Agile Central’s use (or at least 6 GB RAM for a server dedicated to CA Agile Central)
- CA Agile Central recommends 8–12 GB of RAM for improved performance for subscriptions that may serve a higher volume of requests
- 150 GB of disk space for CA Agile Central’s VMware image
- A DVD-ROM drive or network access to a server with a DVD-ROM drive (if you received the VMware image on a DVD disk)
- Two CPUs
Access help and WSAPI
To access local help, go to https://<ip-address>/help.
For WSAPI, go to https://<ip-address>/slm/doc/webservice.
CA Agile Central is committed to making our software easily accessible. You can access the CA Agile Central Application or Control Panel wherever you have a connection to your On-Premises server through a PC, Linux, or Macintosh computer.
However, it is not possible nor practical for us to support every operating system and browser combination that is available. To take advantage of the newest CA Agile Central features, we recommend that you use one of the following fully supported browsers:
- Internet Explorer*
We support the two latest versions of each of these browsers. We do not recommend using development, test, or beta versions of these web browsers. Versions that are not publicly released may not work properly with the CA Agile Central application. We recommend using the latest production-level versions of these browsers. In particular, we strongly suggest using Chrome or Firefox.
* Internet Explorer – Currently, we support Internet Explorer 9, 10, and 11. CA Agile Central no longer supports Internet Explorer 6, 7, or 8.
The CA Agile Central software installation file contains a virtual machine image that includes all the necessary components to run the CA Agile Central application.
The CA Agile Central On-Premises Administration Guide includes the following topics:
- Install CA Agile Central
- CA Agile Central Control Panel
- Enable the CA Agile Central On-Premises LDAP module
- CA Agile Central Monitoring Service
- Upgrade CA Agile Central
- Troubleshooting tips
- CA Agile Central On-Premises LDAP Module worksheet
CA Agile Central On-Premises Blog
Be sure to sign up for the CA Agile Central On-Premises Blog for information on upcoming releases, current news, and discussions on the direction of the CA Agile Central On-Premises solution.
Contact Technical Support
If you encounter any issues or require additional service, email CA Agile Central Support at firstname.lastname@example.org.
Install CA Agile Central
These instructions will guide you through the process of installing the CA Agile Central virtual machine and the CA Agile Central On-Premises application:
- Ensure that VMware Server software is properly installed on your machine. Download the free version of the VMware ESX server.
- Extract the CA Agile Central software to a location that can be accessed from the VMware Client Console:
- Insert the CA Agile Central software DVD in the DVD-ROM drive.
- Copy the CA Agile Central On-Premises [Version].zip from the DVD to a directory on your server.
- Unzip the CA Agile Central On-Premises [Version].zip.
- Deploy the CA Agile Central Virtual Machine.
- Deploy the CA Agile Central On-Premises VMware image to your ESX server from File → Deploy OVF template in your VMware Client Console.
- Select CA Agile Central_On-Premises_[Version].ovf from the unzipped file.
- You may update the name of the CA Agile Central On-Premises Server on your VMware Server to reflect your corporate naming conventions.
- Select your datastore and the network mapping, then deploy the CA Agile Central virtual machine.
- Once deployed to your VMware server, you may check the settings on the CA Agile Central virtual machine and make modifications as necessary.
- Power on the CA Agile Central virtual machine.
- Configure your network information from the VMware client console.
- From the Select Action screen, select Edit Devices → eth0 (eth0).
- Enter a static IP address or leave as DHCP.
- If you assign a static IP address, the Name and Device fields should be configured as eth0. This does not refer to the VM machine host name.
- If you use DHCP and have a DHCP-enabled DNS server, the virtual image will register itself as rallyonprem in DNS.
- Click OK to return to the Network Interface screen.
- (Optional) To configure the domain name service for your domains, select Edit the DNS configuration from the Select Action screen.
- Launch the CA Agile Central Control Panel from your Internet browser.
- By default, CA Agile Central expects a secure http connection to the console. To change this, see Web Server Settings.
Configure Domain Name Service (DNS) on your primary and secondary domain name servers if you wish to use domain name references (rather than static IP addresses) to use CA Agile Central. Follow your company guidelines to configure DNS to access the CA Agile Central Control Panel and the CA Agile Central software application (if you do not do this here, you may configure the DNS servers from the CA Agile Central control panel at a later time).
Wait about five minutes for the server to complete the booting process. Once the booting process is completed, the URL information to log in to the CA Agile Central On-Premises Control Panel and the CA Agile Central ALM application displays.
- If you configured a static IP address in the previous step, go to: https://<ip address>/controlpanel/
- Otherwise, go to the domain that you have configured for CA Agile Central: https://<server name>/controlpanel/
CA Agile Central Control Panel
Use the CA Agile Central Control Panel to manage these administrative tasks:
- Change your password
- Back up and restore CA Agile Central data
- Use the CA Agile Central and search services
- Restart the server
- Activate licensing for your subscription
- View subscription details
- Export log files
- Administer server settings
- View Server information and diagnostic tools
- Email all CA Agile Central users
Change your password
CA Agile Central highly recommends that you change your password on a regular basis for access to the Control Panel.
To change your password:
- Click the Change Your Password link at the top-right of the Control Panel screen.
- Enter your new password into the New Password field.
- Retype your new password into the Retype Password field.
- Save your changes by clicking Reset Your Password.
Back up and restore CA Agile Central dataThe back up and restore features help you to manage snapshots of your CA Agile Central data. To access these features, select Back Up/Restore on the Feature menu. Use any of these options:
- Back up
To back up your CA Agile Central application data:
- Click Back Up/Restore on the Feature menu.
- On the Back Up tab, enter the user name and password for the account on your FTP or SFTP server where you will save your data.
- Optionally, you can upload a private key file in PEM format instead of a password when using SFTP during a back up operation.
- Enter the URL for the directory or folder where you will save your backup data, for example, sftp://www.backupserver.com/backupdirectory/.
CA Agile Central suggests you create a directory or folder to hold only CA Agile Central backup files. CA Agile Central automatically creates the file name for your backup data and stores the file in the directory that you indicate in the path. For example:
Use the file name associated with your release:
- 2011.3: 2011.10.22-2-2014-10-10-09-01-49.tgz
- 2012.1: 2012.02.25-7-2014-10-09-16-14-32.tgz
- 2012.2: 2012.05.19-11-2014-10-09-16-33-34-dp.tgz
- 2012.3: master-2947-2014-10-09-15-41-16-dp.tgz
- 2014.1: master-7241-2014-10-09-15-30-09-dp.tgz
- 2014.2 and higher: almci-master-15355-2014-10-09-15-12-47-dp.tgz
You can change the SFTP port for the back up and restore processes from the On-Premises Control Panel. This can be especially useful if your organization does not use the default ports.
You can add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
The custom port is 800 and the default port is 22.
- Click Send.
Upon completion, you will see the message: Your back up completed successfully.
You can restore any CA Agile Central backup file from your storage location to your CA Agile Central application by either type FTP or SFTP.
To restore your CA Agile Central application data:
- Select Back Up/Restore on the Feature menu, then click the Restore tab.
- Select either FTP or SFTP as your file transfer protocol.
- Enter the user name and password for the account on your FTP or SFTP server from where you will retrieve your data.
- If you use SFTP, you can upload a private key PEM file instead of a password during a restore operation.
- To restore data from a server located in your private network, enter the host server name and click Browse FTP.
The FTP Browse window is populated with available directories, folders, and files. FTP Browse is not available when using SFTP.
- Locate and select the file name to restore. The remaining fields (Remote URL and Remote File) are automatically populated with the related information based on your selection.
- Click Send.
You can also change the SFTP port for the back up and restore processes from the On-Premises Control Panel. This can be especially useful if your organization does not use the default ports.
Add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
The custom port is 800 and the default port is 22.
Upon completion of the restore, the resulting log will display the following message: Your restore completed successfully.
You can schedule your back up to run automatically at a time you specify.
To schedule a back up of your CA Agile Central application data:
- Select Back Up/Restore on the Feature menu, then click the Schedule tab.
- Select the Daily or Weekly back up frequency option.
- Enter the user name and password for your FTP or SFTP server.
- If you use SFTP, you can upload a private key PEM file instead of a password during a restore operation. Enter the URL path to the storage folder that you choose. (Note the example format).
- Click Send. A confirmation message indicates a successful schedule. For example:
- Click the Schedule tab again. The Back up Status dialog box on the right of the display now lists the scheduled back up.
- Click the Delete this Scheduled Back up link at any time to delete the scheduled back up.
You can add the port number to the SFTP host string using the format: sftp://<ip-address:port>/path.
Daily back up has been scheduled for hour 12 AM on host:ftp://atlantis
Use the CA Agile Central and search services
Restart or stop CA Agile Central and manage the search service for your On-Premises installation using the CA Agile Central Services link on the Feature menu.
CA Agile Central service
CA Agile Central suggests all application users be logged out during a restart of CA Agile Central to avoid any conflicts.
To restart CA Agile Central:
- Go to Feature → CA Agile Central Services.
- Click Restart.
Before logging in again, wait five minutes to allow enough time for CA Agile Central to restart all processes.
To stop CA Agile Central:
- Go to Feature → CA Agile Central Services.
- Click Stop.
Once CA Agile Central has stopped, click the Restart button to restart CA Agile Central.
Use the Search Service tab to disable and enable the search service in CA Agile Central. By default, the search service is enabled in CA Agile Central and searches in CA Agile Central are performed using the search service.
To disable the search service, click Disable. The search feature in CA Agile Central is reverted to the default search process and the search service process will be shut down.
The search service provides a process that is scheduled to run once per week to optimize the search service index. This process will remove outdated files to keep the index size as small as possible. However, if you need to run the search index optimization, click Search Index Optimization.
If there is a problem with the search service index, the existing index can be deleted and re-created with the Create Search Index button.
In general, the search service should not need further management or intervention. See CA Agile Central Monitoring Service for more information on this service.
The restart server feature lets you restart the virtual server and the guest operating system where CA Agile Central is installed. CA Agile Central suggests all application users be logged out during a restart to avoid any conflicts.
To restart the CA Agile Central virtual server:
- Go to Feature → Restart Server.
- Click OK on the confirmation message to continue with the server restart.
- Wait five minutes and log into the server.
Your CA Agile Central virtual machine is restarted and the restart status will be visible through the VMware console for the CA Agile Central virtual machine.
Activate licensing for your CA Agile Central subscription
After successful installation of the CA Agile Central application, import your license file into CA Agile Central to activate you subscription and make it accessible to CA Agile Central users. The <License>.asc file is sent to you in an email from CA Agile Central. It is recommended you save this file to a secure location on your local system.
To import your <License>.asc file:
- Go to Feature → Licensing.
- Add your license key by browsing to your <License>.asc file. Select the file and click Open.
- Click Upload to import your license file.
- Restart CA Agile Central to apply the license to your installation.
The path to your file is stored in the Browse box.
After successful import, a confirmation message is displayed: License successfully imported.
Subscription details contained within your license file are available from Feature → Subscription List.
View subscription details
The subscription list provides the details about your CA Agile Central subscription that are contained within your license file. Use this option to help manage your users and determine any modules that are appended to your installation.
To review your Subscription details, go to Features → Subscription List.
|Subscription_Id||Each subscription contains a minimum of two lines. The first line is the administrator's account automatically created by CA Agile Central. The second line reflects details regarding the users and licenses purchased from CA Agile Central. Each account is given an internal CA Agile Central ID which is reported in this column.|
|Max_Users||The number of user licenses purchased from CA Agile Central.|
|Expiration||The expiration date of your CA Agile Central licenses.|
|Name||The name of your CA Agile Central subscription.|
|State||The status of your subscription such, as Active or Inactive.|
|Is_ XXX_Enabled||A binary value that indicates whether your subscription is enabled for any specific CA Agile Central add-ons such as web services, defect management, and Quality Manager.|
Export log files
CA Agile Central captures a log of server events in text files. These files may be used for diagnostic purposes or troubleshooting problems that may occur with your CA Agile Central installation. Log files are compressed into a single .zip file.
To access your log files:
- Go to Features → Log Files.
- On the pop-up window, select the .zip file you wish to use.
- To review the log file, click Open.
- Click Save to save your .zip file to a location that can be accessed outside of the CA Agile Central Control Panel.
If necessary, email the .zip file to CA Agile Central Support for assistance with diagnosis and troubleshooting.
Administer server settings
Use Server Settings from the Feature menu to configure DNS, mail, and web server information. This information is used with CA Agile Central for access of backup and restore files and email notifications within the application. CA Agile Central suggests configuring DNS settings prior to enabling mail server and backup and restore settings from the Feature menu.
You may also configure Network Time Protocol (NTP) synchronization servers using the Server Settings option.
Configure your DNS settings for your installation on the Network Settings tab.
To enter your DNS settings:
- Go to Feature → Server Settings.
- On the Network Settings tab, enter the domain name of your server in the Search Domain field.
- Enter the primary DNS server address in the DNS Server 1 field.
- Enter the secondary DNS server address, if applicable, in the DNS Server 2 field.
- Click Update to save your settings.
- Verify that the correct data is reflected in the Current DNS Settings section in the lower-left portion of the page.
Reset network configuration
Click the Reset the Network Interface link to reset the CA Agile Central virtual machine so that the Network Configuration Interface prompt will display at the next reboot of the virtual machine and guest operating system to allow for changing the IP address of CA Agile Central or setting up DHCP.
Mail server settings
To use the email-dependent features of CA Agile Central, you must configure the address information for your mail server on the Mail Settings tab. If you have a policy that denies relaying of email, then enter your desired domain information in the Outgoing Email Domain field of the Mail Settings tab.
To enter mail server settings:
- Go to Feature → Server Settings → Mail Settings.
- Complete the following fields as necessary:
- Hostname: Must be a domain name. An IP address must exist for the hostname.
- Port: Default is 25. Another common value is 587, but the value depends on your IT servers and the way mail is set up.
- Mail Server authentication (optional): Both username and password are required if you want to use authentication.
- Outgoing Email Domain (optional): Enter the desired domain information if your organization has a policy that denies relaying emails.
You can click the Clear Settings and Save button to reset settings.
Web server settings
CA Agile Central uses secure HTTP to access your software after a typical installation. Although not recommended, it is possible to override this setting and configure your installation of CA Agile Central to use a non-secure HTTP format using the Web Server Settings tab.
To enable Non-Secure HTTP Access for your web server:
- Go to Feature → Server Settings → Web Server Settings.
- Select the Enable field.
- Click Update to save your changes.
A confirmation message displays. Click OK to exit the window.
Network time settings
The Network Time Protocol (NTP) is a commonly used protocol for synchronizing computer system clocks over data networks. NTP servers provide the synchronization point of reference.
To enter network time settings:
- Go to Feature → Server Settings → NTP Settings.
- Enter your primary NTP server hostname or IP address in the NTP Server 1 field.
- Enter your secondary (backup) NTP server hostname or IP address in the NTP Server 2 field.
- Click Update to save your NTP Server settings.
After a successful update, your NTP Server Settings are listed at the bottom of the page under Current Time Servers at the bottom of the screen.
Delete your NTP server settings at any time with the Click here to clear NTP servers link at the bottom of the screen.
If you have the CA Agile Central LDAP module enabled on your CA Agile Central subscription, this tab provides the setup interface to enter information specific to your CA Agile Central subscription and LDAP environment. For full information about setting up the CA Agile Central On-Premises LDAP module, see Enabling the CA Agile Central On-Premises LDAP Module.
To enter LDAP settings, go to Feature → Server Settings → LDAP Settings.
|LDAP Hostname||Enter the fully qualified host name of the LDAP server.|
|Port||The port number the LDAP server is listening on, typically 389.|
|Enable LDAP over SSL||Select this field to allow CA Agile Central to connect to the LDAP server using SSL. The port number may need to be updated as well if using SSL. For more information about importing a certificate to the CA Agile Central On-Premises server to be able to use LDAP over SSL, see Java Keystore.|
|Select LDAP Vendor||Select the vendor of your LDAP server. Available options are: Active Directory, Oracle Internet Directory (10g or 11g), and Oracle Directory Server 11g.|
|Bind Username DN||Enter the fully qualified name to authenticate to the LDAP server.
Example: CN=LdapReadonly, CN=Users, DC=rallydev, DC=com.
|Bind DN Password||Password for the bind user.|
|LDAP Tree Base DN||The top-level tree node of the LDAP directory where your users and groups are located.
Example: CN=Users, DC=rallydev, DC=com.
|User Name Attribute||The attribute that lives on the LDAP server, which should be a globally unique identifier within the directory. Once users are populated, they will use the value of this attribute as their login name, for example, sAMAccountname.|
|LDAP Group Management
Note: This is not required if you choose authentication with username and password only.
|Require membership in an LDAP group||This checkbox is selected by default. Unchecking the box confirms that users will be logged in through authentication only. If you disable the group membership option, the LDAP user syncing service will no longer be available. Users authenticating with CA Agile Central will no longer be required to have membership in a specific LDAP group.|
|Group Name||The group you created in Setup your LDAP Environment on your LDAP server which contains the users you would like to allow access to CA Agile Central. Multiple groupNames separated by a | (pipe) symbol are allowed. These can be different LDAP groups. Nested groups are NOT supported.
The following Active Directory configurations have been verified:
CN=CA Agile Central Test Group,CN=Users,DC=rallyonprem,DC=local|
|Group Attribute||The group attribute for your LDAP Server. Generally, memberOf is used with Active Directory and isMemberOf, member, or uniqueMember is used with Oracle products. You will need to check with your LDAP administrator to determine which one is in use in your environment.|
Note: This requires LDAP Group Management.
|Enable LDAP Synchronization Service||Enabling this feature will schedule a sync of any newly added users from the LDAP CA Agile Central group to CA Agile Central. This sync is scheduled to occur every 15 minutes.|
|Run LDAP Synchronization Immediately after Save Settings||Force a sync to run right after saving your LDAP settings.|
|CA Agile Central Username||The CA Agile Central subscription or workspace administrator account that will be used to create new CA Agile Central users.|
|CA Agile Central User Password||Password for the CA Agile Central subscription or workspace administrator.|
|Test Connection||Once the LDAP Hostname, Port, Bind Username DN, Bind DN Password, and Group Name have been entered, use this button to test the LDAP connection from the CA Agile Central server. The test will first try to bind to the LDAP server then attempt to search for the Group Name on the LDAP server.|
|Disable LDAP & Restart CA Agile Central||Deletes the LDAP authentication settings on the CA Agile Central server and CA Agile Central is restarted to disable LDAP authentication and enable CA Agile Central authentication.|
CA Agile Central LDAP user report
Once the CA Agile Central On-Premises module is set up and enabled, the LDAP user report is available to show the current provision status of users in your CA Agile Central subscription and the LDAP directory.
Running the report will provide a text file with a list of users and whether they are provisioned in CA Agile Central, LDAP, or both. The file also provides instructions on reconciling the users between the CA Agile Central subscription and LDAP.
Your Secure Sockets Layer (SSL) certificate enables encryption of sensitive information that is transmitted between the browser and the server during online transactions. Your SSL certificate is also used to identify you as the registered owner of the domain that is referenced in the transaction.
You will need the certificate file, key file, and, if a chained SSL certificate is used, the SSL Certificate Bundle file. Customers who install CA Agile Central on premises have the option to generate their own certificate, purchase a certificate from a third party vendor, or use the CA Agile Central certificate that is installed by default.
If the domain owner of the URL does not match the owner of the SSL certificate, you may see an error from your browser warning you of the mismatch. Access to the CA Agile Central Web Services API may also be hindered if the domain owner of the URL does not match the owner of the SSL certificate.
If your users are comfortable with understanding why the mismatch exists, you may click through the error window and continue using the application. If you wish to avoid receiving the error, you will have to generate a certificate for your company domain and install it from the SSL Certificate tab.
To install an SSL certificate:
- Generate or purchase your certificate (this should be a single root or unchained certificate) and copy your certificate (.cert) and key (.key) files to the CA Agile Central server.
- Copy them to a convenient place where you may easily access them for installation.
- Go to Feature → Server Settings → SSL Certificate.
- Click Choose File next to the SSL Certificate indicator to locate your SSL certificate (.cert) file.
- Click Choose File next to the SSL Key indicator to locate your SSL key (.key) file.
- If your SSL Certificate is a chained certificate, select the Chain Certificate File field. Click Choose File next to the SSL Certificate Bundle indicator to locate your SSL certificate bundle file.
- Click Upload to upload and install your certificate and key files.
- Restart the server.
To restore the default SSL certificate:
- Go to Feature → Server Settings → SSL Certificate.
- Click the Restore Default Certificates link at the bottom-left of the SSL Certificate page.
Create an SSL certificate from a third-party vendor
This section assumes the openssl command is available on the system used to create the private keys. You do not need to be on the CA Agile Central machine to do this, but the steps below were created using a Linux machine. The steps may vary using a Windows machine with OpenSSL.
- Generate a private key.
- Generate a Certificate Signing Request (this certificate will be used to generate our ssl certificate on the third party's site.)
- Remove the passphrase from the key.
- Submit your request to your third-party vendor. The SSL certificate that is obtained should be a single root or unchained certificate.
- After submitting your CSR to a third-party vendor they will send you a .crt file. This file is used in combination with the key generated in step 1 to upload to the On-Premises image.
- Verify the format of your certificate by opening the .crt file using a text editor. This file should have the same format as the one below:
- Use the .crt file the vendor sends you in combination with the key file you generated to upload to your On-Premises image.
openssl genrsa -des3 -out www.mydomain.com.key 1024
openssl req -new -key www.mydomain.com.key –out www.mydomain.com.csr
cp www.mydomain.com.key www.mydomain.com.key.org
openssl rsa -in www.mydomain.com.key.org -out www.mydomain.com.key
The CA Agile Central On-Premises LDAP solution supports the ability to connect to an LDAP server over an SSL connection. Before the server can connect securely, the certificate of this server will need to be imported into the Java keystore located on the CA Agile Central On-Premises instance. To get started, locate the SSL certificate used by your LDAP server and copy it to a machine that has access to the CA Agile Central On-Premises Control Panel. Once this is complete follow the instructions below.
Add public keys
- From the CA Agile Central Control Panel, go to Server Settings → Java Keystore.
- Click Browse and select the certificate file from the LDAP server, then click Upload.
- Once the upload has completed, CA Agile Central needs to be restarted before the certificate can be used for LDAP authentication.
View content of a key
After you have uploaded a key, click the View Contents link and verify that the correct key has been uploaded.
Delete a key
Delete a key if necessary from the Delete link. After deleting the key, you must restart CA Agile Central for the key to be deleted from the server cache.
View server information and diagnostic tools
Current server status
The Current Server Status page provides a snap-shot of the CA Agile Central On-Premises machine. The page provides the current disk usage, current memory usage, and the usage of the database on the system. You may download the database usage output if needed to send to CA Agile Central Support.
Search service status
If the Search Service has been enabled, the Search Service status displays at the bottom of the Current Server Status page. This section displays current settings, the index directory size, next and last scheduled index optimizations, and a link to download the Search Service logs should the need arise to review them or send them to CA Agile Central Support.
Network settingsThe Network Settings tab provides a listing of the current network settings on the CA Agile Central On-Premises machine.
The Ping tab provides the Ping utility for network troubleshooting purposes.
Enter a computer name or IP address for a host you are trying to reach. Select the number of times to run the Ping command and then click the Ping button. If you have selected more than one as the number of times to run the Ping command, the output may be delayed as it waits for the Ping command to complete before displaying the output.
The TCP/IP tab provides access to the netcat utility (similar to telnet) to assist with network troubleshooting.
Enter a fully qualified computer name or IP address for a host you are trying to reach and a port number, then click Connect. The utility will attempt to connect to the destination and will provide the result message in the TCP/IP output box. It may take a few seconds for the results to display in the output box.
The Email Test page provides the current status of sendmail on the CA Agile Central On-Premises server, the current size of the sendmail queue, and a way to test sending an email.
To send a test email, enter the to and from addresses in the appropriate fields, then click Test Email. A test email will be sent from the CA Agile Central server. The sendmail log file will display in the Email Test section of the form. It may take a few seconds for the log to display as the page will search the sendmail log file for the recipient of the email and today’s date to display the status of the test email.
Email all CA Agile Central users
The Email All Users link allows the CA Agile Central server administrator to send an email to all the users that currently have an enabled account in CA Agile Central. This can be used to notify CA Agile Central users of upcoming maintenance or other CA Agile Central related messages. It is a text-based email (no HTML or rich text).
The Email All Users page will attempt to send the emails to users that have an account in CA Agile Central and are currently enabled. The email first is routed to the sendmail server on the CA Agile Central server. Delivery is not guaranteed and the page only displays an error if there is a problem with email creation and routing it to sendmail. No other error logging is done.
CA Agile Central login banner
The CA Agile Central Login Banner link allows the CA Agile Central server administrator to enter either a bulleted list or message that displays on the CA Agile Central Login page. No markup text (HTML or XML) is allowed. The markup tags will be displayed as entered.
Displayed on CA Agile Central Login page:
Or, you can enter a 550-character message as a CA Agile Central login banner:
Displayed on CA Agile Central login page:
Enable the CA Agile Central On-Premises LDAP Module
Make sure you have the following prerequisites:
- A CA Agile Central On-Premises instance, version 2011.3 or later.
- The CA Agile Central license key with the LDAP module enabled.
- If using an SSL connection to the LDAP server, you will need to upload the SSL certificate from the LDAP server to the CA Agile Central Java keystore.
- Access to an LDAP server with read-write permissions and the connection information. Refer to the CA Agile Central On-Premises LDAP module worksheet that can be sent to your LDAP administrator to provide the necessary information to connect to the LDAP server.
- An LDAP browser client is recommended to help with finding the correct locations of nodes within an LDAP directory (optional: a free client, LDAP Browser 4.5).
- Access to a machine with Ruby installed.
Set up CA Agile Central for LDAP
- Load the CA Agile Central On-Premises image into a VMware server.
- Install the new CA Agile Central license key, with the LDAP module enabled, from the Licensing page on the Control Panel.
- After the license has been installed, restore a current copy of your existing database using the Restore feature.
If you are installing CA Agile Central for the first time, restart CA Agile Central by clicking the CA Agile Central Services link, then click Restart for the new license key to be loaded.
- Ensure the DNS settings entries have been filled in and saved on the Network Settings tab so that the LDAP hostname will be properly resolved.
- Log in to CA Agile Central as a subscription administrator or use the default subscription administrator login, email@example.com, to create a new workspace in CA Agile Central.
Name this new workspace CA Agile Central LDAP (or whatever naming convention is acceptable in your environment). Go to Setup → Workspaces & Projects → Actions → New Workspace to create the new workspace.
- Click the (+) icon next to the CA Agile Central LDAP workspace you just created, then click the edit icon at the end of the sample project row to edit the name of the project.
- Rename the project to CA Agile Central LDAP Project (or whatever naming convention is acceptable in your environment). Click Save & Close.
- From the Users tab, create a new CA Agile Central user that is a subscription or workspace administrator (if your CA Agile Central subscription allows workspace administrators to add new users).
- Set the user name to any valid email address format.
Then set the email address to a valid email address so that the welcome email for this new user will be sent to you and a password can be set on the new account. The LDAP sync process will run as this user logs in to CA Agile Central and creates the new CA Agile Central users.
- Log out of CA Agile Central as the subscription administrator and log in to CA Agile Central as the new user. You should receive an email with a link to set the password.
- Click on the profile image in the upper-right corner, then select My Settings.
- Set the default workspace and project for the user to what you specified in steps 5 and 7.
This will be the default workspace and project to which newly created users will be assigned when the LDAP sync process is run. If this is not done, new users will be assigned to the first available workspace and project associated with the CA Agile Central user account used when running the CA Agile Central LDAP sync process. An existing CA Agile Central subscription or workspace administrator may be used for this process; however, it will be necessary to set the appropriate default workspace on this user account so new users are created with the appropriate initial workspace and project permissions.
Set up your LDAP environment
If you are an existing CA Agile Central On-Premises customer, follow these steps to update your CA Agile Central subscription with the LDAP usernames for existing users. If this is a new installation of CA Agile Central On-Premises, go to Enabling LDAP on CA Agile Central On-Premises.
- Create a unique CA Agile Central group on your LDAP server.
- Update the LDAP server so the current CA Agile Central users are members of the newly created CA Agile Central LDAP group. These users should already exist in your CA Agile Central subscription.
- Before continuing, ensure the following are set up:
- A machine with Ruby 1.8.5 or higher running with the following Ruby Gems: rally_rest_api, fastercsv, and builder.
- Copy the user_load_script.rb to the machine containing Ruby. This should be available for download from the same location as the CA Agile Central On-Premises download or provided to you by the CA Agile Central Support team.
Example CSV format for the user_load_script.rb(email address,ldapname):
Only the username is copied to CA Agile Central; the Office Location value is typically set to None.
rally_url = https://<ip or host here>/slm (address of the CA Agile Central installation)
rally_user = CA Agile Central subscription administrator or account
rally_password = CA Agile Central password
filename = <filename of CSV> (Location and name of CSV file)
New users created from the LDAP sync script have read-only permissions on the workspace level.
Enable LDAP on CA Agile Central On-Premises
Before you enable LDAP, you will need information about the LDAP environment at your company. Use the CA Agile Central On-Premises LDAP module worksheet to send to your LDAP administrator to provide the necessary information to connect to the LDAP server.
- From the Control Panel, go to Server Settings → LDAP Settings.
- Make any necessary changes and click Save Settings & Restart CA Agile Central.
CA Agile Central is automatically restarted which will enable LDAP authentication. Once CA Agile Central has been restarted, all provisioned users will now be able to log in using their unique LDAP username and password.
For a detailed table of all the LDAP settings, go here.
Run the LDAP sync
The LDAP sync runs several services to update the CA Agile Central user accounts based on the specified LDAP group and the LDAP vendor.
The sync will first query LDAP for all the users in the specified LDAP group. It will then check to ensure all the users in that group are in CA Agile Central and that the accounts are enabled in CA Agile Central.
A check is performed for enabled CA Agile Central accounts that do not exist in the specified LDAP CA Agile Central user group. If there are accounts in CA Agile Central that are not in the LDAP group, the CA Agile Central accounts are disabled.
If you are using Active Directory, a second service (Service 2) is run to disable any CA Agile Central user accounts that have been disabled in Active Directory, regardless if they are in the specified CA Agile Central group in LDAP. The second service will not be run for Oracle LDAP servers.
An example of the log output when an LDAP sync is run using Active Directory is below.
An example of the output for the second service when running the sync against an Oracle LDAP server is below.
An example of multiple groups in the sync output is below.
Backup and restore LDAP settings
The LDAP settings are saved during a backup of the CA Agile Central On-Premises server. Once the LDAP module is enabled or if the LDAP settings are updated, perform a backup of the CA Agile Central On-Premises server from the Backup/Restore link on the Control Panel to ensure that the proper LDAP settings are captured and not overwritten by a restore containing outdated LDAP connection information.
CA Agile Central Monitoring Service
The CA Agile Central Monitoring Service monitors and visually displays the performance metrics of CA Agile Central On-Premises. The service is designed for administrators that manage On-Premises and is deployed from your VMware™ infrastructure. Performance data, such as CPU load or Java Virtual Machine memory usage, flows from CA Agile Central On-Premises to the CA Agile Central Monitoring appliance to be displayed. No CA Agile Central project data is transmitted off of CA Agile Central.
Note: The CA Agile Central Monitoring Service is enabled through a license key, obtained by contacting CA Agile Central Support.
CA Agile Central On-Premises and the CA Agile Central Monitoring Service are both supported by the VMware platform. CA Agile Central’s virtual server architecture supports both the CA Agile Central On-Premises appliance for teams and the CA Agile Central Monitoring Service for administrators.
The CA Agile Central Monitoring Service base requirements includes the following:
- VMWare platform with 64-bit support. This includes ESX 4.0 and above and vSphere Hypervisor 5 and above.
- The vSphere Hypervisor can be downloaded at: https://www.vmware.com/.
- 64-bit capable processors with hardware virtualization (Intel® VT-d, AMD AMD-V).
- 1.5 GB of RAM for CA Agile Central Monitoring Service use.
- 45 GB of disk space for CA Agile Central Monitoring Service VMware image.
The CA Agile Central Monitoring Service has been tested using Google Chrome version 32 and Firefox version 27. Other browsers will be tested and supported in future releases.
Installation and configuration
Before you can start using CA Agile Central’s Monitoring Service, you will need the following:
- CA Agile Central On-Premises 2014.3 installed and running.
- IP address of CA Agile Central On-Premises.
- Ability to deploy an instance of CA Agile Central Monitoring Service in a network segment accessible by CA Agile Central On-Premises.
- The CA Agile Central Monitoring Service listens on the following interfaces:
- TCP port 80/HTTP – Web interface to CA Agile Central Monitoring Service
- UDP port 8649/ganglia – Receives statistics from CA Agile Central On-Premises
- TCP port 22/SSH – Management interface (CA Agile Central internal use only)
- CA Agile Central On-Premises sends statistics to CA Agile Central Monitoring Service on the following interface:
- UDP port 8649/ganglia
Install CA Agile Central On-Premises Monitoring VM
Contact CA Agile Central Support to obtain the CA Agile Central Monitoring VM zip file.
Install the Monitoring VM
- Extract the software to a location that can be accessed from the VMware client console.
- Unzip the file.
- Deploy the CA Agile Central Monitoring VM to your ESX server from File → Deploy OVF Template in the console.
- Select CA Agile Central Monitoring VM Service from the unzipped file.
- Select your Datastore and the Network Mapping, then select Deploy the CA Agile Central Virtual Machine.
- Power on the CA Agile Central virtual machine.
You may update the name of the CA Agile Central On-Premises server on your VMware Server to reflect your corporate naming conventions.
Configure your network information
Upon first boot, the instructions below must be completed to configure the system from the VMware Client console.
- From the Select Action screen, select Device Configuration.
- Select eth0 (eth0) to edit.
- Enter a static IP address or leave as DHCP. If you assign a static IP address, the Name and Device field should be configured as eth0. (This does not refer to the VM machine hostname).
- Click OK to return to the Network Interface screen.
- On the Select Action screen, select DNS configuration to configure domain name service for your domains.
- Configure Domain Name Service (DNS) on your primary and secondary Domain Name Servers if you wish to use domain name references (rather than static IP addresses) to use CA Agile Central.
- Allow the CA Agile Central Monitoring Service to complete the booting process. Once the booting process is completed, you will be provided with the URL information to login to the CA Agile Central Monitoring Service web interface.
- Access the CA Agile Central Monitoring Service user interface by entering the URL in your browser.
Next, you will need to configure the On-Premises Control Panel for monitoring.
Configure CA Agile Central On-Premises for monitoring from the Control Panel
- Click the Monitoring Service tab in the Control Panel, or enter the following URL in your browser to access the Monitoring Administration tab in the CA Agile Central On-Premises Control Panel:
- Enter the Monitoring Server IP address and click Update.
- Return to the URL address for the Monitoring VM (as described in Configure Your Network Information). Wait approximately 5–10 minutes while statistics are processed by the Monitoring VM. Your CA Agile Central Monitoring VM dashboard will then display.
The Documentation link, located in the upper-right of the Monitoring Service application, displays a page that provides information about specific statistic entries.
The content of the snapshot includes just the CA Agile Central Monitoring Service graphs bundled into an archive. Note that no CA Agile Central project data is included in the snapshot.
To create a snapshot, click the Snapshot icon, located in the upper-right corner of the CA Agile Central Monitoring Service user interface:
To assist in assessing the performance of CA Agile Central On-Premises, the CA Agile Central Monitoring Service can export a snapshot in a format that can be sent to CA Agile Central Support. You will need to be a member of the CA Agile Central Success Community in order to submit a case to Support. Note that the attachment size is limited to 5MB.
Upgrade CA Agile Central
CA Agile Central releases updated software builds for On-Premises customers approximately quarterly during the year. Access information about the releases and other important news by subscribing to the CA Agile Central On-Premises blog. You may deploy each release at your convenience. CA Agile Central Technical Support will provide support for the currently released build of the CA Agile Central application., Most upgrades need to be done with a CA Agile Central VMware machine due to changes to the CA Agile Central VMware image:
Open a new version in parallel with old version (recommended)
- Follow the installation instructions to install the new version of CA Agile Central on your VMware server.
- When prompted for the IP address, enter a new IP for this new instance.
- Follow the instructions to configure CA Agile Central and import the license key.
- Restart the new CA Agile Central installation so changes will take effect.
- Back up the old instance of CA Agile Central from the old instance of the Control Panel.
- From the Control Panel of the new instance, Import (Restore) the file you exported above into the new version of CA Agile Central.
- Verify all is working as expected with the new instance.
- Schedule the backups and configure email.
- Update your DNS settings (or advise users of the new IP) to point to the new IP address being used by the new instance of CA Agile Central.
- Shut down the old instance on the VMware server.
Shutdown the old version then open the new version
- Backup (Export) the old instance of CA Agile Central.
- Shut down the old instance of CA Agile Central.
- Install the new version of CA Agile Central on your VMware server.
- When prompted for the IP address, use the same IP as the old instance of CA Agile Central or set up the new IP information.
- Set up CA Agile Central and import the license key.
- Import (Restore) the file you exported into the new version of CA Agile Central.
- Confirm that the new instance is working and looks correct.
The license key will be a new one that has been sent or, if still valid, the previous license can be imported.
CA Agile Central Idea Manager & CA Agile Central Support Manager Integration
The documentation for the CA Agile Central Idea Manager and CA Agile Central Support Manager Integrations are supplied in a separate zip file:
CA Agile Central-Manager-Integration.zip
The file is located at the same location where the CA Agile Central On-Premises Installation Guide was downloaded.
If you are experiencing issues, check these symptoms and try the recommended actions in the order in which they are described below:
|CA Agile Central stops responding.||
|Backups fail. A failure message displays in output text.||In choosing the appropriate action below, consider whether the backups have completed successfully in the past:
|CA Agile Central appears to be slow.||
|The mail server is not operating.||
|Your browser displays an error warning you of a certificate mismatch.
Connecting to CA Agile Central Web Services API fails with an error similar to: "remote certificate is invalid according to the validation procedure".
|The domain owner of the URL does not match the owner of the SSL certificate:
Install an SSL certificate that is registered to the same owner as the domain name.
|An SSL certificate is not available for your domain.||
|You are locked out of the CA Agile Central control panel.||
|Cannot access the CA Agile Central Web Services API documentation from the Help link within CA Agile Central.||Access the Web Services documentation directly by typing the URL below into your web browser (change <RALLY SERVER> to the IP address or name of the server hosting your CA Agile Central tool):
CA Agile Central On-Premises LDAP Module worksheet
Fully-qualified Host a name of the LDAP server, such as directory.mycompany.com.
Port that LDAP server listens on. Typically 389, If LDAP over SSL, 636.
LDAP SSL-Enabled? ______
LDAP Vendor and Version: ________________________________________
Example: Oracle Identity Server 11g, Active Directory
LDAP SSL Certificate to Load into CA Agile Central Keystore? ______
LDAP Bind Username DN: _________________________________________
Example: CN=myLDAPUser, CN=Users, DC=mycompany, DC=com
LDAP Tree Base DN: _____________________________________________
Example: CN=Users, DC=mycompany, DC=com
LDAP User Name Attribute: ________________________________________
Example: sAMAccountName, uid
LDAP Groups Name for CA Agile Central Users: _________________________________
Example: CN=CA Agile CentralGroup, CN=Users, DC=rallydev, DC=com | CN=Ops, OU=Groups, DC=rallydev, DC=com | CN=CA Agile CentralGroup2, CN=Users, DC=rallydev, DC=com
LDAP Group Attribute: ___________________________________________
Example: member, memberof, s