one-container-alternative

one-container-alternative

This is an alternative way to install YANG Suite using only a single container instead of three.

This alternative is intended for experimentation and not as a direct replacement of the existing YANG Suite Docker implementation.

Advantages

• Fewer points of failure. One container for all YANG Suite requirements.
• No user input required. Configuration settings are preset.
• No Docker Compose needed. Only Docker commands are used.
• nginx Server removed.
• You can provide your own certificates; otherwise, a self-signed (dummy) certificate will be used.
• HTTPs only. Port 8480 used.

Limitations

• No Backup cron job.
• Container running as root. /usr/local/bin/create_yangtree had permissions issues. Will fix on a later release.

Prerequisites

• Docker
• Make

Build

To start building the container, go to one-container-alternative directory first.

cd one-container-alternative

Important

The rest of the commands assume you are executing the commands from inside the one-container-alternative directory.

Then run:

make build

Run

To start YANG Suite and begin using it, run:

make run

Then visit https://localhost:8480 (assuming that you are running it locally), accept the EULA, and use developer/developer to enter YANG Suite.

The named volume yangsuite-one-container-data is used to store the YANG Suite ys-data directory, where settings and data are stored.

You can also do make stop and make start, to stop and start the container respectively.

Using Custom Certificates

You can provide your own SSL certificates by creating a certificate directory and placing your files in it. The container looks for .crt and .key files in this directory. If both files are found, they will be used for HTTPS. If no user-provided certificates are found, the container falls back to using self-signed (dummy) certificates.

Steps to Use Custom Certificates.

• Create a certificate directory (inside the one-container-alternative directory).
• Place your .crt and .key files in the certificate directory.
• Only one .crt and .key files are allowed.
• Ensure that the filenames have the .crt and .key extensions.
• Run the container using the make run command.

Development

The daphne server handles HTTP requests, while twisted manages secure communications for the YANG Suite front end.

You can pass the environment variables YS_ADMIN_USER, YS_ADMIN_PASS, and YS_ADMIN_EMAIL, to do so, adjust the make build command, so they are set at build time, and pass them as build-arg.

Logs

You can watch YANG Suite Front end logs using:

Tip

This is handy when you run along run, for example make run follow. Use Ctrl + C to stop the logs.

make follow

You can watch YANG Suite internal logs using:

make debug

See the other options available in the Makefile.