Advanced OSM installation procedures

From OSM Public Wiki
Jump to: navigation, search

Installer commands

Usage:

./install_osm.sh [OPTIONS]

With no options, it will install OSM from binaries.

Options:

    --uninstall:    uninstall OSM: remove the containers and delete NAT rules
    --source:       install OSM from source code using the latest stable tag
    -r <repo>:      use specified repository name for osm packages
    -R <release>:   use specified release for osm binaries (deb packages, lxd images, ...)
    -u <repo base>: use specified repository url for osm packages
    -k <repo key>:  use specified repository public key url
    -b <refspec>:   install OSM from source code using a specific branch (master, v2.0, ...) or tag
                    -b master          (main dev branch)
                    -b v2.0            (v2.0 branch)
                    -b tags/v1.1.0     (a specific tag)
                    ...
    --lxdimages:    download lxd images from OSM repository instead of creating them from scratch
    -l <lxd_repo>:  use specified repository url for lxd images
    -p <path>:      use specified repository path for lxd images
    --lightweight:  install lightweight build of OSM (default installation)
    --soui:         install classic build of OSM (Rel THREE v3.1, based on LXD containers, with SO and UI)
    --vimemu:       additionally deploy the VIM emulator as a docker container
    --elk_stack:    additionally deploy an ELK docker stack for event logging
    --pm_stack:     additionally deploy a Prometheus+Grafana stack for performance monitoring (PM)
    -o <ADDON>:     do not install OSM, but ONLY one of the addons (vimemu, elk_stack, pm_stack) (assumes OSM is already installed)
    --develop:      (deprecated, use '-b master') install OSM from source code using the master branch
    --nat:          install only NAT rules
    --noconfigure:  DO NOT install osmclient, DO NOT install NAT rules, DO NOT configure modules
    --showopts:     print chosen options and exit (only for debugging)
    -y:             do not prompt for confirmation, assumes yes
    -D <devops path> use local devops installation path
    -h / --help:    prints help