Knife license comands and bootstrap updates #14559

ashiqueps · 2024-08-13T08:37:10Z

Description

Added the following commands:

knife license
knife license list
knife license add

Bootstrap updates:

If the user doesn't have a license, the chef infra download will fall back to the old Omnitruck API and the user will get a warning after the bootstrap.
If the user has a valid license, the new Omnitruck APIs will be used to download the chef infra client.

Related Issue

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

I have read the CONTRIBUTING document.
I have run the pre-merge tests locally and they pass.
I have updated the documentation accordingly.
I have added tests to cover my changes.
If Gemfile.lock has changed, I have used --conservative to do it and included the full output in the Description above.
All new and existing tests passed.
All commits have been signed-off for the Developer Certificate of Origin.

tpowell-progress · 2024-09-03T20:45:41Z

@ashiqueps Please fix lint and rebase on main to validate tests are passing.

knife/lib/chef/knife/license.rb

knife/lib/chef/utils/licensing_config.rb

tpowell-progress

Suggestions for more idiomatic Ruby, curiosity around the entitlement id, and more broadly: Should there be tests around the new commands for any potential failure modes?

knife/lib/chef/knife/core/bootstrap_context.rb

tpowell-progress · 2024-09-24T20:24:20Z

knife/lib/chef/knife/bootstrap/templates/chef-license.erb

@@ -0,0  1,776 @@
+#!/bin/sh


Upon discussion, this seems to be a duplication of https://github.com/chef/mixlib-install/blob/main/lib/mixlib/install/generator/bourne/scripts/helpers.sh.erb ? Why aren't we using mixlib-install? We should just modify mixlib-install that allows for an optional parameter to add any necessary functionality.

(If there are necessary breaking changes or high risk changes, we should bump version major or similar semantic communication)

Hi @tpowell-progress,

When we started working on these changes, the install.sh endpoint was unavailable on the new download APIs. The architects suggested having a local copy of that file on the knife repo as a temporary solution.

Recently, the licensing team has added those endpoints and we thought of implementing it with the workstation licensing changes, But I've updated the code to use the new APIS.

To your second point, this is not a breaking or high-risk change. This will show a warning to the user to remind the necessity of getting a license and activating it, or otherwise, with Infra 19, things will not work as it is.

Please review and let me know your thoughts.

@ashiqueps Ok, so I see that mixlib/install is not included in chef. Looks like it might be a little more work than the quick and dirty solution here @jaymzh

@ashiqueps looking at mixlic-install https://github.com/chef/mixlib-install/blob/main/lib/mixlib/install/generator/bourne.rb#L24 it looks like you can invoke one of the class methods or subclass/add a class method to generate what you want. This would save on duplication and prevent drift between the different scenarios.

tpowell-progress

Try adding mixlib-install and invoking the Mixlib::Install::Generator::Bourne.install_sh or similar method (or create your own that calls get_script("helpers.sh", context) to generate the helpers you need.

ashiqueps · 2024-10-03T05:05:32Z

Hey @tpowell-progress,

I've completely removed the install.sh script that was copied to the repo. Now it is being downloaded from the new download APIs based on the license type(https://chefdownload-trial.chef.io/install.sh in case of trial license). All the cases are handled in the latest download APIs.

I hope you requested this change because of the rewrite of the download script. Since that is handled now, I hope this will be fine. Please correct me if I am wrong.

Stromweld · 2024-10-03T17:52:16Z

can you rebase on main to fix the vm tests?

Stromweld · 2024-10-03T17:54:59Z

knife/lib/chef/knife/bootstrap/templates/chef-full.erb

  if test -f /usr/bin/<%= ChefUtils::Dist::Infra::CLIENT %>; then
    echo "-----> Existing <%= ChefUtils::Dist::Infra::PRODUCT %> installation detected"
  else
    echo "-----> Installing Chef Omnibus (<%= @config[:channel] %>/<%= version_to_install %>)"
    do_download ${install_sh} $tmp_dir/install.sh
-    sh $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>
+    bash $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>


I'd recommend leaving this as sh command as not all OS's like macos and freebsd default to or have bash shell installed.

Suggested change

bash $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>

sh $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>

There is a bug in the new install.sh script which is preventing us from using the sh shell. I've created a ticket to address this, but I am not sure when they are going to pick it up. https://progresssoftware.atlassian.net/browse/CHEF-16349

Signed-off-by: nikhil2611 <[email protected]>

Signed-off-by: Ashique P S <[email protected]>

Signed-off-by: Ashique Saidalavi <[email protected]>

jaymzh

This seems way way way better, thanks for the cleanup!

Can you address Corey's feedback though?

Signed-off-by: Ashique Saidalavi <[email protected]>

sonarcloud · 2024-10-16T15:10:43Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

ashiqueps · 2024-10-16T17:37:23Z

Hey @tpowell-progress, @Stromweld , @jaymzh,

I've addressed all the comments. Could you please review this again?

ashiqueps · 2024-10-24T13:34:49Z

Created #14669 to the chef-18 branch since these changes need to be released on the next Chef Infra 18 release. Closing this PR.

ashiqueps requested review from a team as code owners August 13, 2024 08:37

tpowell-progress added the Status: Waiting on Contributor A pull request that has unresolved requested actions from the author. label Sep 3, 2024

ashiqueps force-pushed the ashiqueps/license-bootstrap-only branch from 2eae3ec to fb71ac0 Compare September 5, 2024 09:39

tpowell-progress reviewed Sep 17, 2024

View reviewed changes

knife/lib/chef/knife/license.rb Outdated Show resolved Hide resolved

tpowell-progress reviewed Sep 17, 2024

View reviewed changes

knife/lib/chef/knife/license.rb Outdated Show resolved Hide resolved

tpowell-progress reviewed Sep 17, 2024

View reviewed changes

knife/lib/chef/utils/licensing_config.rb Show resolved Hide resolved

tpowell-progress requested changes Sep 17, 2024

View reviewed changes

ashiqueps mentioned this pull request Sep 18, 2024

License changes for the knife bootstrap command #13832

Merged

10 tasks

tpowell-progress added Status: Waiting for Build Fix and removed Status: Waiting on Contributor A pull request that has unresolved requested actions from the author. labels Sep 19, 2024

tpowell-progress reviewed Sep 19, 2024

View reviewed changes

knife/lib/chef/knife/core/bootstrap_context.rb Outdated Show resolved Hide resolved

tpowell-progress reviewed Sep 19, 2024

View reviewed changes

knife/lib/chef/knife/core/bootstrap_context.rb Outdated Show resolved Hide resolved

ashiqueps force-pushed the ashiqueps/license-bootstrap-only branch from 1fbebc2 to b2acdf3 Compare September 24, 2024 10:10

tpowell-progress added the Focus: Community PR Review label Sep 24, 2024

tpowell-progress reviewed Sep 24, 2024

View reviewed changes

sean-simmons-progress self-requested a review September 24, 2024 20:25

tpowell-progress requested changes Oct 1, 2024

View reviewed changes

Stromweld reviewed Oct 3, 2024

View reviewed changes

nikhil2611 and others added 7 commits October 8, 2024 13:48

added the license check functionality for knife commands

b49667f

Signed-off-by: nikhil2611 <[email protected]>

chefstyle correction

cb4f30c

Signed-off-by: nikhil2611 <[email protected]>

added flag to enable and disable license feature

2fdff26

Signed-off-by: nikhil2611 <[email protected]>

fixed chef style lint

fb6b605

Signed-off-by: nikhil2611 <[email protected]>

updated the feature flag filename

2e56062

Signed-off-by: nikhil2611 <[email protected]>

License changes for the knife bootstrap command

76903f5

Signed-off-by: Ashique P S <[email protected]>

Handled the error scenario for chef client download with license

a1c4a40

Signed-off-by: Ashique P S <[email protected]>

ashiqueps added 13 commits October 8, 2024 13:48

Knife bootstrap updates

e52971a

Signed-off-by: Ashique Saidalavi <[email protected]>

Updated the gemfile

30e244e

Signed-off-by: Ashique Saidalavi <[email protected]>

Updated the licensing server url

88769b7

Signed-off-by: Ashique Saidalavi <[email protected]>

Chefstyle fixes

6aa8362

Signed-off-by: Ashique Saidalavi <[email protected]>

Updated the download url to production

1447f3f

Signed-off-by: Ashique Saidalavi <[email protected]>

Spec fixes

68d0e12

Signed-off-by: Ashique Saidalavi <[email protected]>

Code review comments

463d57f

Signed-off-by: Ashique Saidalavi <[email protected]>

Added specs for the license command

9d052c8

Signed-off-by: Ashique Saidalavi <[email protected]>

Fixed the gem loading issues on the knife-windows gem

5f87f13

Signed-off-by: Ashique Saidalavi <[email protected]>

Fixed the spec failures with the chef-zero gem

9acd6b7

Signed-off-by: Ashique Saidalavi <[email protected]>

Removed the unwanted slash

2869947

Signed-off-by: Ashique Saidalavi <[email protected]>

Use the install.sh from the new download apis

292de79

Signed-off-by: Ashique Saidalavi <[email protected]>

Removed the mixlib install

9f883a3

Signed-off-by: Ashique Saidalavi <[email protected]>

ashiqueps force-pushed the ashiqueps/license-bootstrap-only branch from ea75856 to 9f883a3 Compare October 8, 2024 08:18

jaymzh reviewed Oct 8, 2024

View reviewed changes

Reverted the execution to sh

637dd82

Signed-off-by: Ashique Saidalavi <[email protected]>

ashiqueps changed the base branch from main to chef-18 October 24, 2024 13:15

ashiqueps requested a review from a team as a code owner October 24, 2024 13:15

ashiqueps changed the base branch from chef-18 to main October 24, 2024 13:15

ashiqueps mentioned this pull request Oct 24, 2024

Chef 2618 knife bootstrap changes to chef 18 #14669

Merged

11 tasks

ashiqueps closed this Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Knife license comands and bootstrap updates #14559

Knife license comands and bootstrap updates #14559

ashiqueps commented Aug 13, 2024

tpowell-progress commented Sep 3, 2024

tpowell-progress left a comment

tpowell-progress Sep 24, 2024

tpowell-progress Sep 24, 2024

ashiqueps Sep 26, 2024

tpowell-progress Oct 1, 2024

tpowell-progress Oct 1, 2024

tpowell-progress left a comment

ashiqueps commented Oct 3, 2024

Stromweld commented Oct 3, 2024

Stromweld Oct 3, 2024

ashiqueps Oct 9, 2024

jaymzh left a comment

sonarcloud bot commented Oct 16, 2024

ashiqueps commented Oct 16, 2024

ashiqueps commented Oct 24, 2024

	bash $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>
	sh $tmp_dir/install.sh -P <%= @config[:bootstrap_product] %> -c <%= @config[:channel] %> -v <%= version_to_install %>

Knife license comands and bootstrap updates #14559

Knife license comands and bootstrap updates #14559

Conversation

ashiqueps commented Aug 13, 2024

Description

Related Issue

Types of changes

Checklist:

tpowell-progress commented Sep 3, 2024

tpowell-progress left a comment

Choose a reason for hiding this comment

tpowell-progress Sep 24, 2024

Choose a reason for hiding this comment

tpowell-progress Sep 24, 2024

Choose a reason for hiding this comment

ashiqueps Sep 26, 2024

Choose a reason for hiding this comment

tpowell-progress Oct 1, 2024

Choose a reason for hiding this comment

tpowell-progress Oct 1, 2024

Choose a reason for hiding this comment

tpowell-progress left a comment

Choose a reason for hiding this comment

ashiqueps commented Oct 3, 2024

Stromweld commented Oct 3, 2024

Stromweld Oct 3, 2024

Choose a reason for hiding this comment

ashiqueps Oct 9, 2024

Choose a reason for hiding this comment

jaymzh left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 16, 2024

Quality Gate passed

ashiqueps commented Oct 16, 2024

ashiqueps commented Oct 24, 2024