Skip to content
This repository has been archived by the owner on Feb 27, 2020. It is now read-only.

Commit

Permalink
Merge pull request #76 from Metaswitch/trusty
Browse files Browse the repository at this point in the history
[Reviewer: Alex] 14.04 updates
  • Loading branch information
rkd-msw committed Jul 3, 2015
2 parents 5d7e79d + 929a307 commit 165b55a
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 139 deletions.
2 changes: 1 addition & 1 deletion docs/All_in_one_EC2_AMI_Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To launch the node
* From the EC2 console, make sure you're in the US East region, then select "Instances", "Launch instance" and then "Classic Wizard"
* Select the "Community AMIs" tab, and search for "Clearwater"
* Press "Select" for the Clearwater all-in-one AMI. Take the most recent version unless you have a good reason not to.
* Choose the Instance Type you require (the node runs fine for basic functional testing on an m1.small)
* Choose the Instance Type you require (the node runs fine for basic functional testing on an t2.small)
* From the remaining pages of parameters, the only ones that need to be set are Name (give the node whatever convenient name you wish), keypair and security group.

On the last page, press "Launch", and wait for the node to be started by EC2.
Expand Down
6 changes: 3 additions & 3 deletions docs/All_in_one_Images.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This page describes the all-in-one images, their capabilities and restrictions a

All-in-one images consist of

* Ubuntu 12.04, configured to use DHCP
* Ubuntu 14.04, configured to use DHCP
* bono, sprout, homestead, homer and ellis
* Clearwater auto-configuration scripts.

On boot, the image retrieves its IP configuration over DHCP and the auto-configuration scripts then configure the bono, sprout, homestead, homer and ellis software to match.

The image is designed to run on a virtual machine with a single core, 1.7GB RAM and 8GB of disk space. On EC2, this is an m1.small.
The image is designed to run on a virtual machine with a single core, 2GB RAM and 8GB of disk space. On EC2, this is an t2.small.

## Capabilities and Restrictions

Expand All @@ -38,7 +38,7 @@ All-in-one images can be installed on EC2 or on your own virtualization platform

If your virtualization platform is not EC2 and doesn't support OVF, you may still be able to manually build an all-in-one node. To do so,

1. install [Ubuntu 12.04 - 64bit server edition](http://releases.ubuntu.com/precise/)
1. install [Ubuntu 14.04 - 64bit server edition](http://releases.ubuntu.com/trusty/)
2. find the `preseed/late_command` entry in the [all-in-one image's install script](https://github.com/Metaswitch/clearwater-vm-images/blob/master/ubuntu-ovf/ubuntu-server.seed) - as of writing this is as follows, but please check the linked file for the latest version

d-i preseed/late_command string in-target bash -c '{ echo "#!/bin/bash" ; \
Expand Down
23 changes: 0 additions & 23 deletions docs/Configuring_MMonit.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/Installation_Instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ These pages will guide you through installing a Clearwater deployment from scrat

3. A manual install, using Debian packages and hand configuring each machine. This is the recommended method if chef is not supported on your virtualization platform or your DNS is not provided by Amazon's Route53.

This install can be performed on any collection of machines (at least 5 are needed) running Ubuntu 12.04 as it makes no assumptions about the environment in which the machines are running. On the other hand, it requires manually configuring every machine, firewalls and DNS entries, meaning it is not a good choice for spinning up a large-scale deployment.
This install can be performed on any collection of machines (at least 5 are needed) running Ubuntu 14.04 as it makes no assumptions about the environment in which the machines are running. On the other hand, it requires manually configuring every machine, firewalls and DNS entries, meaning it is not a good choice for spinning up a large-scale deployment.

4. Installing from source. If you are running on a non-Ubuntu-based OS, or need to test a code fix or enhancement you've made, you can also install Clearwater from source, building the code yourself. Per-component instructions are provided that cover the route from source code to running services. Familiarity with performing a manual install on Ubuntu will help with configuring your network correctly after the software is installed.

Expand All @@ -26,7 +26,7 @@ These pages will guide you through installing a Clearwater deployment from scrat

The installation process for a full Clearwater deployment (i.e. not an all-in-one) can be described at a high level as follows:

* Sourcing enough machines to host the deployment (minimum is 6) and installing an OS on them all. [Ubuntu 12.04](http://releases.ubuntu.com/precise/) is the recommended and tested OS for hosting Clearwater.
* Sourcing enough machines to host the deployment (minimum is 6) and installing an OS on them all. [Ubuntu 14.04](http://releases.ubuntu.com/trusty/) is the recommended and tested OS for hosting Clearwater.
* Preparing each machine to allow installation of the Clearwater software.
* Installing the Clearwater software onto the machines.
* Configuring firewalls to allow the various machines to talk to each other as required.
Expand Down
4 changes: 2 additions & 2 deletions docs/Manual_Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ These instructions will take you through installing a minimal Clearwater system

Before starting this process you will need the following:

* Six machines running clean installs of [Ubuntu 12.04 - 64bit server edition](http://releases.ubuntu.com/precise/).
* The software has been tested on Amazon EC2 `m1.small` instances, so any machines at least as powerful as one of them will be sufficient.
* Six machines running clean installs of [Ubuntu 14.04 - 64bit server edition](http://releases.ubuntu.com/trusty/).
* The software has been tested on Amazon EC2 `t2.small` instances, so any machines at least as powerful as one of them will be sufficient.
* Each machine will take on a separate role in the final deployment. The system requirements for each role are the same thus the allocation of roles to machines can be arbitrary.
* The firewalls of these devices must be independently configurable. This may require some attention when commissioning the machines. For example, in Amazon's EC2, they should all be created in separate security groups.
* On Amazon EC2, we've tested both within a [VPC](http://aws.amazon.com/vpc/) and without. If using a VPC, we recommend using the "VPC with a Single Public Subnet" model (in the "VPC Wizard") as this is simplest.
Expand Down
4 changes: 2 additions & 2 deletions docs/Multiple_Network_Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You will need to determine the IP configuration for your second network, includi

### Preparing the network

Due to the varied complexities of IP networking, it would be impractical to attempt to automate configuring the Linux-level view of the various networks. Network namespaces are created and managed using the `ip netns` tool, which is a standard part of Ubuntu 12.04.
Due to the varied complexities of IP networking, it would be impractical to attempt to automate configuring the Linux-level view of the various networks. Network namespaces are created and managed using the `ip netns` tool, which is a standard part of Ubuntu 14.04.

The following example commands (when run as root) create a network namespace, move `eth1` into it, configure a static IP address and configure routing.

Expand All @@ -64,7 +64,7 @@ The following example commands (when run as root) create a network namespace, mo

Obviously you should make any appropriate changes to the above to correctly configure your chosen signalling network. These changes are **not** persisted across reboots on Linux and you should ensure that these are run on boot before the `clearwater-infrastructure` service is run. A sensible place to configure this would be in `/etc/rc.local`.

Finally, you should create `/etc/netns/signalling/resolv.conf` configuring the DNS server you'd like to use on the signalling network. The format of this file is documented at <http://manpages.ubuntu.com/manpages/precise/man5/resolv.conf.5.html> but a simple example file might just contain the following.
Finally, you should create `/etc/netns/signalling/resolv.conf` configuring the DNS server you'd like to use on the signalling network. The format of this file is documented at <http://manpages.ubuntu.com/manpages/trusty/man5/resolv.conf.5.html> but a simple example file might just contain the following.

nameserver <DNS IP address>

Expand Down
4 changes: 2 additions & 2 deletions docs/Old_Manual_Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ These instructions will take you through installing a minimal Clearwater system

Before starting this process you will need the following:

* Six machines running clean installs of [Ubuntu 12.04 - 64bit server edition](http://releases.ubuntu.com/precise/).
* The software has been tested on Amazon EC2 `m1.small` instances, so any machines at least as powerful as one of them will be sufficient.
* Six machines running clean installs of [Ubuntu 14.04 - 64bit server edition](http://releases.ubuntu.com/trusty/).
* The software has been tested on Amazon EC2 `t2.small` instances, so any machines at least as powerful as one of them will be sufficient.
* Each machine will take on a separate role in the final deployment. The system requirements for each role are the same thus the allocation of roles to machines can be arbitrary.
* The firewalls of these devices must be independently configurable. This may require some attention when commissioning the machines. For example, in Amazon's EC2, they should all be created in separate security groups.
* On Amazon EC2, we've tested both within a [VPC](http://aws.amazon.com/vpc/) and without. If using a VPC, we recommend using the "VPC with a Single Public Subnet" model (in the "VPC Wizard") as this is simplest.
Expand Down
102 changes: 0 additions & 102 deletions docs/Plivo.md

This file was deleted.

2 changes: 0 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,9 @@ pages:
- ['Clearwater_IP_Port_Usage.md', 'Integration', 'Clearwater Firewall Configuration']
- ['Clearwater_DNS_Usage.md', 'Integration', 'Clearwater DNS Usage']
- ['ENUM.md', 'Integration', 'ENUM']
- ['Plivo.md', 'Integration', 'Plivo']
- ['Voxbone.md', 'Integration', 'Voxbone']
- ['Clearwater_SNMP_Statistics.md', 'Integration', 'Clearwater SNMP Statistics']
- ['SNMP_Alarms.md', 'Integration', 'SNMP Alarms']
- ['Configuring_MMonit.md', 'Integration', 'Configuring M/Monit']

# Features:
- ['Application_Server_Guide.md', 'Features', 'Application Server Guide']
Expand Down

0 comments on commit 165b55a

Please sign in to comment.