Cisco YANG Suite 项目安装与使用教程

Cisco YANG Suite 项目安装与使用教程

yangsuite Cisco YANG Suite provides a set of tools and plugins to learn, test, and adopt YANG programmable interfaces such as NETCONF, RESTCONF, gNMI and more. 项目地址: https://gitcode.com/gh_mirrors/ya/yangsuite

1. 项目目录结构及介绍

Cisco YANG Suite 项目的目录结构如下：

yangsuite/
├── docker/
│   ├── examples/
│   ├── imgs/
│   ├── start_yang_suite.sh
│   ├── docker-compose.yml
│   ├── nginx/
│   └── yangsuite/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── NOTICE
├── README.md
├── RELEASE_NOTES.md
└── yangsuite.ini

目录结构介绍

• docker/: 包含 Docker 相关的文件和脚本，用于 Docker 安装和启动 YANG Suite。

  • examples/: 包含一些示例配置文件。
  • imgs/: 包含项目相关的图片文件。
  • start_yang_suite.sh: Docker 启动脚本。
  • docker-compose.yml: Docker Compose 配置文件。
  • nginx/: 包含 Nginx 配置文件。
  • yangsuite/: 包含 YANG Suite 的核心代码和配置文件。

• CODE_OF_CONDUCT.md: 项目的行为准则。

• CONTRIBUTING.md: 贡献指南。

• LICENSE: 项目许可证。

• NOTICE: 项目通知文件。

• README.md: 项目介绍和使用说明。

• RELEASE_NOTES.md: 发布说明。

• yangsuite.ini: YANG Suite 的配置文件。

2. 项目启动文件介绍

start_yang_suite.sh

start_yang_suite.sh 是用于启动 YANG Suite 的脚本。该脚本执行以下操作：

1. 提示用户输入用户名、密码和电子邮件地址，用于创建超级用户。
2. 提供创建测试 SSL/TLS 证书和密钥的选项。
3. 创建环境文件，用于 YANG Suite Docker 容器的安装。
4. 运行 docker-compose up 启动 YANG Suite。

docker-compose.yml

docker-compose.yml 是 Docker Compose 的配置文件，定义了 YANG Suite 的 Docker 服务。主要内容包括：

• nginx: 配置 Nginx 服务，用于反向代理和 HTTPS 支持。
• yangsuite: 配置 YANG Suite 服务，包含 Django 应用和相关依赖。

3. 项目配置文件介绍

yangsuite.ini

yangsuite.ini 是 YANG Suite 的主要配置文件，包含以下关键配置项：

• data_path: 数据存储路径。
• port: YANG Suite 服务的端口。
• allowed_hosts: 允许访问 YANG Suite 的主机列表。
• secret_key: Django 应用的密钥。
• static_root: 静态文件的存储路径。
• settings_module: Django 设置模块。
• eula_agreement: 最终用户许可协议。
• dna_advantage: DNA 优势检测。

production.py

production.py 是 Django 的设置文件，位于 yangsuite/docker/yangsuite/ 目录下。该文件包含 Django 应用的生产环境配置，如数据库配置、静态文件配置等。

nginx.conf

nginx.conf 是 Nginx 的配置文件，位于 yangsuite/docker/nginx/ 目录下。该文件配置了 Nginx 的反向代理和 HTTPS 支持。

通过以上配置文件，用户可以自定义 YANG Suite 的行为和功能，以满足特定的需求。

yangsuite Cisco YANG Suite provides a set of tools and plugins to learn, test, and adopt YANG programmable interfaces such as NETCONF, RESTCONF, gNMI and more. 项目地址: https://gitcode.com/gh_mirrors/ya/yangsuite