knife-push 1.1.1 → 1.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/knife-push/version.rb +1 -1
- metadata +3 -6
- data/README.md +0 -177
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 17eebd0c10b3d507ba5e63034881449f315f79409878f79c164c3819a66c1df0
|
4
|
+
data.tar.gz: 14263f755f97aff4c0088f1c906be9b05080211a40e17f3c075f409572c651fb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5e2364ef0a7297d622b036a0a8fa0deb746ebb38cd441630e2ee5d8dcb8844ca39b74edb966c8c15972cd5f595f295ecb728aaf60fa34574370ceffb51bca940
|
7
|
+
data.tar.gz: 311d76ae9a0ebd4b05a1adaea87c210ecc4f3ff3ef9064e3fa9e223b3a280f2a4f6ea0694e248632bc8ece698f856fa251c761fd32e22b283cbc26f3a192dc69
|
data/lib/knife-push/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: knife-push
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- John Keiser
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-12-
|
11
|
+
date: 2018-12-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: chef
|
@@ -28,12 +28,9 @@ description: Knife plugin for Chef Push Jobs
|
|
28
28
|
email: jkeiser@chef.io
|
29
29
|
executables: []
|
30
30
|
extensions: []
|
31
|
-
extra_rdoc_files:
|
32
|
-
- README.md
|
33
|
-
- LICENSE
|
31
|
+
extra_rdoc_files: []
|
34
32
|
files:
|
35
33
|
- LICENSE
|
36
|
-
- README.md
|
37
34
|
- lib/chef/knife/job_helpers.rb
|
38
35
|
- lib/chef/knife/job_list.rb
|
39
36
|
- lib/chef/knife/job_output.rb
|
data/README.md
DELETED
@@ -1,177 +0,0 @@
|
|
1
|
-
# Knife Push
|
2
|
-
|
3
|
-
[![Gem Version](https://badge.fury.io/rb/knife-push.svg)](https://badge.fury.io/rb/knife-push) [![Build Status](https://travis-ci.org/chef/knife-push.svg?branch=master)](https://travis-ci.org/chef/knife-push)
|
4
|
-
|
5
|
-
The knife push plugin is used by the Chef workstation to interact with the Push API to start jobs, view job status, view job lists, and view node status.
|
6
|
-
|
7
|
-
## Requirements
|
8
|
-
|
9
|
-
- Chef 13.0 higher
|
10
|
-
- Ruby 2.2.2 or higher
|
11
|
-
|
12
|
-
## Installation:
|
13
|
-
|
14
|
-
To build and install the plugin, run:
|
15
|
-
|
16
|
-
```shell
|
17
|
-
rake install
|
18
|
-
```
|
19
|
-
|
20
|
-
## Configuration:
|
21
|
-
|
22
|
-
If push server is running on the same host as the Chef Server, then no reconfiguration is required on the Chef workstation.
|
23
|
-
|
24
|
-
## Subcommands:
|
25
|
-
|
26
|
-
This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` flag.
|
27
|
-
|
28
|
-
### job list
|
29
|
-
|
30
|
-
The `job list` subcommand is used to view a list of Push jobs.
|
31
|
-
|
32
|
-
#### Syntax $ knife job list
|
33
|
-
|
34
|
-
### job start
|
35
|
-
|
36
|
-
The `job start` subcommand is used to start a Push job.
|
37
|
-
|
38
|
-
#### Syntax
|
39
|
-
|
40
|
-
```shell
|
41
|
-
knife job start (options) COMMAND [NODE, NODE, ...]
|
42
|
-
```
|
43
|
-
|
44
|
-
#### Options
|
45
|
-
|
46
|
-
This argument has the following options:
|
47
|
-
|
48
|
-
`--timeout TIMEOUT`
|
49
|
-
|
50
|
-
The maximum amount of time (in seconds) by which a job must complete, before it will be stopped.
|
51
|
-
|
52
|
-
`-q QUORUM --quorum QUORUM`
|
53
|
-
|
54
|
-
The minimum number of nodes that match the search criteria, are available, and acknowledge the job request. This can be expressed as a percentage (e.g. 50%) or as an absolute number of nodes (e.g. 145). Default value: 100%
|
55
|
-
|
56
|
-
`-b --nowait`
|
57
|
-
|
58
|
-
Exit immediately after starting a job instead of waiting for it to complete.
|
59
|
-
|
60
|
-
`--with-env ENVIRONMENT`
|
61
|
-
|
62
|
-
Accept a json blob of environment variables and use those to set the variables for the client. For example '{"test": "foo"}' will set the push client environment variable "test" to "foo". (Push 2.0 and later)
|
63
|
-
|
64
|
-
`--in-dir DIR`
|
65
|
-
|
66
|
-
Execute the remote command in the directory DIR. (Push 2.0 and later)
|
67
|
-
|
68
|
-
`--file DATAFILE`
|
69
|
-
|
70
|
-
Send the file to the client. (Push 2.0 and later)
|
71
|
-
|
72
|
-
`--capture`
|
73
|
-
|
74
|
-
Capture stdin and stdout for this job. (Push 2.0 and later)
|
75
|
-
|
76
|
-
#### Examples
|
77
|
-
|
78
|
-
For example, to search for nodes assigned the role "webapp", and where 90% of those nodes must be available, enter:
|
79
|
-
|
80
|
-
```shell
|
81
|
-
knife job start -quorum 90% 'chef-client' --search 'role:webapp'
|
82
|
-
```
|
83
|
-
|
84
|
-
To search for a specific set of nodes (named chico, harpo, groucho, gummo, zeppo), and where 90% of those nodes must be available, enter:
|
85
|
-
|
86
|
-
```shell
|
87
|
-
knife job start --quorum 90% 'chef-client' chico harpo groucho gummo zeppo
|
88
|
-
```
|
89
|
-
|
90
|
-
Use the `knife job start` subcommand to run a job with the following syntax:
|
91
|
-
|
92
|
-
```shell
|
93
|
-
knife job start job_name node_name
|
94
|
-
```
|
95
|
-
|
96
|
-
For example, to run a job named add-glasses against a node named "ricardosalazar", enter the following:
|
97
|
-
|
98
|
-
```shell
|
99
|
-
knife job start add-glasses 'ricardosalazar'
|
100
|
-
```
|
101
|
-
|
102
|
-
### job output
|
103
|
-
|
104
|
-
The `job output` command is used to view the output of Push jobs. (Push 2.0 and later). The output capture flag must have been set on job start; see the --capture option.
|
105
|
-
|
106
|
-
#### Syntax
|
107
|
-
|
108
|
-
```shell
|
109
|
-
knife job output JOBID
|
110
|
-
```
|
111
|
-
|
112
|
-
#### Examples
|
113
|
-
|
114
|
-
```shell
|
115
|
-
knife job output 26e98ba162fa7ba6fb2793125553c7ae test --channel stdout
|
116
|
-
```
|
117
|
-
|
118
|
-
#### Options
|
119
|
-
|
120
|
-
--channel [stderr|stdout]
|
121
|
-
|
122
|
-
The output channel to capture.
|
123
|
-
|
124
|
-
### job status
|
125
|
-
|
126
|
-
The `job status` command is used to view the status of Push jobs.
|
127
|
-
|
128
|
-
#### Syntax
|
129
|
-
|
130
|
-
```shell
|
131
|
-
knife job status JOBID
|
132
|
-
```
|
133
|
-
|
134
|
-
#### Examples
|
135
|
-
|
136
|
-
For example, to view the status of a job that has the identifier of "235", enter:
|
137
|
-
|
138
|
-
```shell
|
139
|
-
knife job status 235
|
140
|
-
```
|
141
|
-
|
142
|
-
### node status
|
143
|
-
|
144
|
-
The `node status` argument is used to identify nodes that Push may interact with.
|
145
|
-
|
146
|
-
#### Syntax
|
147
|
-
|
148
|
-
```shell
|
149
|
-
knife node status
|
150
|
-
```
|
151
|
-
|
152
|
-
## Contributing
|
153
|
-
|
154
|
-
For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
|
155
|
-
|
156
|
-
|
157
|
-
## License
|
158
|
-
|
159
|
-
**Author:** John Keiser([jkeiser@chef.io](mailto:jkeiser@chef.io))
|
160
|
-
|
161
|
-
**Copyright:** Copyright 2008-2018, Chef Software, Inc.
|
162
|
-
|
163
|
-
**License:** Apache License, Version 2.0
|
164
|
-
|
165
|
-
```text
|
166
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
167
|
-
you may not use this file except in compliance with the License.
|
168
|
-
You may obtain a copy of the License at
|
169
|
-
|
170
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
171
|
-
|
172
|
-
Unless required by applicable law or agreed to in writing, software
|
173
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
174
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
175
|
-
See the License for the specific language governing permissions and
|
176
|
-
limitations under the License.
|
177
|
-
```
|