Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sfuhrm/docker-opendaylight

OpenDaylight SDN controller Docker image infrastructure
https://github.com/sfuhrm/docker-opendaylight

bgp docker docker-image dockerfile karaf-cli netconf network opendaylight opendaylight-controller opendaylight-instance openflow openflow-controller ovsdb restconf sdn sdn-controller snmp ssh

Last synced: about 2 months ago
JSON representation

OpenDaylight SDN controller Docker image infrastructure

Host: GitHub
URL: https://github.com/sfuhrm/docker-opendaylight
Owner: sfuhrm
License: apache-2.0
Created: 2020-11-20T22:13:48.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2022-01-14T14:06:11.000Z (almost 3 years ago)
Last Synced: 2024-04-19T22:49:04.150Z (8 months ago)
Topics: bgp, docker, docker-image, dockerfile, karaf-cli, netconf, network, opendaylight, opendaylight-controller, opendaylight-instance, openflow, openflow-controller, ovsdb, restconf, sdn, sdn-controller, snmp, ssh
Language: Shell
Homepage:
Size: 87.9 KB
Stars: 10
Watchers: 2
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# OpenDaylight controller Docker image

[![Docker Image CI](https://github.com/sfuhrm/docker-opendaylight/actions/workflows/docker-image.yml/badge.svg)](https://github.com/sfuhrm/docker-opendaylight/actions/workflows/docker-image.yml)
[![](https://img.shields.io/docker/pulls/stephanfuhrmannionos/opendaylight?style=plastic)](https://hub.docker.com/r/stephanfuhrmannionos/opendaylight)
[![](https://img.shields.io/docker/image-size/stephanfuhrmannionos/opendaylight/latest?style=plastic)](https://hub.docker.com/r/stephanfuhrmannionos/opendaylight)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

This repository is no longer worked on and is now read-only. There is no more maintenance or support for this repository.

OpenDaylight is a SDN controller. It can be used to control and orchestrate a network of switches.

OpenDaylight supports many southbound protocols and can be integrated in Openstack or even Kubernetes.

## What's inside

- A ready-to-use OpenDaylight instance that will start up as a server. Multiple OpenDaylight versions are provided as tags.
- The images are based on [`openjdk:11-jre-slim-buster`](https://hub.docker.com/_/openjdk) for OpenDaylight 10+ and `openjdk:8-jre-slim-buster` for older versions.
- No features are installed (you can install modules at boot time by setting the [`KARAF_FEATURES`](#customization-via-env-variables) env variable).
- Exposed TCP ports:
- 6633 Openflow,
- 8101 Karaf CLI via SSH (see below),
- 8181 RESTCONF / HTTP

## How to use it

A typical use-case will be starting docker with several environment variables to prepare the container in a way that you have a readily
configured OpenDaylight instance with the features you need.

### Run the container

`docker run -d -p 6633:6633 -p 8101:8101 -p 8181:8181 --name=opendaylight stephanfuhrmannionos/opendaylight`

### Access OpenDaylight Karaf CLI

#### Using SSH

To access the Karaf CLI, issue the command

`ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -p 8101 karaf@localhost`

The default SSH credentials are:

- Username: `karaf`
- Password: `karaf`

Note: `StrictHostKeyChecking` and `UserKnownHostsFile` file is turned off because different container invocations will have different host keys.

#### Using Docker

An interactive Karaf shell can also be spawned with the following command line:

```bash
docker exec -ti opendaylight bin/client
```

where `opendaylight` is the name of the running container.

## Customization via ENV variables

The following environment variables can be set to customize the started
server:

| Variable | Default | Possible Values | |
|-------------------------|-----------|------------------|---|
| `KARAF_INTERACTIVE` | `0` | `0`,`1` | Set to `1` to run Karaf interactive, meaning that the docker instance will be interactive. As an alternative, you can connect in a running server instance using `docker exec -ti opendaylight /odl/bin/client` |
| `KARAF_FEATURES` | | string | Comma separated features to load on boot of OpenDaylight. Example: `odl-yangtools-parser,odl-yangtools-parser-api` |
| `KARAF_USER` | `karaf` | string | The user name of the Karaf service. |
| `KARAF_PASSWORD` | `karaf` | string | The password of the Karaf service. |
| `ODL_LOGLEVEL` | `INFO` | `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` | The log level to log runtime information to the Docker console with. |
| `ODL_ADMIN_PASSWORD` | `admin` | string | The password of the AAA admin user. |

Example:

```bash
docker run -e KARAF_USER=michael -e KARAF_PASSWORD=knight -p 6633:6633 -p 8101:8101 -p 8181:8181 --name=opendaylight stephanfuhrmannionos/opendaylight:latest
```

## Supported tags

- latest
- 15.1.0
- 15.0.0
- 14.3.0
- 14.2.0
- 14.1.0
- 14.0.0
- 0.13.3
- 0.13.2
- 0.13.1
- 0.13.0
- 0.12.2
- 0.12.1
- 0.12.0
- 0.11.4
- 0.11.3
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.4
- 0.8.3
- 0.8.2
- 0.8.1
- 0.8.0

## Relevant links

The sites relevant for this docker image:

- [Github docker-opendaylight](https://github.com/sfuhrm/docker-opendaylight): The Github repository.
- [The Docker Hub repository with version specific images](https://hub.docker.com/r/stephanfuhrmannionos/opendaylight)