README
¶
nginxconf
nginxconf 是一个灵活的, 快捷的 nginx.conf 文件解析器, 能够在文件, json, go-struct, template 快速转换, 是 nginx.conf 在线可视化配置的基石
依赖
- 第一步: 安装 Python 环境, Python2, Python3 均可,自行安装
- 第二步: 安装 Python 库:
pip install cscrossplane
安装
go get -u github.com/caas-one/nginxconf
📘 安装时,可能会发生一些意外的问题, 我们把可能的问题已经整理到文档,并提供了解决办法, 点击查看 , 如果您在文档中未查找到相关问题,欢迎向我们反馈和提 issue.
Document
概要
随着时代的发展, 各企业纷纷提出了更高标准的运维需求:
- 操作可追溯性
- 自动化运维
nginx 作为用户最多的软件之一, nginx配置的变更可追溯性面对巨大的挑战, 同时,日积月累的变更操作造就了冗长的,晦涩的 nginx.conf, 最终可能造成 变不敢变 的结局,基于现状和更高标准的运维需求, 产生了nginxconf
nginxconf 现阶段可能给您带来哪些收益呢?
- nginx 配置变更可追溯
- nginx 配置可视化
- 按规范/约定自动拆分 nginx 配置
- nginx 配置自动创建并分发(如: 在kubernetes中, 当watch到 nodeport svc的创建, 自动生成 nginx 配置转发)
- nginx 配置多节点分发
为达到上面的需求和收益, nginxconf 所处的地位是什么呢?
如果上面的需求和收益是业务诉求, 那么 nginxconf 就是实现这些诉求的基石 ,一切的诉求都在这个基石之上.
nginxconf 真正做了那些事情呢?
- 解析nginx.conf
- 转换成结构化的模型
- 根据模板生成nginx配置
nginxconf 解析和渲染方式
- 第一步: nginxconf 通过 cscrossplane (这是一个python库,如何安装Python?)把 nginx-in.conf 解析成一个中间态json
- 第二步: 接着通过巧妙而又暴力的方式(指令判断的方式)把 中间态json 中的数据转换到结构化的 Go struct 中, 这样就避免了 nginx.conf 中 if 指令和 location 指令带来的麻烦
- 第三步:最后根据 template 把Go struct中的数据重新渲染成 nginx-out.conf
流程如下图所示:
Go struct 和 nginx.conf 层级对应关系
在 Go struct 和 nginx.conf 映射关系设计中, 完全使用了平行映射的方式(以 nginx.conf 中的指令直接作为 Go struct 中的字段名), 使用这种方式可以让开发者如丝般顺滑的接入 nginxconf ,我们以对比的方式生成了一张对比图,如下所示:
示例
//nginx-in.conf
daemon on;
master_process on;
pid logs/nginx.pid;
events {
accept_mutex off;
accept_mutex_delay 500ms;
use epoll;
worker_connections 65534;
}
使用 nginxconf 解析 nginx.conf
func Example_nginxconf_Parse() {
path := "./nginx-in.conf"
global, err := nginxconf.Parse(path)
if err != nil {
panic(err)
}
fmt.Println(global)
}
// result:
&core.Global{
Daemon: "on",
MasterProcess: "on",
Pid: "logs/nginx.pid",
Events: core.Event{
AcceptMutex: "off",
AcceptMutexDelay: "500ms",
Use: "epoll",
WorkerConnections: "65534",
},
}
通过 template 生成 nginx.conf
func Example_RenderServer() {
server := &core.Server{
Listen: "80",
Name: "eg.com",
ErrorPage: "500 502 503 504 /index.html",
Locations: []core.Location{
core.Location{
Path: "/",
ClientBodyBufferSize: "128k",
ClientMaxBodySize: "10m",
ProxyRedirect: "off",
IfBlocks: []core.LocationIfBlock{
core.LocationIfBlock{
Condition: "$request_uri ~* /zgt/",
ProxyPass: "http://eg.com/ortal_http",
},
},
},
core.Location{
Path: "= /index.html",
Root: "/eg/500",
},
},
}
result, err := nginxconf.RenderToString(server)
if err != nil {
panic(err)
}
fmt.Println(result)
}
// result:
server {
server_name eg.com;
listen 80;
error_page 500 502 503 504 /index.html;
location / {
client_body_buffer_size 128k;
client_max_body_size 10m;
proxy_redirect off;
if ($request_uri ~* /zgt/) {
proxy_pass http://eg.com/ortal_http;
}
}
location = /index.html {
root /eg/500;
}
}
按照一个域名一个conf的方式分组渲染
func Example_RenderDomainGroup() {
data, err := nginxconf.RenderToString(newTestDomainGroup())
if err != nil {
panic(err)
}
fmt.Printf(data)
}
// result:
upstream eg_http {
ip_hash;
server 127.0.0.1:8080 weight=99 max_fails=3 fail_timeout=10s;
}
upstream eg_http2 {
ip_hash;
server 127.0.0.1:8081 weight=1 max_fails=3 fail_timeout=10s;
}
server {
server_name eg.com;
listen 80;
error_page 500 502 503 504 /index.html;
location / {
client_body_buffer_size 128k;
client_max_body_size 10m;
proxy_redirect off;
if ($request_uri ~* /zgt/) {
proxy_pass http://eg.com/ortal_http;
}
}
location = /index.html {
root /eg/500;
}
}
server {
server_name eg.com;
listen 81;
error_page 500 502 503 504 /index.html;
location / {
client_body_buffer_size 128k;
client_max_body_size 10m;
proxy_redirect off;
if ($request_uri ~* /zgt/) {
proxy_pass http://eg.com/ortal_http;
}
}
location = /index.html {
root /eg/500;
}
}
更多示例查看 *_test.go
Documentation
¶
Overview ¶
Example (Nginxconf_Parse) ¶
package main
import (
"fmt"
"github.com/caas-one/nginxconf"
)
func main() {
path := "./nginx.conf"
global, err := nginxconf.Parse(path)
if err != nil {
panic(err)
}
fmt.Println(global)
}
Output:
Example (Nginxconf_RenderToString) ¶
package main
import (
"fmt"
"github.com/caas-one/nginxconf"
)
func main() {
path := "./nginx.conf"
global, err := nginxconf.Parse(path)
if err != nil {
panic(err)
}
result, err := nginxconf.RenderToString(global)
if err != nil {
panic(err)
}
fmt.Println(result)
}
Output:
Index ¶
- func GetFields(object interface{}) (interface{}, error)
- func Parse(filePath string) (*core.Global, error)
- func ParseToConfigs(filePath string) (*core.CrossplaneOut, error)
- func ParseToJSON(filePath string) (string, error)
- func RenderToBytes(tb core.TemplateBlock) ([]byte, error)
- func RenderToString(tb core.TemplateBlock) (string, error)
- type Object
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetFields ¶
func GetFields(object interface{}) (interface{}, error)
GetFields get fields type eg
func ParseToConfigs ¶
func ParseToConfigs(filePath string) (*core.CrossplaneOut, error)
ParseToConfigs parse nginx conf to crossplane configs
func ParseToJSON ¶
ParseToJSON parse nginx conf to json
func RenderToBytes ¶
func RenderToBytes(tb core.TemplateBlock) ([]byte, error)
RenderToBytes render module to nginx conf
func RenderToString ¶
func RenderToString(tb core.TemplateBlock) (string, error)
RenderToString render module to nginx conf
Types ¶
type Object ¶
type Object struct {
Field string `json:"field,omitempty"`
Key string `json:"key,omitempty"`
Value interface{} `json:"value,omitempty"`
Type string `json:"type,omitempty"`
JSONKey string `json:"jsonKey,omitempty"`
Example string `json:"example,omitempty"`
}
Object object field message
func GetFieldsAndValue ¶
GetFieldsAndValue get object field value type and so on
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.