GoAnsible

使用golang 编写，实现 ansible playbook 部分功能，安装起来更简单，目的不在于替换ansible，而是代替某些复杂shell脚本（特别多机部署）。

编译

编译命令行工具


cd cmd/goansible/

CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -v -o goansible

快速开始

初始化文件


goansible init

执行命令生成在当前目录生成 values.yaml 和 index.yaml 两个文件

values.yaml : 定义变量，如主机ssh 信息
index.yaml : 定义playbook及其 tasks

运行playbook


goansible

使用教程

playbook格式跟 ansible playbook非常相似，但 goansible 没有role 功能，模板由 jinja2 变为 go 的 template

inventory 使用 yaml 格式定义，定义主机属性和分组以及自定义变量。同时支持通过javascript 和 lua 脚本，用于参数处理

inventory

groups:
  all: # 必须定义， 一个特殊组，包含所有主机的定义
    host1: # 主机名，可以通过 ansible_ssh_hostname 属性来获取 
      ansible_ssh_host: "192.168.1.100" # 主机 ssh ip 
      ansible_ssh_port: "22" # 主机ssh 端口
      ansible_ssh_user: root # 主机ssh 用户
      ansible_ssh_pass: "123456" # 主机ssh 密码 （密码、密钥二选一）
      ansible_ssh_sudopass: "123456" # 主机ssh sudo 密码, 当定义了该属性，所有执行的命令都会自动加上sudo
      ansible_ssh_key: "" # 主机机ssh 密钥 （密码、密钥二选一）
    host2:
      ansible_ssh_host: "192.168.1.101"
      ansible_ssh_port: "22"
      ansible_ssh_user: root
      ansible_ssh_pass: "123456"
      ansible_ssh_key: ""
    localhost: # 特殊的主机名，localhost表示本地主机，无需ssh
      ansible_ssh_host: ""
      ansible_ssh_port: ""
      ansible_ssh_user: ""
      ansible_ssh_pass: ""
      ansible_ssh_key: ""
  testgroup1: # 用户自定义组，名字可以任意取
     host1: 
       node_master: true
     host2: {}
vars: 
  key1: value1

groups：定义主机属性和分组，all: 一个特殊组，包含所有主机的定义, testgroup1: 用户自定义组，名字可以任意取。
vars：自定义变量，可以通过 {{ .Values.key1 }} 获取

playbook

- name: import playbook
  import_playbook: import.yaml
  tags: 
    - tag1
    - tag2

- name: example playbook
  hosts: test
  vars:
    d: b
  include_values:
    - values.yaml
  tasks:
    - name: echo
      shell: echo helloworld

上面例子描述了一playbook 结构：

name: playbook 的名字，这是可以随便取
import_playbook：导入另一个playbook 内容
hosts：主机，目前仅支持 group name
vars: 自定义变量
include_values：使用包含自定义变量文件，这个跟vars 合并，并重复的话会覆盖vars
tasks：包含一组任务
tags：标签过滤，多个标签使用","分割，

task

- name: shell command
  shell: echo helloword > hello
- name: copy file
  file:
    src: test.file
    dest: /tmp/test.file
- name: parse template file
  template:
    src: test.tpl
    dest: /tmp/test.tpl

一、变量和函数

goansible 分为四种种变量，一种全局变量values; 一种是主机变量hostvars；还有当前组所有主机变量groupvars （hostvars 是 groupvars 一个成员），所有主的变量 groups (groupvars 是 groups 一个成员)。

在模板中使用(如：shell，template，debug 等)：{{ .Values.xxx }}、 {{ .HostVars.xxx }}、 {{ .GroupVars.hostname.xxx }} {{ .Groups.groupname.hostname.xxx }}

在赋值中使用（如： stdout, when, loop）： values.xxx、 hostvars.xxx 、groupvars.hostname.xxx groups.groupname.hostname.xxx

goansible 内置部分函数：

join: 将数组合并成字符串，{{ join .Values.testArray "," }}
join_groupvars: 将某个组里hostvar合并成字符串，{{ join_groupvars .GroupVars ansible_ssh_host ","}}
plus: 加，{{ plus .Values.a .Values.b }}
minus: 减，{{ minus .Values.a .Values.b }}

第三方函数

二、循环

- name: loop
  shell: echo {{ .Item }}
  loop:
    - a
    - b
- name: loop values
  shell: echo {{ .Item.xxx }}
  concurrency: 2  # 并发数
  loop: values.loops

三、条件

- name: when
  shell: echo "I am master"
  when: hostvars.k8s_master

四、获取执行结果

- name: stdout
  shell: echo "stdout result"
  stdout: hostvars.stdout

五、打印变量

- name: stdout
  shell: echo "stdout result"
  stdout: hostvars.stdout
  debug: {{ .HostVars.stdout }}

六、忽略错误

- name: stdout
  shell: errcmd
  ignore_error: true

七、包含其他task文件

- name: include task
  include: task.yaml

八、标签

- name: tag test
  shell: do something
  tags: 
    - tag1
    - tag2

运行时设置标签：

./playbook -tags tag1,tag2

九、操作

1、shell

- name: shell command
  shell: echo helloword > hello

- name: 使用变量模板
  shell: echo {{ .Values.test }}

shell: 执行的命令

2、file

- name: copy file
  file:
    src: test.file
    dest: /tmp/test.file
    mode: "0644"
    owner: root
    group: root

复制文件到目标机器

src: 源文件（本地文件）路径
dest: 目标文件路径
mode: 文件权限，默认0644
owner: 文件用户，默认ssh 用户
group: 文件用户组，默认ssh 用户组

3、template

- name: copy file
  template:
    src: test.file
    dest: /tmp/test.file
    mode: "0755"
    owner: root
    group: root

根据模板生成文件，并复制文件到目标机器

src: 源文件（本地文件）路径
dest: 目标文件路径
mode: 文件权限，默认0644
owner: 文件用户，默认ssh 用户
group: 文件用户组，默认ssh 用户组

4、directory

- name: directory
  directory:
    path: /tmp/456
    mode: "0755"
    owner: root
    group: root

新建文件夹

path: 文件夹路径
mode: 文件权限，默认0755
owner: 文件用户，默认ssh 用户
group: 文件用户组，默认ssh 用户组

5、regexp

- name: regexp
  regexp:
    src: abrrrc
    exp: a(b{1})r(r{2})c
    dst: values.reg.ddd

- name: regexp
  regexp:
    src: abrrrc
    exp: ","
    dst: values.reg.ddd
    split: true

根据正则表达式匹配分割，并保存结果到变量中

src: 源字符串
exp: 正则表达式
dst: 保存结果变量名
split: 分割

6、until

- name: demo until
  until:
    shell: "ss -lnp|awk '{print $5}'|grep  -n :3000$"
    match: ".+"
    timeout: 300
    interval: 10

循环执行命令，直到匹配到结果

shell: 执行shell命令
match: 对执行的命令输出结果匹配的正则表达式
timeout: 超时时间，默认300s
interval: 循环执行命令间隔，默认5s

7、cert 证书生成

- name: 生成CA
  cert:
    crt_path: root.crt
    key_path: root.key
    is_ca: "true"
    country: CN
    organization: k8s
    organizational_unit: opsnull
    expires: 100y
- name: 生成证书
  cert:
    root_crt_path: root.crt
    root_key_path: root.key
    crt_path: test.crt
    key_path: test.key
    is_ca: "false"
    common_name: kubernetes-master
    country: CN
    organization: k8s
    organizational_unit: opsnull
    expires: 100y
    ip_addresses: "127.0.0.1,192.168.1.1"
    domains: "localhost"

8、curl

- name: curl请求
  curl:
    url: http://127.0.0.1
    option: 
      request: POST
      header: "Content-Type:application/json"
      data: |
        {"hello":"world"}
- name: curl请求 yaml to json
  curl:
    url: http://127.0.0.1
    options: 
      request: POST
      header: "Content-Type:application/json"
      data-yaml: |
        hello: world

url: 请求地址
options: 和 curl 命令参数相同，可以使用curl --help 查看，新增 data-yaml，使用yaml 编写格式，data-file：指定yaml 文件

9、设置变量

  - name: setface
    setface: 'values.a=hostvars.ansible_ssh_host'
    debug: '{{ .Values.a }}'

将 hostvars.ansible_ssh_host 赋值给 values.a

10、 js 脚本

  - name: js
    js: |
      var v = 'js value'
      values.key1=v
    debug: '{{ .Values.key1 }}'

js： js 脚本，可以使用 values hostvars groupvars groups

11、lua 脚本

  - name: lua
    lua: |
      local v = "js value"
      values.key1=v
    debug: '{{ .Values.key1 }}'

lua : lua 脚本，可以使用 values hostvars groupvars groups

12、自定义yaml模块

以创建 ls 模块为例，创建目录modules , 并新建modules/ls.yaml, 内容如下

- name: list dir
  shell: ls {{ .Ctx.dir }}

Ctx 为模块上下文，通过.Ctx.dir获取传入的变量json

使用自定义模块

- name: ls
  ls:
    dir: /tmp

13、自定义JS模块

以创建 split 模块为例，创建目录modules , 并新建modules/split.js, 内容如下

 ctx.res = ctx.data.split(',')

Ctx 为模块上下文，通过.Ctx.data获取传入的变量data

使用自定义模块

- name: split str
  split:
    data: "1,2,3"
  setface: "values.arr=ctx.res"
  debug: "{{ .Values.arr }}"

14、自定义JS库

以创建 strings 库为例，创建目录libs , 并新建libs/strings.js, 内容如下

class Strings {
  random(e) {    
      e = e || 32;
      var t = "ABCDEFGHJKMNPQRSTWXYZabcdefhijkmnprstwxyz2345678",
      a = t.length,
      n = "";
      for (i = 0; i < e; i++) n += t.charAt(Math.floor(Math.random() * a));
      return n
  }
}

var strings = new Strings()

使用自定义JS库

- name: gen
  js: |
    values.a = strings.random(32)
  debug: "{{ .Values.a }}"

Name		Name	Last commit message	Last commit date
Latest commit History 58 Commits
cmd		cmd
docs		docs
example		example
model		model
pkg		pkg
playbook		playbook
.gitignore		.gitignore
README.md		README.md
go.mod		go.mod
go.sum		go.sum

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd

cmd

docs

docs

example

example

model

model

pkg

pkg

playbook

playbook

.gitignore

.gitignore

README.md

README.md

go.mod

go.mod

go.sum

go.sum

Repository files navigation

GoAnsible

编译

编译命令行工具

快速开始

初始化文件

运行playbook

使用教程

inventory

playbook

task

About

Releases 1

Packages

Languages

hashwing/goansible

Folders and files

Latest commit

History

Repository files navigation

GoAnsible

编译

编译命令行工具

快速开始

初始化文件

运行playbook

使用教程

inventory

playbook

task

About

Resources

Stars

Watchers

Forks

Languages