deb/README.markdown

   1 # OpenDaylight Debian Packages
   2
   3 Logic for building OpenDaylight's upstream Debian packages.
   4
   5 #### Table of Contents
   6 1. [Overview](#overview)
   7 1. [Vagrant Build Environment](#vagrant-build-environment)
   8 1. [Building Debs](#building-debs)
   9 1. [Defining New Debs](#defining-new-debs)
  10   * [Deb Build Variables](#deb-build-variables)
  11 1. [Using Debs](#using-debs)
  12   * [Installing](#installing)
  13   * [Uninstalling](#uninstalling)
  14 1. [Using systemd](#using-systemd)
  15   * [Starting](#starting)
  16   * [Stopping](#stopping)
  17 1. [Karaf shell](#karaf-)
  18
  19 ## Overview
  20
  21 TODO: Overview of Debian pkg builds, plans
  22
  23 ## Vagrant Build Environment
  24
  25 Deb builds can be done in the included Vagrantfile. It provides a
  26 consistent, known-working and easily shared environment.
  27
  28     [~/packaging/deb]$ vagrant status
  29     Current machine states:
  30
  31     default                   not created (libvirt)
  32     [~/packaging/deb]$ vagrant up
  33     [~/packaging/deb]$ vagrant ssh
  34     [vagrant@localhost vagrant]$ # Do .deb build
  35
  36 ## Building Debs
  37
  38 TODO: Docs about how to build .debs in the Vagrant env
  39
  40 ## Defining New Debs
  41
  42 NB: Functionality under construction
  43 TODO: Docs about how to define debs for new ODL versions
  44
  45 ### Deb Build Variables
  46
  47 NB: Functionality under construction
  48 TODO: More of these var defs as vars added
  49
  50 #### `TODO: Var name`
  51
  52 TODO: Description
  53
  54 ## Using Debs
  55
  56 The familiar Deb-related commands apply to OpenDaylight's Debs.
  57
  58 ### Installing
  59
  60 TODO: Docs about how to install .deb once it's built locally
  61
  62 ### Uninstalling
  63
  64 TODO: Docs about how to uninstall .deb
  65
  66 ## Using systemd
  67
  68 OpenDaylight's debs ship with systemd support.
  69
  70 ### Starting
  71
  72 TODO: Docs about starting ODL's systemd service, that it's enabled
  73
  74 ### Stopping
  75
  76 TODO: Docs about stopping ODL's systemd service
  77
  78 ## Karaf shell
  79
  80 A few seconds after OpenDaylight is started, its Karaf shell will be accessible.
  81
  82 You can connect by SSHing into ODL's karaf port and logging in (karaf/karaf).
  83
  84     [vagrant@localhost vagrant]$ ssh -p 8101 karaf@localhost
  85     Password authentication
  86     Password:
  87
  88         ________                       ________                .__  .__       .__     __
  89         \_____  \ ______   ____   ____ \______ \ _____  ___.__.|  | |__| ____ |  |___/  |
  90          /   |   \\____ \_/ __ \ /    \ |    |  \\__  \<   |  ||  | |  |/ ___\|  |  \   __\
  91         /    |    \  |_> >  ___/|   |  \|    `   \/ __ \\___  ||  |_|  / /_/  >   Y  \  |
  92         \_______  /   __/ \___  >___|  /_______  (____  / ____||____/__\___  /|___|  /__|
  93                 \/|__|        \/     \/        \/     \/\/            /_____/      \/
  94
  95
  96     Hit '<tab>' for a list of available commands
  97     and '[cmd] --help' for help on a specific command.
  98     Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown OpenDaylight.
  99
 100     opendaylight-user@root>