Chef cookbook to install and configure exabgp
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.delivery
.github
attributes
libraries
recipes
resources
spec
templates/default
test
.gitignore
.kitchen.dokken.yml
.kitchen.yml
.rspec
.travis.yml
Berksfile
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
Rakefile
TESTING.md
chefignore
metadata.rb

README.md

exabgp cookbook

Installs and configures ExaBGP the swiss-army knife of networking.

DEPRECATION NOTICE

After careful consideration, we are making this the last release of the ExaBGP cookbook as we found implementing implementing simple package, service, and template resources in our internal cookbooks easier and less time consuming than building a complex set of wrappers around ExaBGP's configuration. Supporting pip and source installations is also a lot more maintenance cost than value for very special use cases.

We are leaving this cookbook up for adoption; If anyone wishes to continue supporting it email support@dnsimple.com.

For a basic example of installing and setting up a package based ExaBGP, here is one:

The Chef recipe

package 'exabgp'

template '/etc/exabgp/exabgp.conf' do
  user 'exabgp'
  group 'exabgp'
  variables(my_as: node['mycorp']['as_number'])
  notifies :reload, 'service[exabgp]'
end

cookbook_file '/etc/exabgp/watchdog.sh' do
  user 'exabgp'
  group 'exabgp'
  mode '755'
  notifies :reload, 'service[exabgp]'
end

service 'exabgp' do
  supports reload: true, status: true
  action :nothing
end

The exabgp.conf template

process announce-routes {
	run ./watchdog.sh;
}

neighbor 127.0.0.1 {
	router-id 1.2.3.4;
	local-address 127.0.0.1;
	local-as <%= @my_as %>;
	peer-as 1;
	group-updates false;

	capability {
		graceful-restart;
	}

	api {
		processes [ announce-routes ];
	}
}

The watchdog.sh script:

#!/bin/sh

# ignore Control C
# if the user ^C exabgp we will get that signal too, ignore it and let exabgp send us a SIGTERM
trap '' SIGINT

# command and watchdog name are case sensitive

while `true`;
do

# Let give exabgp the time to setup the BGP session :)
# But we do not have too, exabgp will record the changes and update the routes once up otherwise

sleep 10

# without name exabgp will use the name of the service as watchdog name
echo "withdraw watchdog"
sleep 5

# specify a watchdog name (which may be the same or different each time)
echo "withdraw watchdog watchdog-one"
sleep 5

echo "announce watchdog"
sleep 5

echo "announce watchdog watchdog-one"
sleep 5

# we have no route with that watchdog but it does not matter, we could have after a configuration reload

echo "announce watchdog watchdog-two"
echo "withdraw watchdog watchdog-two"

done

Supported Chef and Platforms

  • Chef 12.6 and newer

  • Ubuntu 14.04 and newer

Dependencies

  • poise-python (for package installation)
  • git (for source installation)

Attributes

Attribute Description Default Value
node['exabgp']['package_version'] Version of the python package to install 3.4.19
node['exabgp']['bin_path'] Location of the ExaBGP binary, only set on source installations /usr/sec/exabgp/sbin/exabgp
node['exabgp']['config_path'] Location of the ExaBGP configuration file, only set when a resource with instance set to false is configured /etc/exabgp/exabgp.conf
node['exabgp']['source_url'] URL to the git repository for source installtions https://github.com/Exa-Networks/exabgp.git
node['exabgp']['source_version'] git ref of the version to install master

Recipes

  • exabgp::default - Intentionally left blank, see resource usage below

Resources

exabgp

The exabgp resource installs and configures ExaBGP. It does not create an ExaBGP service. You will need to handle this separately via your service resource of choice. If you want an example of such a service setup, look at the test/cookbooks folder for some example recipes.

Actions

  • :install – Install and configure ExaBGP. (default)

Parameters

  • instance – Name of the ExaBGP installation. If different than the name parameter of the resource. If it is set to false, it will not use the name parameter when naming the instance. This is for backward compatibility with the older version of this cookbook where you may be running an install from /etc/exabgp.
  • package_version – Which version of the python package to install, defaults to the node['exabgp']['package_version'] attribute.
  • cookbook – Which cookbook to look for the exabgp.conf.erb template
  • variables – Pass template variables in much like a template resource
  • install_type – Supports three type :package (distribution package), :pip (python package) and :source installations. Defaults to :package . If you'd like to support more installation options, send in a pull request. ❤️

Examples

# Installs into /etc/exabgp-anycast
exabgp 'anycast'

# Backward compatible with the previous exabgp cookbook
# Installs to /etc/exabgp
exabgp 'anycast' do
  instance false
end

# Use your own template from templates/default/exabgp.conf.erb
exabgp 'anycast' do
  cookbook 'mycorp-exabgp'
end

# Setup a service
service 'exabgp'

License and Authors

Copyright:: 2013-2018 DNSimple Corp.

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.