[{"_1":2,"_177":-5,"_178":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_156":157},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_85":86,"_108":109,"_147":-5,"_148":11,"_149":17,"_150":11,"_151":-5,"_152":11,"_153":-5,"_154":155},"canonicalUrl","https://hub.docker.com/r/awinglobal/better-chef-rundeck/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","awinglobal","reponame","better-chef-rundeck","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":71,"_76":17,"_77":78,"_82":29,"_83":84},"categories",[],"content_types",[40],"image","date_registered","2017-03-27T10:40:13.356086Z","description","An app for integrating Chef and Rundeck - Fork from https://github.com/atheiman/better-chef-rundeck","is_private","last_updated","2017-03-27T10:46:12.6379Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",73294,"repository_type","star_count",2,"status",1,"status_description","active","source","collaborator_count",0,"full_description","# Better Chef Rundeck\n\n[![GitHub release](https://img.shields.io/github/release/atheiman/better-chef-rundeck.svg?maxAge=3600)](https://github.com/atheiman/better-chef-rundeck/releases/latest) [![Travis](https://img.shields.io/travis/atheiman/better-chef-rundeck.svg?maxAge=3600)](https://travis-ci.org/atheiman/better-chef-rundeck)\n\nA Sinatra app for integrating Chef and Rundeck - a Chef search query is sent as an HTTP GET request to the app at the path `/:` and the app will query the Chef server and return the nodes and their attributes in a format suitable for a Rundeck project's [resource model source](http://rundeck.org/docs/administration/managing-node-sources.html#resource-model-source).\n\n# Overview\n\nThis app allows defining a Chef node search query right in the path of an HTTP request. For example:\n\n```\nGET /role:webserver\n```\n\nwill return all nodes that match the node search query `role:webserver` in a format that Rundeck can parse for a project. A Rundeck project can be configured to use this url as the resource model source in the project's `project.properties`:\n\n```INI\nresources.source.1.type=url\nresources.source.1.config.url=http\\://better-chef-rundeck.example.com/role:webserver\n```\n\nThe returned data includes Chef attributes that will be attached to nodes in Rundeck, allowing users to search for nodes in Rundeck based on Chef attributes.\n\n## Improvements from the `chef-rundeck` Gem\n\nThe biggest issue with [oswaldlabs/chef-rundeck](https://github.com/oswaldlabs/chef-rundeck) is that project node searches are defined in a config file (`/etc/chef/rundeck.json`). Updating a project's node search with `chef-rundeck` requires updating `/etc/chef/rundeck.json` and then restarting `chef-rundeck`. Defining a Rundeck project's Chef node search query in `/etc/chef/rundeck.json` separate from the rest of the Rundeck project configuration (`project.properties`) doesn't make sense. `better-chef-rundeck` allows updating a Rundeck project's node search by simply updating the resource model source url in `project.properties`.\n\n# Running the App\n\n## Local Development\n\nThis gem is not yet production ready or available from rubygems. Until then, clone the project, and install dependencies with `bundle install`. Then run the app for local devlopment:\n\n```\nbundle exec rackup\n```\n\nThe app will look for a `knife.rb` or / then `client.rb` to configure its Chef server api calls by default.\n\nTry out the app at [localhost:9292](http://localhost:9292/).\n\nOptionally, configure a few things specific to the app using environment variables - these are defined a bit further down. You can also specify web server-type config options with `rackup` arguments, run `bundle exec rackup --help` to learn more about these.\n\nThe app can also be run locally with Passenger standalone like it would be run in production:\n\n```\nbundle exec passenger start\n```\n\n## In Production\n\nThis app can easily be run with [Passenger standalone](https://www.phusionpassenger.com/library/config/standalone/intro.html). Passenger's standalone server is reliable enough to run an internal only app that handles a small amount of traffic. The basic steps are:\n\n1. Clone the app from [the GitHub repo](https://github.com/atheiman/better-chef-rundeck)\n1. Install dependencies with `bundle install --deployment --without development test`\n1. Run the app: `bundle exec passenger start --environment production`\n\nAdditionally, configure the app with a `Passengerfile.json` or `passenger`'s command line arguments. [Here is a reference for those config options](https://www.phusionpassenger.com/library/config/standalone/reference/). In addition to common web server-type config options, there are config options specific to this app that can be configured with environment variables. These can be set in the shell of the user running the app with `export ENVVAR=VALUE`, or with [passenger command line args or `Passengerfile.json`](https://www.phusionpassenger.com/library/config/standalone/reference/#--envvar-envvars). These options are described below:\n\n## With Docker\n\n```shell\ndocker build -t better-chef-rundeck .\ndocker run -d -p 80 -v $HOME/.chef:/home/app/.chef better-chef-rundeck\n```\n\n## Configuration\n\nThe app is configured with shell environment variables. These env vars are namespaced to not be overwritten by other programs. It should be clear that the app will run fine with the default configuration, and setting any of these env vars is not required.\n\nEnvironment Variable | Explanation | Default Value\n-------------------- | ----------- | -------------\n`BCR_CHEF_CONFIG` | Path to a Chef config file | First that exists in `['~/.chef/knife.rb', '/etc/chef/client.rb']`\n\n# Using the API\n\n## Which Attributes to Return from Chef\n\nRead [filtering Chef search returned attributes](https://docs.chef.io/chef_search.html#filter-search-results) for information about `filter_result` (sometimes referred to as `partial_search`).\n\nSeriously, go read it. It's not even long and it will make understanding this next bit *much* easier.\n\nSpecify which Chef node attributes should be in the returned data (`filter_result`) using GET parameters. **If these GET parameters are not set, the normal Chef attributes will be returned (which may or may not be what is wanted, especially in a very large environment).** Specify the attribute name as the GET param and the Chef attribute path as a comma-delimited list (`some,attribute,path`, `languages,ruby,version`) as the value of the GET param. So to convert the attribute `['really']['deep']['attr']` into the attribute `short`, use the GET param `short=really,deep,attr`. If a value is not provided for the GET param, the key will be used as the value (`?ipaddress=ipaddress` is unnecessary, you can get the same result with `?ipaddress`).\n\n### Example `filter_result` GET parameters\n\nChef node:\n\n```yaml\n---\nsomenode:\n ipaddress: 10.11.12.13\n kernel:\n version: 7.8.9\n languages:\n ruby:\n version: 2.1.0\n```\n\nRequest:\n\n```yaml\n# GET /name:somenode?ipaddress&kernel_version=kernel,version&ruby_version=languages,ruby,version\n\n---\nsomenode:\n ipaddress: 10.11.12.13\n kernel_version: 7.8.9\n ruby_version: 2.1.0\n```\n\n### Default `filter_result` attributes\n\nIf no attributes are specified for `filter_result`, the Chef node attributes returned will be very similar to running `knife search node QUERY`. But if any values are specified for `filter_result`, these default node attributes will not be returned; they will have to be explicitly requested in the `filter_result` GET parameters.\n\nChef node:\n\n```yaml\n---\nanothernode:\n environment: prod\n fqdn: anothernode.example.com\n ipaddress: 100.101.102.103\n run_list: recipe[base_os], role[webserver]\n roles: webserver\n platform: redhat\n tags:\n rundeck-managed\n some-tag\n```\n\nA request without specifying `filter_result` GET params would return exactly the data above. But a request specifying only the `filter_result` GET params `ip=ipaddress` and `ruby_version=languages,ruby,version` will not get all the attributes back because the request did not specify them:\n\n```yaml\n# GET /name:anothernode?ip=ipaddress&ruby_version=languages,ruby,version\n\n---\nanothernode:\n ip: 100.101.102.103\n ruby_version: 2.2.3\n```\n\n## `default_`ing and `override_`ing Attributes\n\nSet GET parameters to default and override node attributes. Set the GET parameter `default_=` to default `` to `` (defaults if the attribute value is `nil` or the attribute is not set for the node). Similarly, set the GET parameter `override_=` to set `` to `` for *all* nodes returned.\n\nA common use case for `default_` or `override_` attributes is setting the attribute `username` to the value `${option.username}` for usage in remote ssh logins in a Rundeck job as a job option.\n\nTo illustrate this, three Chef nodes with different attributes (some attributes unset, some `nil`):\n\n```yaml\n---\nnodea:\n domain: example.com\n ruby_version: 2.1.0\nnodeb:\n domain: different.co\n ruby_version:\n username: rundeck_svc_acct\nnodec:\n domain:\n ruby_version:\n```\n\nThis request would return something similar to the following:\n\n```yaml\n# GET /*:*?default_domain=github.com&override_ruby_version=2.2.0&default_username=${option.username}\n\n---\nnodea:\n domain: example.com\n ruby_version: 2.2.0\n username: ${option.username}\nnodeb:\n domain: different.co\n ruby_version: 2.2.0\n username: rundeck_svc_acct\nnodec:\n domain: github.com\n ruby_version: 2.2.0\n username: ${option.username}\n```\n\n# Contributing\n\n1. Fork the repo in GitHub\n1. Create a branch (with a logical name like `feat/x` or `fix/y`)\n1. Make your changes (and add applicable tests)\n1. Create a pull request\n\n# Testing\n\nTested with [`rspec`](http://rspec.info/) and [`chef-zero`](https://github.com/chef/chef-zero). You can execute the tests with:\n\n```shell\n$ bundle\n$ bundle exec rspec\n```\n\nTests are built with [Travis CI](https://travis-ci.org/atheiman/better-chef-rundeck) on all pushes. Tests require chef-zero, which requires Ruby version `>= 2.1.0`, so tests are only run for those versions of Ruby. However, the app itself should work on older versions of Ruby.\n","has_starred","hub_user","immutable_tags_settings",{"_72":11,"_73":74},"enabled","rules",[75],".*","is_automated","permissions",{"_79":17,"_80":11,"_81":11},"read","write","admin","user","storage_size",290661566,"orgData",{"_87":88,"_89":90,"_91":92,"_93":29,"_94":95,"_96":97,"_98":95,"_99":100,"_101":102,"_103":104,"_105":97,"_106":97,"_107":17},"id","527bd811d2154767b1e49bb3c06e202e","uuid","527bd811-d215-4767-b1e4-9bb3c06e202e","type","organization","orgname","full_name","Awin","location","","company","profile_url","http://awin.com","date_joined","2017-03-15T08:38:18.532885Z","gravatar_url","https://www.gravatar.com/avatar/df6466034104cdc73b95a18278020a3c?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[110],{"_111":40,"_112":113,"_114":115,"_87":116,"_117":118,"_46":136,"_137":113,"_138":29,"_139":52,"_53":140,"_141":142,"_143":126,"_144":136,"_145":62,"_146":17},"content_type","creator",1555532,"full_size",290651169,9386531,"images",[119],{"_120":121,"_122":123,"_124":97,"_125":126,"_127":128,"_129":130,"_131":97,"_132":-5,"_133":134,"_59":62,"_135":-5},"architecture","amd64","digest","sha256:b646260b55ba0b54c2a85cc633b2b2f9a2f5e16cf96a18b90bfeaaf1f6350b7c","features","last_pulled","2026-09-23T06:30:45.637807764Z","last_pushed","2017-03-27T10:46:13Z","os","linux","os_features","os_version","size",290651105,"variant","2017-03-27T10:46:12.313762Z","last_updater","last_updater_username","media_type","latest","repository",1359886,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":158,"_165":166,"_154":175,"_176":11},{"_36":159,"_38":160,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":161,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":162,"_76":17,"_77":164,"_82":29,"_83":84},[],[40],[52],{"_72":11,"_73":163},[75],{"_79":17,"_80":11,"_81":11},"tags",{"_167":60,"_168":-5,"_169":-5,"_170":171},"count","next","previous","results",[172],{"_111":40,"_112":113,"_114":115,"_87":116,"_117":173,"_46":136,"_137":113,"_138":29,"_139":52,"_53":140,"_141":142,"_143":126,"_144":136,"_145":62,"_146":17},[174],{"_120":121,"_122":123,"_124":97,"_125":126,"_127":128,"_129":130,"_131":97,"_132":-5,"_133":134,"_59":62,"_135":-5},[],"canDeleteTags","actionData","errors"]

awinglobal/better-chef-rundeck

Tags for awinglobal/better-chef-rundeck