Yang Suite – Nextra

Cisco YANG Suite

The Cisco YANG Suite is a core Django application designed for managing YANG models. It facilitates dynamic discovery of installed application plugins, offering common library APIs for various functionalities such as logging, filesystem access, GUI appearance and behavior, and client-server communication.

Authors:

Developed by members of the Cisco YANG Suite development team.

Supported Python Versions:

Python 3.6, Python 3.7, and Python 3.8

Installation:

YANG Suite can be installed either as a Docker container or through Python package management. The recommended method is using Docker-compose.

Docker Installation:
- Prerequisites: Docker & Docker Compose
- Security: HTTPS
- GUI Ports: Port 80 forwarded to 8443
- Telemetry Ports: 57344 - 57345
- Quick Start:
```
git clone https://github.com/CiscoDevNet/yangsuite
cd yangsuite/docker/
bash ./start_yang_suite.sh
```
  or
```
cd yangsuite/docker/
docker-compose up
```

Resources:

YANG Suite TDM PDF:

This comprehensive PDF document contains technical details about the YANG Suite tool, covering installation, setup, and usage of all plugins and features.

Customization:

Modify the production.py file in yangsuite/docker/yangsuite/ for Django settings.
Plugins can be added/updated through the Admin --> Manage plugins page or by copying the plugin wheels into the yangsuite/docker/yangsuite/ directory.

Access YANG Suite Docker Install with Web Browser:

Access the tool at http://localhost (opens in a new tab) or https://localhost:8443 (opens in a new tab).
Note: A warning about the certificate might appear if it was generated using "start_yang_suite.sh".

Docker Installation Details:

The start_yang_suite.sh script prompts for username, password, and email for the superuser.
Test SSL/TLS certificates can be generated for convenience.
For official use, obtain and copy SSL/TLS certificates to the yangsuite/docker/nginx directory.
Customize ports as needed in the docker-compose.yml and nginx.conf files.

Login:

Use the username set during the installation process.

Sure, here's the continuation:

Accessing YANG Suite Docker Install with a Web Browser

The nginx container redirects port 80 to port 8443 for interfacing with the YANG Suite core.
Connect to http://localhost (opens in a new tab) or https://localhost:8443 (opens in a new tab).
If using a self-signed certificate generated by start_yang_suite.sh, a certificate warning might appear.

Additional Notes:

The yangsuite-restconf plugin uses port 443 to communicate with Cisco devices. Ensure RESTCONF is enabled in the YANG Suite Device profile for devices supporting this protocol.
Modify port numbers in docker-compose.yml and nginx.conf if necessary, especially if ports 8443 or 443 are unavailable.
Remember to use the username set during the installation process to log in.

The Cisco YANG Suite offers powerful tools for managing YANG models, providing a comprehensive solution for network management and automation tasks.

Reference: YANG Suite Github Repo (opens in a new tab)

Yang Eem