The main purpose of this knife plugin is to help cleanup stale objects on your chef server. The main use case it to run retentions on cookbook versions.
Installation is easy just as any other knife plugin, just install with the gem command
# You can install to your chefdk environment
chef gem install knife-chef-retention
# Or to a regular ruby environment
gem install knife-chef-retention
Everything suppose to be organized in an easy to navigate way. Everything is
nested under its corresponding resource. For example cookbook retentions are
under knife cookbook
and the commands should be self documenting.
Below are some simple examples
knife cookbook
** COOKBOOK COMMANDS **
...
knife cookbook retention [COOKBOOK] (options)
...
knife cookbook retention windows
Running in Evaluation Mode no cookbooks will be deleted
Latest Version: 2.0.2
Unused Version: 1.34.8
Unused Version: 1.36.0
...
Unused Version: 1.38.3
--clobber
- This will actually delete cookbooks while prompting-y
- This will not ask when deleting cookbooks--extra-versions
- Specifies the total number of extra unused versions to keep around (Default 1)
- Author:: Brent Montague (bmontague@cvent.com)
Copyright:: 2015, Cvent, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Please refer to the license file for more license information.