Getting Started ¶

Table of Contents

Getting Started

Overview ¶

The YANG Development Kit (YDK) is a Software Development Kit that provides API’s that are modeled in YANG. The main goal of YDK is to reduce the learning curve of YANG data models by expressing the model semantics in an API and abstracting protocol/encoding details. YDK is composed of a core package that defines services and providers, plus one or more module bundles that are based on YANG models.

Docker ¶

A docker image is automatically built with the latest ydk-go installed. This be used to run ydk-go without installing anything natively on your machine.

To use the docker image, install docker on your system and run the below command. See the docker documentation for more details:

docker run -it ydkdev/ydk-go

System Requirements ¶

Linux ¶

Ubuntu (Debian-based)

The following packages must be present in your system before installing YDK-Go:

Install Third-party software dependencies:

sudo apt-get install gdebi-core python3-dev python-dev libtool-bin
sudo apt-get install libcurl4-openssl-dev libpcre3-dev libssh-dev libxml2-dev libxslt1-dev cmake

For Xenial (Ubuntu 16.04.4):

  # Upgrade compiler to gcc 5.*
sudo apt-get install gcc-5 g++-5 -y > /dev/null
sudo ln -sf /usr/bin/gcc-5 /usr/bin/cc
sudo ln -sf /usr/bin/g++-5 /usr/bin/c++

  # Install YDK core library
wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.4/xenial/libydk-0.8.4-1.amd64.deb
sudo gdebi libydk-0.8.4-1.amd64.deb

For Bionic (Ubuntu 18.04.1):

  # Install YDK core library
wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.4/bionic/libydk-0.8.4-1.amd64.deb
sudo gdebi libydk-0.8.4-1.amd64.deb

Centos (Fedora-based)

The following packages must be present in your system before installing YDK-Go:

sudo yum install epel-release
sudo yum install libxml2-devel libxslt-devel libssh-devel libtool gcc-c++ pcre-devel cmake

  # Upgrade compiler to gcc 5.*
yum install centos-release-scl -y > /dev/null
yum install devtoolset-4-gcc* -y > /dev/null
ln -sf /opt/rh/devtoolset-4/root/usr/bin/gcc /usr/bin/cc
ln -sf /opt/rh/devtoolset-4/root/usr/bin/g++ /usr/bin/c++

  # Install YDK core library
sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.4/libydk-0.8.4-1.x86_64.rpm

Golang

The YDK requires Go version 1.9 or higher. If this is not the case, follow these installation steps:

sudo wget https://storage.googleapis.com/golang/go1.9.2.linux-amd64.tar.gz &> /dev/null
sudo tar -zxf  go1.9.2.linux-amd64.tar.gz -C /usr/local/
export GOROOT="/usr/local/go"
export PATH=$GOROOT/bin:$PATH

For security reasons starting from Go version 1.10 only a limited set of flags is allowed in the CGO code, notably -D, -I, and -l. Current ydk-go code includes few additional CGO LDFLAGS flags in order to allow coverage testing; they are: “-fprofile-arcs -ftest-coverage –coverage”. In order to allow these additional flags to be used, it is necessary to set environment variable CGO_LDFLAGS_ALLOW before running ydk-go based application:

export CGO_LDFLAGS_ALLOW="-fprofile-arcs|-ftest-coverage|--coverage"

Mac ¶

It is recommended to install homebrew and Xcode command line tools on your system before installing YDK-Go:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install pkg-config libssh libxml2 xml2 curl pcre cmake
xcode-select --install

# Install YDK core library
curl -O https://devhub.cisco.com/artifactory/osx-ydk/0.8.4/libydk-0.8.4-Darwin.pkg
sudo installer -pkg libydk-0.8.4-Darwin.pkg -target /

The YDK requires Go version 1.9 or higher. If this is not the case, follow these installation steps:

export CGO_ENABLED=0
export GOROOT_BOOTSTRAP=$GOROOT
gvm install go1.9.2

wget https://github.com/google/protobuf/releases/download/v3.5.0/protobuf-cpp-3.5.0.zip
unzip protobuf-cpp-3.5.0.zip
cd protobuf-3.5.0
./configure
make
sudo make install
sudo ldconfig
cd -

Install gRPC ¶

git clone -b v1.9.1 https://github.com/grpc/grpc
cd grpc
git submodule update --init
sudo ldconfig
make
sudo make install
cd -

Instal YDK gNMI library ¶

Ubuntu ¶

For Xenial (Ubuntu 16.04.4):

wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.4/xenial/libydk_gnmi-0.4.0-4.amd64.deb
sudo gdebi libydk_gnmi-0.4.0-4.amd64.deb

For Bionic (Ubuntu 18.04.1):

wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.4/bionic/libydk_gnmi-0.4.0-4.amd64.deb
sudo gdebi libydk_gnmi-0.4.0-4.amd64.deb

CentOS ¶

sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.4/libydk_gnmi-0.4.0-4.x86_64.rpm

MacOS ¶

curl -O https://devhub.cisco.com/artifactory/osx-ydk/0.8.4/libydk_gnmi-0.4.0-4.Darwin.pkg
sudo installer -pkg libydk_gnmi-0.4.0-4.Darwin.pkg -target /

Set runtime environment ¶

The YDK based application runtime environment must include setting of LD_LIBRARY_PATH variable:

PROTO="/Your-Protobuf-and-Grpc-installation-directory"
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PROTO/grpc/libs/opt:$PROTO/protobuf-3.5.0/src/.libs:/usr/local/lib64

How to install YDK-Go ¶

You can install YDK-Go on macOS or Linux. It is not currently supported on Windows.

To check out the version of ydk-gen used to generate this ydk-go, use the below commands:

git clone repo-url
git checkout commit-id

Documentation and Support ¶

Read the API documentation for details on how to use the API and specific models
Samples can be found under the samples directory
Additional samples can be found in the YDK-Go samples repository (coming soon)
Join the YDK community to connect with other users and with the makers of YDK
Additional YDK information can be found at ydk.io

Release Notes ¶

The current YDK release version is 0.8.4. YDK-Go is licensed under the Apache 2.0 License.