getting-started.md

Getting Started with Pola PCE

This page explains how to use Pola PCE.

Instllation

From Go Package

$ go install github.com/nttcom/pola/cmd/polad@latest

From Source

Getting the Source

$ git clone https://github.com/nttcom/pola.git

Build & install

$ cd pola
$ go install ./cmd/polad

# or, install with cli command
$ go install ./...

From Container Image

See the Docker page.

Configuration

Specify the IP address and port number for each PCEP and gRPC. See JSON shema for config details.

case: TED disable

To manage SR Policy without using TED.

global:
  pcep:
    address: "2001:0db8::254"
    port: 4189
  grpc-server:
    address: "127.0.0.1"
    port: 50051
  log:
    path: "/var/log/pola/"
    name: "polad.log"
  ted:
    enable: false
  usid-mode: false

case: TED enable

To manage SR Policy using TED. Enabling TED allows dynamic path calculation.

A specific tool for updating TED is required to use this feature. Currently, only GoBGP is supported.

Not currently available for IPv6 underlay(IPv6 SR-MPLS / SRv6).

global:
  pcep:
    address: "192.0.2.254"
    port: 4189
  grpc-server:
    address: "127.0.0.1"
    port: 50052
  log:
    path: "/var/log/pola/"
    name: "polad.log"
  ted:
    enable: true
    source: "gobgp"
  gobgp:
    grpc-client:
      address: "127.0.0.1"
      port: 50051

Configure GoBGP as follows to enable BGP-LS.

global:
  config:
    as: 65000
    router-id: 10.255.0.254
neighbors:
- config:
    neighbor-address: 10.100.0.1
    peer-as: 65000
  transport:
    config:
      local-address: 10.100.0.254
  afi-safis:
  - config:
      afi-safi-name: ls

Run Pola PCE using polad

Start polad. Specify the created configuration file with the -f option.

$ sudo polad -f polad.yaml
2022-06-05T22:57:59.823Z        info    gRPC listen     {"listenInfo": "127.0.0.1:50052", "server": "grpc"}
2022-06-05T22:57:59.823Z        info    PCEP listen     {"listenInfo": "192.0.2.254:4189"}

After Polad is running, use pola cmd or the gRCP client for daemon operations