wiki:WikiStart

Migrating to gitlab

Kea project is in the process of migrating to gitlab. If you want to create new tickets, please use gitlab. Apologies for the inconvenience of the migration process, but in the long term the benefits of gitlab will greatly outweight the inconvenience.

DOWNLOAD User's Guide Developer's Guide Mailing lists Problems Roadmap
stable(1.4) / devel(upcoming 1.5) Current / devel(upcoming) devel Users / Developers Known Issues / Defects 1.4 (beta, final), 1.5 (beta, final)

Welcome to the Kea project page. This site is addressed at developers and people familiar with the software and is more project oriented. For an initial introduction and business-oriented webpage, see http://isc.org/kea.

Kea DHCP Server

Kea is an open source DHCPv4/DHCPv6 server being developed by Internet Systems Consortium. Kea is a high-performance, extensible DHCP server engine that is designed to be easily modified and extended with hooks libraries.

Kea is free open source, and we welcome community engagement, via the Kea-users mailing list, this wiki, and our Github repository. There is a small core team of dedicated software engineers developing it and we need your contributions and support contracts to support them.

DHCP Standardization efforts: The lead developer on KEA is co-chair of the Dynamic Host Configuration working group in the IETF. We are committed to providing a standards-compliant implementation and are closely tracking developments in this working group and evaluating them for inclusion in KEA.

Kea News

2018-08-02: Moving to gitlab.isc.org

We are in the process of migrating to a new repository, wiki and issue tracker. This site has served us well, but the software is not well-maintained and many of you have had trouble creating accounts. We want to have a more usable site for community engagement, so we are moving. Please be patient while we are in the midst of this transition. The new repository is already in use for BIND 9 development and we have had a good response from the user community.

We are not quite ready for users yet, but if you would like to preview the new site, it will be at https://gitlab.isc.org/isc-projects/kea.

2018-06-15: Kea 1.4.0 released!

A release of Kea 1.4.0 has been made available. It brings many new features and improves existing ones: high availability, database improvements (better statistics and error handling), expanded client classification (you can now define class restrictions on pool level and use additional operators), much improved Cassandra backend (now with host reservation), RADIUS support and more. For detailed information please check Release Notes.

Tarball package is available on the ISC.org downloads page or ISC ftp server.

2018-02-14: Welcome, Google Summer of Code Interns!

We’re excited that ISC has been selected as one of the participating organizations in this year’s Google Summer of Code GSOC program. We are proposing a number of worthwhile extensions to the Kea project. Suggested projects will help you develop practical experience with C++, user interface design, REST api design and more. Some of these are relatively easy, others quite challenging. Kea has an active user community that is growing fast that you can tap into for requirements and feedback.

Participants have until March 12th to make a proposal. We’d like to help you succeed. If you are interested, please email the development team at kea-dev at lists.isc.org and let us know what project you are thinking of working on. We can point you to examples of existing Kea designs that may help you get started on your proposal.

Kea project ideas: HERE

ISC overview and how to apply GSOC web site

2017-10-27: Kea 1.3.0 released!

Kea 1.3.0 brings an exciting set of new features: shared networks, improvements in REST API interface, new commands for leases, subnets and shared networks management, many new DHCPv4 and DHCPv6 options, ability to specify options on IPv4 pool level and much more. For detailed information please check Release Notes.

Tarball package is available on the ISC.org downloads page or ISC ftp server.

Kea is distributed under the MPL2.0 open source license.

Some ideas for Kea - running list of items to be done in the future

Performance

Kea is a high performance server. Performance details will be published soon.

To assess server performance, ISC has developed perfdhcp, a tool that is able to simulate thousands of clients and assess server responses.

Installation

See Install page for details, including packages list and installation from sources.

Collaboration

Contact us via the Kea mailing list if you think you might be interested in working on Kea and sharing that work with the community. We have a Github site for working on technical contributions. We are a small team, so please be patient - it may take us a while to code-review unexpected contributions.

The primary things we need are:

  • Test coverage in different environments, with a variety of clients
  • Applications based on the Kea API, both to validate the API and to demonstrate the potential for DHCP applications.
  • Detailed, specific requirements for new functionality

Current collaborators

The best way to see who is currently contributing to Kea is to check the Github repo. Here are some of the early contributors:

How to participate in this project

1) Subscribe to the Kea developers mailing list.

2) Read the User Guide (sections 16,17,18 and 19) and the Developer's Guide.

3) Download and build a KEA instance. Released, supported versions are available here and on the ISC web site. For the latest KEA code, please use our public GIT repository.

4) Give us feedback via the mailing list or submit a bug (sub-project=dhcp). See below for information about the known issues.

5) A description of the workflow can be found here Kea Git Workflow


Documentation

  • Installation and system specific notes for building Kea.
  • User Guide - we do have two versions. (Stable) documents the latest stable release. (Development snapshot) documents the latest git version and is rebuilt daily.
  • Documentation - a directory with documentation (User's Guide, list of all messages Kea can print and more).
  • Developer's Guide - addressed at developers and contributors. This is regenerated daily.
  • Designs - see how existing and upcoming features will look like. MIGRATION IN PROCESS
  • Commands - Planned and currently supported Kea commands (available through REST API or control channel). MIGRATED
  • Available hooks - this is a list of hook libraries, both from ISC and third parties. NOT planning to migrate, rely on documentation for ISC hooks, use community tools for non-ISC hooks
  • Host reservations howto - Tips for using Host Reservations in Kea 1.1.0, especially with MySQL.
  • Kea coding guidelines - Please read those before you start writing code. MIGRATED

Known Issues

  • Known Issues - This is a list of known issues with the current and previous releases MIGRATED
  • Outstanding tasks - this is a list of tasks that we are planning to do. Sometimes the difference between a bug and a missing feature is thin. NOT PLANNING TO MIGRATE
  • Submit new bug - setting the milestone as Kea-proposed is appreciated. NOT planning to migrate - obvious on Gitlab
  • Known System Issues - list of all detected issues related to specific system configuration.
  • Our milestones - list of all milestones. KeaX.Y milestones contain the tickets we're planning to do in specific releases. Usually only the current milestone is up to date. Future milestones tend to fluctuate a bit. NOT PLANNING TO MIGRATE

Testing

Getting in touch

Last modified 4 days ago Last modified on Aug 14, 2018, 3:54:46 PM

Attachments (1)

Download all attachments as: .zip