====== Administration: Cluster and Cluster Group Management ======
Author: Anna Dowling

  * In the Noc Portal, we have the concept of clusters and cluster groups. Explanations of these domain objects are available in the section: [[onboarding:nocportal:object_model_-_the_basics|Object model: the basics]]
  * In order to manage these domains in the application, an admin view exists. This contains the controller page for all of the main domain objects associated with the Noc Portal.
  * In order to navigate to the admin view, the logged in user must have the role **Administrator** associated with their account. Once they have this role, they will see the link called **manage account** displayed on the main noc portal view:

{{:onboarding:nocportal:screen_shot_2016-08-09_at_12.35.56.png|}}

  * Once the user clicks this link they will be taken to the following view:
{{:onboarding:nocportal:screen_shot_2016-08-09_at_12.38.56.png|}}

  * In the list displayed there is a link to the **Cluster Management** view and the **Cluster Group Management** view as demonstrated.
{{:onboarding:nocportal:screen_shot_2016-08-09_at_12.40.39.png?300|}}

  * In order to create a new cluster click the link to **Cluster Management**. The following screen will display:
{{:onboarding:nocportal:screen_shot_2016-08-09_at_12.42.45.png|}}

  * **Click New Cluster.** The following view will display:
{{:onboarding:nocportal:screen_shot_2016-08-09_at_12.44.30.png|}}

  * Fill out all of the required fields:
  * The **Name** will be the name assigned to the cluster
  * **Id In Snmp Manager** represents the actual id of the cluster in the SnmpManager,this should be unique per snmpConfig.
  * **Outage Info** represents the Information on the current outage for this cluster.
  * **Outage** Update Time represents the last updated time on the current outage info.
  * **Radius** represents the search area (surrounding circle on the map) of this cluster
  * **Cc Email Recipients** - email addresses to be copied on all emails for this cluster.
  * **Email Recipients** - email addresses to be sent all emails for this cluster.
  * **Files** - Files uploaded in this cluster.
  * **Neutral Host Cluster** - Boolean to determine whether the cluster should implement neutral host functionality or not.
  * **Snmp Config** - The associated snmp configuration, i.e. database connection for the snmp_manager.

  * Once all relevant fields have been filled out, click **create** to save this entry to the database.

  * In order to create a new cluster group click the link to **Cluster Group Management**. The following screen will display:
{{:onboarding:nocportal:screen_shot_2016-08-09_at_14.39.52.png|}}

  * Click **New ClusterGroup.** The following view will display:
{{:onboarding:nocportal:screen_shot_2016-08-09_at_14.41.12.png|}}

  * Fill out all of the required fields:
  * **Name** represents the name of the cluster group being created.
  * **Cluster Group Type** represents the enum for determining the type of group. This can be one of the following:
    * REGIONAL - Has multiple clusters for a specific region.
    * CARRIER - Has multiple clusters for ONE carrier.
    * SALES - This used for creating on-the-fly ClusterGroups by the end-users (Sales). These groups may be made up of multiple combinations of clusters across multiple carriers if needed.
  * **Snmp Config** - The associated snmp configuration, i.e. database connection for the snmp_manager.

  * Once all relevant fields have been filled out, click **create** to save this entry to the database.

**VERY IMPORTANT**

In order for a user to view a cluster in the noc portal the cluster must be added to their account via admin options> users


----


==== Self-Assessment ====
Follow the steps outlined above to create a cluster and cluster group in the errigal qa environment for the Noc Portal.