 Feedback
|
Table Of Contents
Cisco Prime Home 5.0.1 Deployment Overview
System Requirements for Prime Home
System Requirements for the Content Filtering Server
Configuration File Customization
Content Filtering Service Setup
Overview of the Prime Home GUI
Obtaining Documentation and Submitting a Service Request
Deployment Overview
Cisco Prime Home 5.0.1 Deployment Overview
Revised: August 6, 2012, OL-27646-011 Overview
The following topics provide an overview of the goals, limitations, and content of this guide:
Purpose of This Guide
This guide briefly describes the Cisco Prime Home 5.0.1 deployment architecture, installation requirements, installation setup, and GUI. Installing Prime Home involves various third-party components. Cisco Advanced Services provides the support you will need to deploy Prime Home in your network.
Note
This guide does not replace other available Cisco Prime Home documentation, as it contains the minimum subset of information required to get started. For detailed information on any of the topics in this guide, see the complete Cisco Prime Home 5.0.1 documentation set at http://www.cisco.com/en/US/products/ps12589/tsd_products_support_series_home.html.
Limitations of This Guide
This guide is not intended for large-scale, redundant environments, either at the customer premise equipment (CPE) level or the additionally supported components level.
This guide might not cover the information on all third-party components, and is based on the following limitations and requirements:
•
•
•
•
This guide does not cover the following:
•
•
•
•
•
2 Deployment Architecture
The following topics describe Prime Home availability, deployment variants, licensing requirements, and installation components:
Prime Home Availability
Prime Home is available as a hosted solution and an onsite solution.
Hosted Prime Home
The hosted Prime Home solution involves setting up Prime Home in a cloud environment, where users are given access to Prime Home. A dedicated server space is allocated to the user based on the license, and the license governs the number of users who can access Prime Home simultaneously. Service providers can ask Cisco to monitor the performance of Prime Home for their network setup, and provide maintenance support.
Onsite Prime Home
The onsite Prime Home solution involves setting up Prime Home in the service provider's network. The service provider manages all of Prime Home, including database setup and server space management. The number of users who can access Prime Home simultaneously depends on the license acquired by the service provider. The onsite Prime Home solution provides the flexibility to customize third-party components based on Prime Home usage.
Deployment Variants
The Prime Home platform can be deployed as the following variants:
•
•
•
Licensing Requirements
The license determines the maximum number of Prime Home sessions allowed, and which Prime Home features are available. For more information on Prime Home licensing, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
Installation Components
Prime Home installation requires setting up the Automated Configuration Service (ACS) node. The ACS node facilitates provisioning and configuring the CPE. When the CPE boots up, it communicates with the ACS node to get the initial configuration. The ACS node provisions the CPE based on the firmware rules defined in the applicable firmware version.
Table 1 describes the network components required to set up an onsite Prime Home solution.
Table 1 Installation Components
Apache ActiveMQ
Open source messaging platform that facilitates sending Java messages and acts as a message queue for Prime Home. Multiple instances of ActiveMQ can be set for Prime Home to serve the ACS GUI. For more information on Apache ActiveMQ, see http://activemq.apache.org/.
Apache Solr
Document repository where you store database indexes. Solr allows you to run the Prime Home GUI with rapid access to all of the data. Instead of directly accessing the database, Solr accesses the index manager and retrieves the data in XML format. Solr must be configured in a primary-secondary (master-slave) environment to support Prime Home. For more information on Apache Solr, see http://wiki.apache.org/solr/.
(Optional) Session Traversal Utilities for NAT (STUN)
Allows a server to communicate with devices behind a firewall. STUN is needed only when you do not have a direct network route to the device. In a hosted Prime Home setup, the server is located in a Cisco data center and might not have direct access to your network. With onsite Prime Home, you can set up routing within your network.
Cisco Taze provides STUN functionality and can be deployed in your network with the help of Cisco Advanced Services.
Apache server
Provides standard HTTP services and helps in setting up the Prime Home host in public, private, and secured mode. For more information on the Apache server, see http://httpd.apache.org/docs/2.2/.
Apache Tomcat
Java container platform for Prime Home. Tomcat provides an open-source implementation of the Java servlet and Java server technologies. For more information on Apache Tomcat, see http://tomcat.apache.org/.
ACS CPE
Facilitates configuring and provisioning the CPEs. The ACS CPE component also provides API service, which is used to discover data from CPEs for performance management. The ACS CPE component is used to apply a specific configuration on the CPE.
ACS UI
Enables CPEs to retrieve the initial configuration and firmware rules. When the CPE boots up and contacts the ACS UI, the CPE-responder component sends the initial configuration to the CPE. The ACS UI also provides a simulated view of the subscriber's network from the Prime Home GUI and the Control Panel for subscribers.
Index Manager
Accesses the database and retrieves data. The Index Manager also converts data to XML format. The Solr component uses this XML data to serve the Prime Home GUI.
Content Filtering Service
Provides access control for HTTP requests, based on the selected profile. This component enables you to allow or block HTTP requests received from devices at the CPE level. For more information on the Content Filtering Service, see Content Filtering Service Setup.
Third-Party Categorization Engine
Provides profile-based categorization service for HTTP requests. The Content Filtering Service uses the Categorization Engine to retrieve the allowed and blocked URLs list.
Cloudera Flume
Provides data transport between Prime Home and the data store. For more information on Cloudera Flume, see https://ccp.cloudera.com/display/CDHDOC/Flume+0.9.x+Installation.
MongoDB
Document storage solution for Prime Home. Prime Home supports configuring multiple instances of MongoDB for document storage. For more information on MongoDB, see http://docs.mongodb.org/manual/.
Figure 1 provides an overview of the installation components for Prime Home.
Figure 1 Installation Components for Prime Home
3 Installation Requirements
The following topics provide prerequisites and system requirements for installing Prime Home:
•
•
Prerequisites
To install Prime Home, you must meet the following prerequisites:
•
•
•
•
–
–
System Requirements for Prime Home
Table 2 lists the minimum system requirements to install Prime Home. These requirements are for planning purposes only, and might vary based on your network infrastructure.
System Requirements for the Content Filtering Server
You can enable Content Filtering Service for all Prime Home variants. The Content Filtering server must be available in the network infrastructure before you enable Content Filtering Service.
Table 3 lists the minimum system requirements for the Content Filtering server.
4 Installation Setup
The following topics describe the setup required to install Prime Home:
•
•
Network Infrastructure Setup
Prime Home deployment depends on the network infrastructure, and may vary based on the components available in the network.
When you are ready to set up the network infrastructure for installing Prime Home, contact Cisco Advanced Services to configure the following components:
•
•
•
•
Configurator Tool Setup
The Configurator tool is provided with the Prime Home installation package, and is used to retrieve the Prime Home configuration, from the database server to the host server. The Configurator tool is installed on the Prime Home host server.
The Prime Home configuration for a specific network is defined using the configuration file. The configuration file is customized based on the network infrastructure and placed on the database server. See Configuration File Customization.
For installing Prime Home, the Configurator tool facilitates running the customized configuration file on the host server.
When you are ready to set up the Configurator tool on the Prime Home host server, contact Cisco Advanced Services.
Configuration File Customization
You can customize the configuration file based on the components available in the network infrastructure. If the configuration file is not customized correctly, the Prime Home installation might fail.
The configuration file consists of various fields that are updated based on the third-party technologies available in the network. Once the configuration file is updated, place it at the required database instance on the database server.
The following is a sample configuration file:
{"_id": {"$oid": "4e8deedf30042dc3e3e1b3a1"},"clusterId": "app-svr-01","configTemplates": {},"distribution": "","licenseFile": "","loadBalancers": [{"hostname": "192.168.25.244","location": "/home/clearvision/cv/lb","nodeIds": ["aa","bb"],"type": "apache","url": "app-svr.yourserver.com","user": "clearvision"}],"nodes": [{"hostname": "192.168.25.244","location": "/home/clearvision/cv/server-aa","nodeId": "aa","properties": {"log4j_logFile": "/home/clearvision/ph/logs/acs-a.log","ports_tc_ajp_external": "8092","ports_tc_ajp_internal": "8093","ports_tc_http_external": "8090","ports_tc_http_internal": "8091","ports_tc_shutdown": "8094","rrd_directory": "/home/clearvision/ph/logs/rrd-a","tc_route": "aa"},"user": "clearvision"},{"hostname": "192.168.25.244","location": "/home/clearvision/cv/server-bb","nodeId": "bb","properties": {"log4j_logFile": "/home/clearvision/ph/logs/acs-b.log","ports_tc_ajp_external": "8042","ports_tc_ajp_internal": "8043","ports_tc_http_external": "8040","ports_tc_http_internal": "8041","ports_tc_shutdown": "8044","rrd_directory": "/home/clearvision/ph/logs/rrd-b","tc_route": "bb"},"user": "clearvision"}],"properties": {"clientId": "app-svr-01","db_password": "acs","db_schema": "app-svr-01","db_url": "jdbc:mysql://192.168.25.191/app-svr-01","db_username": "acs","jms_brokerUrl": "tcp://192.168.25.244:61616?wireFormat.maxInactivityDuration=0","smtp_host": "exampletel.clearvision.com","solr_url": "","url_user_internal_root": ""}}Table 4 provides field descriptions for the configuration file.
Database Preparation
The MySQL database setup depends on the size of the network and the type of Prime Home deployment. Prime Home can be deployed in single node, multiple node, or High Availability setup.
Contact your local MySQL database administrator to create the database. For information on the MySQL database, see http://www.mysql.com/downloads/.
The MySQL database must be functioning normally before you configure the Prime Home MySQL instance. Cisco Advanced Services can help you to configure the database instance for Prime Home.
Content Filtering Service Setup
The Content Filtering Service enables subscribers to restrict access for specific websites, at the CPE level. The content filtering settings can be applied to all devices in the subscriber's network. Content filtering is based on a third-party database that filters the websites based on age criteria.
A separate server is required to host the Content Filtering Service. Cisco Advanced Services can help you to set up the Content Filtering Service for Prime Home.
5 Getting Started
The following topics describe how to get started with Prime Home:
•
GUI Access
Prime Home functionalities are available based on the privileges assigned to the user. You can create a custom user and map privileges to the user account based on your staffing model. When the user logs into Prime Home with the appropriate username and password, Prime Home runs with the functionalities mapped to the user account.
For information on how to log into Prime Home, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
Overview of the Prime Home GUI
The Customer Service Representative (CSR) and administrator can use the Prime Home GUI to perform various network monitoring and configuration tasks. The Prime Home GUI also provides a simulated view of the subscriber's home network.
Table 5 describes the Prime Home GUI tabs.
Table 5 Prime Home GUI Tabs Description
CUSTOMER SUPPORT
CSRs use this tab to monitor and manage the subscriber's home network.
DASHBOARD
Administrators use this tab to get a summary of recent activities; for example, network updates about device connections and subscriber labels.
ADMINISTRATION
Administrators use this tab for configuration and firmware management.
AUDIT
Administrators use this tab to view the network changes performed:
•
•
•
•
BULK OPERATIONS
Administrators use this tab to configure and provision multiple devices simultaneously. This tab also enables administrators to run a particular operation on a set of devices; set the date and time to run the operation; and name the bulk operation activity.
REPORTS
Administrators use this tab to extract reports for the subscriber's home network, based on criteria specified for the subscriber and device. Administrators use these reports to enhance security utilities and observe the subscriber's network performance.
UTILITIES
Administrators use this tab to import the subscriptions in Prime Home and troubleshoot the subscriber's network. This tab enables administrators to directly access the integration API and perform the required actions.
Figure 2 shows the Prime Home GUI.
Figure 2 Prime Home GUI
For information on how to use the functions available in Prime Home, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
User Privileges
The Prime Home GUI provides functions based on the privileges assigned to the user. Prime Home users can be categorized as follows:
•
•
•
•
CSR Functions
CSRs have complete access to the Customer Support tab in Prime Home and can perform the following operations:
•
•
•
•
•
•
•
For information on how to perform these operations, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
Administrator Functions
Administrators have complete access to Prime Home and can perform the following operations:
•
•
•
•
•
•
•
•
•
•
•
For information on how to perform these operations, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
Subscriber Functions
Subscribers have complete access to the Control Panel in Prime Home and can perform the following operations:
•
•
•
For information on how to perform these operations, see the Cisco Prime Home 5.0.1 User Guide at http://www.cisco.com/en/US/products/ps12589/products_user_guide_list.html.
6 Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service. Cisco currently supports RSS Version 2.0.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
© 2012 Cisco Systems, Inc. All rights reserved.
