Make Chef Server distributable under a configurable name - wordmarks in outputs #1949

bobchaos · 2020-04-06T22:30:50Z

Motivation

As a Chef Infra redistributor, I would like to be able to redistribute Chef Infra server under a configurable name in order to make 3rd party distributions easier to produce and maintain in compliance with Chef Software's policy on trademarks https://www.chef.io/trademark-policy/

Specification

In other Chef Software repositories, we've adopted an approach wherein we create a file with constants in it (dist.rb in chef/chef) that correspond to Chef's wordmarks. We then replace all user-facing references to the wordmarks in the codebase with the constants. This allows 3rd party distros like Cinc.sh to build the code under new branding by swapping out the dist file and performing minor tweaks to the Omnibus conf.

Another approach also exists for Golang projects. Salim Afiune cooked up a a go code generator that's being implemented in Chef's go projects (see chef/go-libs for a full implementation + the code generator proper). When building, 3rd party distros simply feed a URL to a JSON file with their distro's wordmark replacements into go generate and then run plain old go build.

Original design proposal in chef/chef, which was re-used in multiple projects: chef/chef#8376

Initial PR implementing dist.rb in chef/chef: chef/chef#8368

The go code generator: https://github.com/chef/go-libs/tree/master/distgen

Let me know if I can provide any additional info about existing implementations of dist stuff, or if you want to explore an altogether different approach.

Downstream Impact

Somewhere between "none" and "everything" o.O For example, in chef/chef, we had a few situations that required changes beyond log messages and CLI outputs, such as having to rename the configuration directories. In the client repo, we addressed such concerns as we went, and ultimately managed to avoid breaking changes (altho a few deprecations resulted from the distro work). The bulk of the work should have no impact however, as it consists mostly of string replacements happening outside of logic and flow-control.

The text was updated successfully, but these errors were encountered:

Chef Server distributable under a configurable name. This is a starting point which replaces most of the instances of `chef-server` and `chef-sevrer-ctl` within the Ruby code of the Chef Server repo, but is not a complete fix for chef#1949

Add `dist.rb` files with "Wordmark" constants in an attempt to make Chef Server distributable under a configurable name. This is a starting point which replaces most of the instances of `chef-server` and `chef-sevrer-ctl` within the Ruby code of the Chef Server repo, but is not a complete fix for chef#1949 Signed-off-by: Josh Gitlin <jgitlin@pinnacle21.com>

jgitlin-p21 · 2020-04-28T22:23:32Z

I have created an initial PR for review on this. It builds for me locally, but this is nowhere near a complete fix. Notably missing is anything outside the ruby code, and I focused on replacing chef-server and chef-server-ctl but there are probably many instances of chef still in the codebase which will need additional PRs.

I do not have buildkite set up but I did an Omnibus build and the resulting package appeared to be a fully functional Chef server. I can't get tests to run locally even when just building on the master branch so I may need help there from someone in Slack.

Add `dist.rb` files with "Wordmark" constants in an attempt to make Chef Server distributable under a configurable name. This is a starting point which replaces most of the instances of `chef-server` and `chef-sevrer-ctl` within the Ruby code of the Chef Server repo, but is not a complete fix for #1949 Signed-off-by: Josh Gitlin <jgitlin@pinnacle21.com>

Add `dist.rb` files with "Wordmark" constants in an attempt to make Chef Server distributable under a configurable name. This is a starting point which replaces most of the instances of `chef-server` and `chef-sevrer-ctl` within the Ruby code of the Chef Server repo, but is not a complete fix for chef#1949 Signed-off-by: Josh Gitlin <jgitlin@pinnacle21.com>

jgitlin-p21 · 2020-07-01T15:35:28Z

Coming back to this finally. At last check the smoke tests were failing with uninitialized constant Chef::Dist::Server from a recipe at cookbooks/private-chef/recipes/default.rb:25. I had refactored the wordmarks to use a cookbook attribute for everything under cookbooks and am now trying to ensure all tests pass.

Latest work is here: https://github.com/jgitlin-p21/chef-server/tree/jgitlin-p21/wordmarks

Server distributable under a configurable name - wordmarks in outputs. This pas focuses on `chef-server-ctl` and replaces: * `chef` with `#{ChefConfig::Dist::SHORT}` * `Chef Server` with `#{Chef::Dist::SERVER_PRODUCT}` Multiple passes will likely be required; this is a small chunk meant to be easy to review and test. This is a combination of 3 commits: * f26fdb9 * 03c8686 * 7fae6f4 Signed-off-by: Josh Gitlin <jgitlin@pinnacle21.com>

This is an initial pass of replacements for issue chef#1949: Make Chef Server distributable under a configurable name - wordmarks in outputs. This pas focuses on `chef-server-ctl` and replaces: * `chef` with `#{ChefConfig::Dist::SHORT}` * `Chef Server` with `#{Chef::Dist::SERVER_PRODUCT}` Multiple passes will likely be required; this is a small chunk meant to be easy to review and test. This is a combination of 3 commits: * f26fdb9 * 03c8686 * 7fae6f4 Signed-off-by: Josh Gitlin <jgitlin@pinnacle21.com>

jgitlin-p21 · 2020-08-12T20:37:42Z

New PR for an initial pass here. Now with passing tests!