_knife 7.47 KB
Newer Older
Frank Louwers's avatar
Frank Louwers committed
1
2
#compdef knife

3
4
5
# You can override the path to knife.rb and your cookbooks by setting
# KNIFE_CONF_PATH=/path/to/my/.chef/knife.rb
# KNIFE_COOKBOOK_PATH=/path/to/my/chef/cookbooks
6
# If you want your local cookbooks path to be calculated relative to where you are then
7
# set the below option
8
# KNIFE_RELATIVE_PATH=true
9
10
# Read around where these are used for more detail.

Frank Louwers's avatar
Frank Louwers committed
11
# These flags should be available everywhere according to man knife
12
knife_general_flags=(--help --server-url --key --config --editor --format --log_level --logfile --no-editor --user --print-after --version --yes)
Frank Louwers's avatar
Frank Louwers committed
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# knife has a very special syntax, some example calls are:
# knife status
# knife cookbook list
# knife role show ROLENAME
# knife data bag show DATABAGNAME
# knife role show ROLENAME --attribute ATTRIBUTENAME
# knife cookbook show COOKBOOKNAME COOKBOOKVERSION recipes

# The -Q switch in compadd allow for completions of things like "data bag" without having to go through two rounds of completion and avoids zsh inserting a \ for escaping spaces
_knife() {
  local curcontext="$curcontext" state line
  typeset -A opt_args
  cloudproviders=(bluebox ec2 rackspace slicehost terremark)
  _arguments \
28
29
    '1: :->knifecmd' \
    '2: :->knifesubcmd' \
Frank Louwers's avatar
Frank Louwers committed
30
31
32
33
    '3: :->knifesubcmd2' \
    '4: :->knifesubcmd3' \
    '5: :->knifesubcmd4' \
    '6: :->knifesubcmd5'
34

Frank Louwers's avatar
Frank Louwers committed
35
36
  case $state in
  knifecmd)
37
    compadd -Q "$@" bootstrap client configure cookbook "cookbook site" "data bag" diff exec environment index node recipe role search ssh status upload vault windows $cloudproviders
38
    ;;
Frank Louwers's avatar
Frank Louwers committed
39
40
  knifesubcmd)
    case $words[2] in
41
    bluebox|ec2|rackspace|slicehost|terremark)
Frank Louwers's avatar
Frank Louwers committed
42
      compadd "$@" server images
43
      ;;
Frank Louwers's avatar
Frank Louwers committed
44
45
    client)
      compadd -Q "$@" "bulk delete" list create show delete edit reregister
46
      ;;
Frank Louwers's avatar
Frank Louwers committed
47
48
    configure)
      compadd "$@" client
49
      ;;
Frank Louwers's avatar
Frank Louwers committed
50
51
    cookbook)
      compadd -Q "$@" test list create download delete "metadata from" show "bulk delete" metadata upload
52
      ;;
53
54
    diff)
      _arguments '*:file or directory:_files -g "*"'
55
      ;;
56
    environment)
57
      compadd -Q "$@" list create delete edit show "from file"
58
      ;;
Frank Louwers's avatar
Frank Louwers committed
59
    node)
60
61
      compadd -Q "$@" "from file" create show edit delete list run_list "bulk delete"
      ;;
Frank Louwers's avatar
Frank Louwers committed
62
    recipe)
63
64
      compadd "$@" list
      ;;
Frank Louwers's avatar
Frank Louwers committed
65
66
    role)
      compadd -Q "$@" "bulk delete" create delete edit "from file" list show
67
      ;;
68
    upload)
69
70
      _arguments '*:file or directory:_files -g "*"'
      ;;
71
72
    vault)
      compadd -Q "$@" create decrypt delete edit remove "rotate all keys" "rotate keys" show update
73
      ;;
Frank Louwers's avatar
Frank Louwers committed
74
75
    windows)
      compadd "$@" bootstrap
76
      ;;
Frank Louwers's avatar
Frank Louwers committed
77
    *)
78
79
      _arguments '2:Subsubcommands:($(_knife_options1))'
      ;;
Frank Louwers's avatar
Frank Louwers committed
80
    esac
81
82
    ;;
  knifesubcmd2)
Frank Louwers's avatar
Frank Louwers committed
83
    case $words[3] in
84
    server)
Frank Louwers's avatar
Frank Louwers committed
85
      compadd "$@" list create delete
86
87
      ;;
    images)
Frank Louwers's avatar
Frank Louwers committed
88
      compadd "$@" list
89
90
      ;;
    site)
Frank Louwers's avatar
Frank Louwers committed
91
      compadd "$@" vendor show share search download list unshare
92
93
94
95
96
97
98
      ;;
    show|delete|edit)
      _arguments '3:Subsubcommands:($(_chef_$words[2]s_remote))'
      ;;
    upload|test)
      _arguments '3:Subsubcommands:($(_chef_$words[2]s_local) --all)'
      ;;
Frank Louwers's avatar
Frank Louwers committed
99
    list)
100
101
      compadd -a "$@" knife_general_flags
      ;;
Frank Louwers's avatar
Frank Louwers committed
102
103
    bag)
      compadd -Q "$@" show edit list "from file" create delete
104
      ;;
Frank Louwers's avatar
Frank Louwers committed
105
106
    *)
      _arguments '3:Subsubcommands:($(_knife_options2))'
107
      ;;
Frank Louwers's avatar
Frank Louwers committed
108
109
    esac
    ;;
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  knifesubcmd3)
    case $words[3] in
    show)
      case $words[2] in
      cookbook)
        versioncomp=1
        _arguments '4:Cookbookversions:($(_cookbook_versions) latest)'
        ;;
      node|client|role)
        compadd "$@" --attribute
        ;;
      esac
      ;;
    esac
    case $words[4] in
    show|edit)
      _arguments '4:Subsubsubcommands:($(_chef_$words[2]_$words[3]s_remote))'
      ;;
    file)
129
130
131
      case $words[2] in
      environment)
        _arguments '*:files:_path_files -g "*.(rb|json)" -W "$(_chef_root)/environments"'
132
        ;;
133
134
      node)
        _arguments '*:files:_path_files -g "*.(rb|json)" -W "$(_chef_root)/nodes"'
135
        ;;
136
137
      role)
        _arguments '*:files:_path_files -g "*.(rb|json)" -W "$(_chef_root)/roles"'
138
        ;;
139
140
141
142
      *)
        _arguments '*:Subsubcommands:($(_knife_options3))'
        ;;
      esac
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
      ;;
    list)
      compadd -a "$@" knife_general_flags
      ;;
    *)
      _arguments '*:Subsubcommands:($(_knife_options3))'
      ;;
    esac
    ;;
  knifesubcmd4)
    if ((versioncomp > 0)); then
      compadd "$@" attributes definitions files libraries providers recipes resources templates
    else
      case $words[5] in
      file)
        _arguments '*:directory:_path_files -/ -W "$(_chef_root)/data_bags" -qS \ '
159
        ;;
160
      *) _arguments '*:Subsubcommands:($(_knife_options2))' ;;
161
      esac
162
163
164
165
166
167
168
169
170
171
172
173
174
    fi
    ;;
  knifesubcmd5)
    case $words[5] in
    file)
      _arguments '*:files:_path_files -g "*.json" -W "$(_chef_root)/data_bags/$words[6]"'
      ;;
    *)
      _arguments '*:Subsubcommands:($(_knife_options3))'
      ;;
    esac
    ;;
  esac
Frank Louwers's avatar
Frank Louwers committed
175
176
177
178
}

# Helper functions to provide the argument completion for several depths of commands
_knife_options1() {
179
  (for line in $(knife $words[2] --help | grep -v "^knife"); do echo $line | grep "\-\-"; done)
Frank Louwers's avatar
Frank Louwers committed
180
181
182
}

_knife_options2() {
183
  (for line in $(knife $words[2] $words[3] --help | grep -v "^knife"); do echo $line | grep "\-\-"; done)
Frank Louwers's avatar
Frank Louwers committed
184
185
186
}

_knife_options3() {
187
  (for line in $(knife $words[2] $words[3] $words[4] --help | grep -v "^knife"); do echo $line | grep "\-\-"; done)
Frank Louwers's avatar
Frank Louwers committed
188
189
190
191
}

# The chef_x_remote functions use knife to get a list of objects of type x on the server
_chef_roles_remote() {
192
  (knife role list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
193
194
195
}

_chef_clients_remote() {
196
  (knife client list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
197
198
199
}

_chef_nodes_remote() {
200
  (knife node list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
201
202
203
}

_chef_cookbooks_remote() {
204
  (knife cookbook list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
205
206
207
}

_chef_sitecookbooks_remote() {
208
  (knife cookbook site list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
209
210
211
}

_chef_data_bags_remote() {
212
  (knife data bag list --format json | grep \" | awk '{print $1}' | awk -F"," '{print $1}' | awk -F"\"" '{print $2}')
Frank Louwers's avatar
Frank Louwers committed
213
214
}

215
216
217
218
_chef_environments_remote() {
  (knife environment list | awk '{print $1}')
}

Frank Louwers's avatar
Frank Louwers committed
219
220
# The chef_x_local functions use the knife config to find the paths of relevant objects x to be uploaded to the server
_chef_cookbooks_local() {
221
  if [ $KNIFE_RELATIVE_PATH ]; then
222
    local cookbook_path="$(_chef_root)/cookbooks"
223
  else
224
225
226
227
    local knife_rb=${KNIFE_CONF_PATH:-${HOME}/.chef/knife.rb}
    if [ -f ./.chef/knife.rb ]; then
      knife_rb="./.chef/knife.rb"
    fi
228
    local cookbook_path=${KNIFE_COOKBOOK_PATH:-$(grep cookbook_path $knife_rb | awk 'BEGIN {FS = "[" }; {print $2}' | sed 's/\,//g' | sed "s/'//g" | sed 's/\(.*\)]/\1/')}
229
230
  fi
  (for i in $cookbook_path; do ls $i; done)
Frank Louwers's avatar
Frank Louwers committed
231
232
233
234
235
236
237
}

# This function extracts the available cookbook versions on the chef server
_cookbook_versions() {
  (knife cookbook show $words[4] | grep -v $words[4] | grep -v -E '\]|\[|\{|\}' | sed 's/ //g' | sed 's/"//g')
}

238
239
240
# Searches up from current directory to find the closest folder that has a .chef folder
# Useful for the knife upload/from file commands
_chef_root() {
241
  directory="$PWD"
242
  while [ $directory != '/' ]; do
243
244
245
246
247
    test -e "$directory/.chef" && echo "$directory" && return
    directory="${directory:h}"
  done
}

Frank Louwers's avatar
Frank Louwers committed
248
_knife "$@"