seesaw: Initial check in.

.gitignore

@@ -0,0 +1,2 @@
+syntax:glob
+*.pb.go

CONTRIBUTING

@@ -0,0 +1,8 @@
+You are welcome to contribute to the Seesaw v2 open source code.
+
+However, before we can accept any contributions, you will need to sign the
+appropriate contributor license agreement:
+
+  https://developers.google.com/open-source/cla/individual
+  https://developers.google.com/open-source/cla/corporate
+

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,23 @@
+all: proto
+	go build ./...
+
+install: all
+	go install github.com/google/seesaw/binaries/seesaw_cli
+	go install github.com/google/seesaw/binaries/seesaw_ecu
+	go install github.com/google/seesaw/binaries/seesaw_engine
+	go install github.com/google/seesaw/binaries/seesaw_ha
+	go install github.com/google/seesaw/binaries/seesaw_healthcheck
+	go install github.com/google/seesaw/binaries/seesaw_ncc
+	go install github.com/google/seesaw/binaries/seesaw_watchdog
+
+install-test-tools: all
+	go install github.com/google/seesaw/test_tools/healthcheck_test_tool
+	go install github.com/google/seesaw/test_tools/ipvs_test_tool
+	go install github.com/google/seesaw/test_tools/ncc_test_tool
+	go install github.com/google/seesaw/test_tools/quagga_test_tool
+
+proto:
+	protoc --go_out=. pb/config/config.proto
+
+test: all
+	go test ./...

README

@@ -0,0 +1,153 @@
+= Seesaw v2 =
+
+Note: This is not an official Google product.
+
+== About ==
+
+Seesaw v2 is a Linux Virtual Server (LVS) based load balancing platform.
+
+It is capable of providing basic load balancing for servers that are on the
+same network, through to advanced load balancing functionality such as anycast,
+Direct Server Return (DSR), support for multiple VLANs and centralised
+configuration.
+
+Above all, it is designed to be reliable and easy to maintain.
+
+== Requirements ==
+
+A Seesaw v2 load balancing cluster requires two Seesaw nodes - these can be
+physical machines or virtual instances. Each node must have two network
+interfaces - one for the host itself and the other for the cluster VIP. All
+four interfaces should be connected to the same layer 2 network.
+
+== Building ==
+
+Seesaw v2 is developed in Go and depends on several Go packages:
+
+  golang.org/x/crypto/ssh
+  github.com/dlintw/goconf
+  github.com/golang/glog
+  github.com/golang/protobuf/proto
+  github.com/miekg/dns
+
+Additionally, there is a compile and runtime dependency on libnl
+(https://www.infradead.org/~tgr/libnl/) and a compile time dependency on
+the Go protobuf compiler.
+
+On a Debian/Ubuntu style system, you should be able to prepare for building
+by running:
+
+  apt-get install golang
+  apt-get install protobuf-compiler
+  apt-get install libnl-3-dev libnl-genl-3-dev
+
+After setting GOPATH to an appropriate location (for example ~/go):
+
+  go get -u golang.org/x/crypto/ssh
+  go get -u github.com/dlintw/goconf
+  go get -u github.com/golang/glog
+  go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
+  go get -u github.com/miekg/dns
+
+Ensure that ${GOPATH}/bin is in your ${PATH} and in the seesaw directory:
+
+  make test
+  make install
+
+== Installing ==
+
+After 'make install' has run successfully, there should be a number of
+binaries in ${GOPATH}/bin with a 'seesaw_' prefix. Install these to the
+appropriate locations:
+
+  SEESAW_BIN="/usr/local/seesaw"
+  SEESAW_ETC="/etc/seesaw"
+  SEESAW_LOG="/var/log/seesaw"
+
+  install -d "${SEESAW_BIN}" "${SEESAW_ETC}" "${SEESAW_LOG}"
+
+  install "${GOPATH}/bin/seesaw_cli" /usr/bin/seesaw
+
+  for component in {ecu,engine,ha,healthcheck,ncc,watchdog}; do
+    install "${GOPATH}/bin/seesaw_${component}" "${SEESAW_BIN}"
+  done
+
+  install "etc/init/seesaw_watchdog.conf" "/etc/init"
+  install "etc/seesaw/watchdog.cfg" "${SEESAW_ETC}"
+
+  # Enable CAP_NET_RAW for seesaw binaries that require raw sockets.
+  /sbin/setcap cap_net_raw+ep "${SEESAW_BIN}/seesaw_ha"
+  /sbin/setcap cap_net_raw+ep "${SEESAW_BIN}/seesaw_healthcheck"
+
+The setcap binary can be found in the libcap2-bin package on Debian/Ubuntu.
+
+== Configuring ==
+
+Each node needs a /etc/seesaw/seesaw.cfg configuration file, which provides
+information about the node and who its peer is. Additionally, each load
+balancing cluster needs a cluster configuration, which is in the form of a
+text-based protobuf - this is stored in /etc/seesaw/cluster.pb.
+
+An example seesaw.cfg file can be found in etc/seesaw/seesaw.cfg.example - a
+minimal seesaw.cfg provides the following:
+
+  anycast_enabled - True if anycast should be enabled for this cluster.
+  name - The short name of this cluster.
+  node_ipv4 - The IPv4 address of this Seesaw node.
+  peer_ipv4 - The IPv4 address of our peer Seesaw node.
+  vip_ipv4 - The IPv4 address for this cluster VIP.
+
+The VIP floats between the Seesaw nodes and is only active on the current
+master. This address needs to be allocated within the same netblock as both
+the node IP address and peer IP address.
+
+An example cluster.pb file can be found in etc/seesaw/cluster.pb.example - a
+minimal cluster.pb contains a 'seesaw_vip' entry and two 'node' entries. For
+each service that you want to load balance, a separate 'vserver' entry is
+needed, with one or more 'vserver_entry' sections (one per port/proto pair),
+one or more 'backends' and one or more 'healthchecks'. Further information
+is available in the protobuf definition - see pb/config/config.proto.
+
+On an upstart based system, running `restart seesaw_watchdog` will start (or
+restart) the watchdog process, which will in turn start the other components.
+
+=== Anycast ===
+
+Seesaw v2 provides full support for anycast VIPs - that is, it will advertise
+an anycast VIP when it becomes available and will withdraw the anycast VIP if
+it becomes unavailable. For this to work the Quagga BGP daemon needs to be
+installed and configured, with the BGP peers accepting host-specific routes
+that are advertised from the Seesaw nodes within the anycast range (currently
+hardcoded as 192.168.255.0/24).
+
+== Command Line ==
+
+Once initial configuration has been performed and the Seesaw components are
+running, the state of the Seesaw can be viewed and controlled via the Seesaw
+command line interface. Running `seesaw` (assuming /usr/bin is in your path)
+will give you an interactive prompt - type '?' for a list of top level
+commands. A quick summary:
+
+  config reload - reload the cluster.pb from the current config source.
+
+  failover - failover between the Seesaw nodes.
+
+  show vservers - list all vservers configured on this cluster.
+
+  show vserver <name> - show the current state for the named vserver.
+
+== Troubleshooting ==
+
+A Seesaw should have five components that are running under the watchdog - the
+process table should show processes for:
+
+  seesaw_ecu
+  seesaw_engine
+  seesaw_ha
+  seesaw_healthcheck
+  seesaw_ncc
+  seesaw_watchdog
+
+All Seesaw v2 components have their own logs, in addition to the logging
+provided by the watchdog. If any of the processes are not running, check the
+corresponding logs in /var/log/seesaw - for example seesaw_engine.{log,INFO}.